Merge branch 'master' into v0.10

This commit is contained in:
Steve Bazyl 2017-03-29 16:25:34 -07:00
commit c4d0ed5d3c
298 changed files with 167684 additions and 38084 deletions

View File

@ -2,18 +2,25 @@ language: ruby
rvm:
- 2.3.0
- 2.2
- 2.0.0
- 2.1
- 2.0.0
- jruby-9000
env:
- RAILS_VERSION="~>4.0.0"
- RAILS_VERSION="~>4.1.0"
- RAILS_VERSION="~>4.2.0"
global:
- JRUBY_OPTS='-X-C -J-Xmx1024m -J-XX:+UseConcMarkSweepGC'
matrix:
- RAILS_VERSION="~>4.0.0"
- RAILS_VERSION="~>4.1.0"
- RAILS_VERSION="~>4.2.0"
matrix:
exclude:
- rvm: 2.0.0
env: RAILS_VERSION="~>4.2.0"
script: "bundle exec rake spec:all"
before_install:
- sudo apt-get update
- sudo apt-get install idn
- gem update bundler
- sudo apt-get update
- sudo apt-get install idn
- gem update bundler
notifications:
email:
recipients:

View File

@ -1,17 +1,84 @@
# 0.10.0
# 0.11.0
* *Breaking Change* - Fix handling of large numbers during code generation. Previously the
uint64/int64 formats were passed through as strings. They are now coerced to/from Fixnum/Bignum types
* Remove Hurley as dependency. May cause inor breaking changes if directly accessing the underlying
* Remove Hurley as dependency. May cause minor breaking changes if directly accessing the underlying
client connection.
* Drop compatibility with Rails 3.x since that is no longer supported by the Rails community.
* Upgrade representable to 3.0
* Upgrade mime-types to 3.0
* Move Thor & ActiveSupport to development depenencies. Using the code gengerator
* Move Thor & ActiveSupport to development dependencies. Using the code gengerator
now requires using the Bundle file or install the gem with dev dependencies.
* Treat 429 status codes as rate limit errors
* Fix a potential download corruption if download interrupted and retried against a URL
that does not return partial content.
# 0.10.2
* Regenerate APIs
# 0.10.1
* Regenerate APIs
* Add `cloudkms:v1`
# 0.10.0
* Regenerate APIs
* Some exceptions are more descriptive for specific errors
* `representable` dependency bumped to `~> 3.0`
* Breaking change for `skip_undefined` option under `to_json`:
Should now pass `foo.to_json(user_options: { skip_undefined: true })`
instead of `foo.to_json(skip_undefined: true)`
* `retriable` dependency bumped to `>= 2.0, < 4.0`
# 0.9.28
* Fix file permissions issue
# 0.9.27
* Allow abnormal page token cases for paging methods
* Regenerate APIs
# 0.9.26
* Update gem to reflect changes in 0.9.25
# 0.9.25
* Regenerate APIs
* Add `cloudkms:v1beta1`
* Add `manufacturers:v1`
# 0.9.24
* Regenerate APIs
* Add `dfareporting:v2.7`
* Fix file permissions issue present in released gems for versions `0.9.21` through `0.9.23`
# 0.9.23
* Regenerate APIs
* Add `dns:v2beta1`
# 0.9.22
* Regenerate APIs
# 0.9.21
* Regenerate APIs
# 0.9.20
* Regenerate APIs
* Add Slides API
# 0.9.19
* Regenerate APIs
* Add Adexchangebuyer2 API
# 0.9.15
* Add datastore v1
* Regenerate APIs
# 0.9.14
* Fix error handling with downloads, no longer fails silently
* Prevent form-encoding query parameters for APIs that don't expect it
* Regenerate APIs
# 0.9.13
* Fix fetch_all to work correctly with the genomics API
* Add speech & language APIs, regenerate APIs
# 0.9.12
* Regenerated APIs

View File

@ -25,7 +25,7 @@ end
platforms :jruby do
group :development do
gem 'jruby-openssl'
gem 'jruby-openssl'
end
end

View File

@ -15,7 +15,7 @@ migrate to the latest version.
Add this line to your application's Gemfile:
```ruby
gem 'google-api-client', '~> 0.9'
gem 'google-api-client', '~> 0.10'
```
@ -53,6 +53,14 @@ metadata = drive.insert_file(metadata, upload_source: 'test.txt', content_type:
# Download a file
drive.get_file(metadata.id, download_dest: '/tmp/myfile.txt')
```
### Naming conventions vs JSON representation
Object properties in the ruby client use the standard ruby convention for naming -- snake_case. This differs from the underlying JSON representation which typically uses camelCase for properties. There are a few notable exceptions to this rule:
* For properties that are defined as hashes with user-defined keys, no translation is performed on the key.
* For embedded field masks in requests (for example, the Sheets API), specify the camelCase form when referencing fields.
Outside those exceptions, if a property is specified using camelCase in a request, it will be ignored during serialization and omitted from the request.
### Media
@ -306,7 +314,7 @@ A URL can also be specified:
## License
This library is licensed under Apache 2.0. Full license text is
available in [LICENSE.txt](LICENSE.txt).
available in [LICENSE](LICENSE).
## Contributing

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

View File

@ -0,0 +1,35 @@
# Copyright 2015 Google Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES 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/guides/client-access/
module Adexchangebuyer2V2beta1
VERSION = 'V2beta1'
REVISION = '20170324'
# Manage your Ad Exchange buyer account configuration
AUTH_ADEXCHANGE_BUYER = 'https://www.googleapis.com/auth/adexchange.buyer'
end
end
end

File diff suppressed because it is too large Load Diff

View File

@ -0,0 +1,526 @@
# Copyright 2015 Google Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES 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 WatchCreativeRequest
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 ListClientsResponse
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 SecurityContext
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 ListCreativesResponse
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 Image
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 VideoContent
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 AuctionContext
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 LocationContext
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 ClientUser
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 FilteringStats
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 RemoveDealAssociationRequest
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 Correction
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 AddDealAssociationRequest
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 Disapproval
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 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 WatchCreativeRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :topic, as: 'topic'
end
end
class AppContext
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :app_types, as: 'appTypes'
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 NativeContent
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :video_url, as: 'videoUrl'
property :logo, as: 'logo', class: Google::Apis::Adexchangebuyer2V2beta1::Image, decorator: Google::Apis::Adexchangebuyer2V2beta1::Image::Representation
property :click_link_url, as: 'clickLinkUrl'
property :price_display_text, as: 'priceDisplayText'
property :click_tracking_url, as: 'clickTrackingUrl'
property :image, as: 'image', class: Google::Apis::Adexchangebuyer2V2beta1::Image, decorator: Google::Apis::Adexchangebuyer2V2beta1::Image::Representation
property :advertiser_name, as: 'advertiserName'
property :store_url, as: 'storeUrl'
property :headline, as: 'headline'
property :app_icon, as: 'appIcon', class: Google::Apis::Adexchangebuyer2V2beta1::Image, decorator: Google::Apis::Adexchangebuyer2V2beta1::Image::Representation
property :call_to_action, as: 'callToAction'
property :body, as: 'body'
property :star_rating, as: 'starRating'
end
end
class SecurityContext
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :securities, as: 'securities'
end
end
class HtmlContent
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :width, as: 'width'
property :snippet, as: 'snippet'
property :height, as: 'height'
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 ServingContext
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :app_type, as: 'appType', class: Google::Apis::Adexchangebuyer2V2beta1::AppContext, decorator: Google::Apis::Adexchangebuyer2V2beta1::AppContext::Representation
property :security_type, as: 'securityType', class: Google::Apis::Adexchangebuyer2V2beta1::SecurityContext, decorator: Google::Apis::Adexchangebuyer2V2beta1::SecurityContext::Representation
property :platform, as: 'platform', class: Google::Apis::Adexchangebuyer2V2beta1::PlatformContext, decorator: Google::Apis::Adexchangebuyer2V2beta1::PlatformContext::Representation
property :location, as: 'location', class: Google::Apis::Adexchangebuyer2V2beta1::LocationContext, decorator: Google::Apis::Adexchangebuyer2V2beta1::LocationContext::Representation
property :auction_type, as: 'auctionType', class: Google::Apis::Adexchangebuyer2V2beta1::AuctionContext, decorator: Google::Apis::Adexchangebuyer2V2beta1::AuctionContext::Representation
property :all, as: 'all'
end
end
class Image
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :width, as: 'width'
property :url, as: 'url'
property :height, as: 'height'
end
end
class Reason
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :status, as: 'status'
property :count, as: 'count'
end
end
class VideoContent
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :video_url, as: 'videoUrl'
end
end
class ClientUserInvitation
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :email, as: 'email'
property :client_account_id, as: 'clientAccountId'
property :invitation_id, as: 'invitationId'
end
end
class AuctionContext
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :auction_types, as: 'auctionTypes'
end
end
class ListClientUserInvitationsResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :next_page_token, as: 'nextPageToken'
collection :invitations, as: 'invitations', class: Google::Apis::Adexchangebuyer2V2beta1::ClientUserInvitation, decorator: Google::Apis::Adexchangebuyer2V2beta1::ClientUserInvitation::Representation
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 LocationContext
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :geo_criteria_ids, as: 'geoCriteriaIds'
end
end
class PlatformContext
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :platforms, as: 'platforms'
end
end
class ClientUser
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :status, as: 'status'
property :user_id, as: 'userId'
property :email, as: 'email'
property :client_account_id, as: 'clientAccountId'
end
end
class CreativeDealAssociation
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :creative_id, as: 'creativeId'
property :deals_id, as: 'dealsId'
property :account_id, as: 'accountId'
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 Creative
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :open_auction_status, as: 'openAuctionStatus'
property :advertiser_name, as: 'advertiserName'
collection :detected_advertiser_ids, as: 'detectedAdvertiserIds'
collection :detected_domains, as: 'detectedDomains'
property :filtering_stats, as: 'filteringStats', class: Google::Apis::Adexchangebuyer2V2beta1::FilteringStats, decorator: Google::Apis::Adexchangebuyer2V2beta1::FilteringStats::Representation
collection :attributes, as: 'attributes'
property :api_update_time, as: 'apiUpdateTime'
collection :detected_languages, as: 'detectedLanguages'
property :creative_id, as: 'creativeId'
property :account_id, as: 'accountId'
property :native, as: 'native', class: Google::Apis::Adexchangebuyer2V2beta1::NativeContent, decorator: Google::Apis::Adexchangebuyer2V2beta1::NativeContent::Representation
collection :serving_restrictions, as: 'servingRestrictions', class: Google::Apis::Adexchangebuyer2V2beta1::ServingRestriction, decorator: Google::Apis::Adexchangebuyer2V2beta1::ServingRestriction::Representation
property :video, as: 'video', class: Google::Apis::Adexchangebuyer2V2beta1::VideoContent, decorator: Google::Apis::Adexchangebuyer2V2beta1::VideoContent::Representation
property :agency_id, as: 'agencyId'
collection :click_through_urls, as: 'clickThroughUrls'
property :ad_choices_destination_url, as: 'adChoicesDestinationUrl'
collection :detected_sensitive_categories, as: 'detectedSensitiveCategories'
collection :restricted_categories, as: 'restrictedCategories'
collection :corrections, as: 'corrections', class: Google::Apis::Adexchangebuyer2V2beta1::Correction, decorator: Google::Apis::Adexchangebuyer2V2beta1::Correction::Representation
property :version, as: 'version'
collection :vendor_ids, as: 'vendorIds'
collection :impression_tracking_urls, as: 'impressionTrackingUrls'
property :html, as: 'html', class: Google::Apis::Adexchangebuyer2V2beta1::HtmlContent, decorator: Google::Apis::Adexchangebuyer2V2beta1::HtmlContent::Representation
property :deals_status, as: 'dealsStatus'
collection :detected_product_categories, as: 'detectedProductCategories'
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 Client
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :entity_name, as: 'entityName'
property :status, as: 'status'
property :entity_type, as: 'entityType'
property :client_name, as: 'clientName'
property :role, as: 'role'
property :visible_to_seller, as: 'visibleToSeller'
property :entity_id, as: 'entityId'
property :client_account_id, as: 'clientAccountId'
end
end
class Correction
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :details, as: 'details'
property :type, as: 'type'
collection :contexts, as: 'contexts', class: Google::Apis::Adexchangebuyer2V2beta1::ServingContext, decorator: Google::Apis::Adexchangebuyer2V2beta1::ServingContext::Representation
end
end
class ListDealAssociationsResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :next_page_token, as: 'nextPageToken'
collection :associations, as: 'associations', class: Google::Apis::Adexchangebuyer2V2beta1::CreativeDealAssociation, decorator: Google::Apis::Adexchangebuyer2V2beta1::CreativeDealAssociation::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 StopWatchingCreativeRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation
end
end
class Disapproval
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :details, as: 'details'
property :reason, as: 'reason'
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
property :status, as: 'status'
collection :disapproval_reasons, as: 'disapprovalReasons', class: Google::Apis::Adexchangebuyer2V2beta1::Disapproval, decorator: Google::Apis::Adexchangebuyer2V2beta1::Disapproval::Representation
end
end
class Date
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :year, as: 'year'
property :day, as: 'day'
property :month, as: 'month'
end
end
class Empty
# @private
class Representation < Google::Apis::Core::JsonRepresentation
end
end
end
end
end

View File

@ -0,0 +1,844 @@
# Copyright 2015 Google Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES 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/guides/client-access/
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/', '')
end
# Gets a client buyer with a given client account ID.
# @param [String] 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 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 [String] account_id
# Unique numerical account ID of the sponsor buyer to list the clients for.
# @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 [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] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should 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_token: nil, page_size: 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['pageToken'] = page_token unless page_token.nil?
command.query['pageSize'] = page_size unless page_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
# Updates an existing client buyer.
# @param [String] 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 [String] 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 a new client buyer.
# @param [String] 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
# Creates and sends out an email invitation to access
# an Ad Exchange client buyer account.
# @param [String] account_id
# Numerical account ID of the client's sponsor buyer. (required)
# @param [String] 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 [String] account_id
# Numerical account ID of the client's sponsor buyer. (required)
# @param [String] client_account_id
# Numerical account ID of the client buyer that the user invitation
# to be retrieved is associated with. (required)
# @param [String] 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 [String] 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 [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 [Fixnum] page_size
# Requested page size. Server may return fewer clients than requested.
# If unspecified, server will pick an appropriate 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.
# @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_token: nil, page_size: 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['pageToken'] = page_token unless page_token.nil?
command.query['pageSize'] = page_size unless page_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
# Updates an existing client user.
# Only the user status can be changed on update.
# @param [String] account_id
# Numerical account ID of the client's sponsor buyer. (required)
# @param [String] client_account_id
# Numerical account ID of the client buyer that the user to be retrieved
# is associated with. (required)
# @param [String] 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
# Lists all the known client users for a specified
# sponsor buyer account ID.
# @param [String] 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 [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 [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] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should 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_token: nil, page_size: 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['pageToken'] = page_token unless page_token.nil?
command.query['pageSize'] = page_size unless page_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
# Retrieves an existing client user.
# @param [String] account_id
# Numerical account ID of the client's sponsor buyer. (required)
# @param [String] client_account_id
# Numerical account ID of the client buyer
# that the user to be retrieved is associated with. (required)
# @param [String] 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
# 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] 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, 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['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
# 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
# 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
# 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
# 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] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should 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, 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['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 [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 [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] query
# An optional query string to filter creatives. If no filter is specified,
# all active creatives will be returned.
# Supported queries are:
# <ul>
# <li>accountId=<i>account_id_string</i>
# <li>creativeId=<i>creative_id_string</i>
# <li>dealsStatus: `approved, conditionally_approved, disapproved,
# not_checked`
# <li>openAuctionStatus: `approved, conditionally_approved, disapproved,
# not_checked`
# <li>attribute: `a numeric attribute from the list of attributes`
# <li>disapprovalReason: `a reason from DisapprovalReason
# </ul>
# 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_token: nil, page_size: 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['pageToken'] = page_token unless page_token.nil?
command.query['pageSize'] = page_size unless page_size.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
# 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 [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 [Fixnum] page_size
# Requested page size. Server may return fewer associations than requested.
# If unspecified, server will pick an appropriate default.
# @param [String] query
# An optional query string to filter deal associations. If no filter is
# specified, all associations will be returned.
# Supported queries are:
# <ul>
# <li>accountId=<i>account_id_string</i>
# <li>creativeId=<i>creative_id_string</i>
# <li>dealsId=<i>deals_id_string</i>
# <li>dealsStatus:`approved, conditionally_approved, disapproved,
# not_checked`
# <li>openAuctionStatus:`approved, conditionally_approved, disapproved,
# not_checked`
# </ul>
# 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_token: nil, page_size: 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['pageToken'] = page_token unless page_token.nil?
command.query['pageSize'] = page_size unless page_size.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
# 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
# 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
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

View File

@ -26,7 +26,7 @@ module Google
# @see https://developers.google.com/ad-exchange/buyer-rest
module AdexchangebuyerV1_4
VERSION = 'V1_4'
REVISION = '20160721'
REVISION = '20170215'
# Manage your Ad Exchange buyer account configuration
AUTH_ADEXCHANGE_BUYER = 'https://www.googleapis.com/auth/adexchange.buyer'

View File

@ -91,14 +91,15 @@ module Google
class BidderLocation
include Google::Apis::Core::Hashable
# The protocol that the bidder endpoint is using. By default, OpenRTB protocols
# use JSON, except PROTOCOL_OPENRTB_PROTOBUF. PROTOCOL_OPENRTB_PROTOBUF uses
# protobuf encoding over the latest OpenRTB protocol version, which is 2.3 right
# now. Allowed values:
# The protocol that the bidder endpoint is using. OpenRTB protocols with prefix
# PROTOCOL_OPENRTB_PROTOBUF use proto buffer, otherwise use JSON. Allowed
# values:
# - PROTOCOL_ADX
# - PROTOCOL_OPENRTB_2_2
# - PROTOCOL_OPENRTB_2_3
# - PROTOCOL_OPENRTB_PROTOBUF
# - PROTOCOL_OPENRTB_2_4
# - PROTOCOL_OPENRTB_PROTOBUF_2_3
# - PROTOCOL_OPENRTB_PROTOBUF_2_4
# Corresponds to the JSON property `bidProtocol`
# @return [String]
attr_accessor :bid_protocol
@ -488,7 +489,8 @@ module Google
# @return [Array<String>]
attr_accessor :advertiser_id
# The name of the company being advertised in the creative.
# The name of the company being advertised in the creative. The value provided
# must exist in the advertisers.txt file.
# Corresponds to the JSON property `advertiserName`
# @return [String]
attr_accessor :advertiser_name
@ -505,7 +507,9 @@ module Google
# @return [DateTime]
attr_accessor :api_upload_timestamp
# All attributes for the ads that may be shown from this snippet.
# List of buyer selectable attributes for the ads that may be shown from this
# snippet. Each attribute is represented by an integer as defined in buyer-
# declarable-creative-attributes.txt.
# Corresponds to the JSON property `attribute`
# @return [Array<Fixnum>]
attr_accessor :attribute
@ -568,7 +572,8 @@ module Google
# @return [Array<String>]
attr_accessor :languages
# If nativeAd is set, HTMLSnippet and videoURL should not be set.
# If nativeAd is set, HTMLSnippet and the videoURL outside of nativeAd should
# not be set. (The videoURL inside nativeAd can be set.)
# Corresponds to the JSON property `nativeAd`
# @return [Google::Apis::AdexchangebuyerV1_4::Creative::NativeAd]
attr_accessor :native_ad
@ -582,19 +587,23 @@ module Google
# @return [String]
attr_accessor :open_auction_status
# Detected product categories, if any. Read-only. This field should not be set
# in requests.
# Detected product categories, if any. Each category is represented by an
# integer as defined in ad-product-categories.txt. Read-only. This field should
# not be set in requests.
# Corresponds to the JSON property `productCategories`
# @return [Array<Fixnum>]
attr_accessor :product_categories
# All restricted categories for the ads that may be shown from this snippet.
# Each category is represented by an integer as defined in the ad-restricted-
# categories.txt.
# Corresponds to the JSON property `restrictedCategories`
# @return [Array<Fixnum>]
attr_accessor :restricted_categories
# Detected sensitive categories, if any. Read-only. This field should not be set
# in requests.
# Detected sensitive categories, if any. Each category is represented by an
# integer as defined in ad-sensitive-categories.txt. Read-only. This field
# should not be set in requests.
# Corresponds to the JSON property `sensitiveCategories`
# @return [Array<Fixnum>]
attr_accessor :sensitive_categories
@ -607,7 +616,8 @@ module Google
# @return [Array<Google::Apis::AdexchangebuyerV1_4::Creative::ServingRestriction>]
attr_accessor :serving_restrictions
# All vendor types for the ads that may be shown from this snippet.
# List of vendor types for the ads that may be shown from this snippet. Each
# vendor type is represented by an integer as defined in vendors.txt.
# Corresponds to the JSON property `vendorType`
# @return [Array<Fixnum>]
attr_accessor :vendor_type
@ -618,7 +628,8 @@ module Google
# @return [Fixnum]
attr_accessor :version
# The url to fetch a video ad. If set, HTMLSnippet should not be set.
# The URL to fetch a video ad. If set, HTMLSnippet and the nativeAd should not
# be set. Note, this is different from resource.native_ad.video_url above.
# Corresponds to the JSON property `videoURL`
# @return [String]
attr_accessor :video_url
@ -771,8 +782,7 @@ module Google
# @return [String]
attr_accessor :filtering_count
# The filtering status code. Please refer to the creative-status-codes.txt file
# for different statuses.
# The filtering status code as defined in creative-status-codes.txt.
# Corresponds to the JSON property `filteringStatus`
# @return [Fixnum]
attr_accessor :filtering_status
@ -789,7 +799,8 @@ module Google
end
end
# If nativeAd is set, HTMLSnippet and videoURL should not be set.
# If nativeAd is set, HTMLSnippet and the videoURL outside of nativeAd should
# not be set. (The videoURL inside nativeAd can be set.)
class NativeAd
include Google::Apis::Core::Hashable
@ -813,6 +824,11 @@ module Google
# @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]
@ -853,6 +869,12 @@ module Google
# @return [String]
attr_accessor :store
# The URL of the XML VAST for a native ad. Note this is a separate field from
# resource.video_url.
# Corresponds to the JSON property `videoURL`
# @return [String]
attr_accessor :video_url
def initialize(**args)
update!(**args)
end
@ -863,6 +885,7 @@ module Google
@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)
@ -871,6 +894,7 @@ module Google
@price = args[:price] if args.key?(:price)
@star_rating = args[:star_rating] if args.key?(:star_rating)
@store = args[:store] if args.key?(:store)
@video_url = args[:video_url] if args.key?(:video_url)
end
# The app icon, for app download ads.
@ -1018,7 +1042,8 @@ module Google
attr_accessor :context_type
# Only set when contextType=LOCATION. Represents the geo criterias this
# restriction applies to.
# restriction applies to. Impressions are considered to match a context if
# either the user location or publisher location matches a given geoCriteriaId.
# Corresponds to the JSON property `geoCriteriaId`
# @return [Array<Fixnum>]
attr_accessor :geo_criteria_id
@ -1069,6 +1094,62 @@ module Google
end
end
# The external deal ids associated with a creative.
class CreativeDealIds
include Google::Apis::Core::Hashable
# A list of external deal ids and ARC approval status.
# Corresponds to the JSON property `dealStatuses`
# @return [Array<Google::Apis::AdexchangebuyerV1_4::CreativeDealIds::DealStatus>]
attr_accessor :deal_statuses
# Resource type.
# 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)
@deal_statuses = args[:deal_statuses] if args.key?(:deal_statuses)
@kind = args[:kind] if args.key?(:kind)
end
#
class DealStatus
include Google::Apis::Core::Hashable
# ARC approval status.
# Corresponds to the JSON property `arcStatus`
# @return [String]
attr_accessor :arc_status
# External deal ID.
# Corresponds to the JSON property `dealId`
# @return [String]
attr_accessor :deal_id
# Publisher ID.
# Corresponds to the JSON property `webPropertyId`
# @return [Fixnum]
attr_accessor :web_property_id
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@arc_status = args[:arc_status] if args.key?(:arc_status)
@deal_id = args[:deal_id] if args.key?(:deal_id)
@web_property_id = args[:web_property_id] if args.key?(:web_property_id)
end
end
end
# The creatives feed lists the active creatives for the Ad Exchange buyer
# accounts that the user has access to. Each entry in the feed corresponds to a
# single creative.
@ -1107,6 +1188,14 @@ module Google
class DealServingMetadata
include Google::Apis::Core::Hashable
# True if alcohol ads are allowed for this deal (read-only). This field is only
# populated when querying for finalized orders using the method
# GetFinalizedOrderDeals
# Corresponds to the JSON property `alcoholAdsAllowed`
# @return [Boolean]
attr_accessor :alcohol_ads_allowed
alias_method :alcohol_ads_allowed?, :alcohol_ads_allowed
# Tracks which parties (if any) have paused a deal. The deal is considered
# paused if has_buyer_paused || has_seller_paused. Each of the has_buyer_paused
# or the has_seller_paused bits can be set independently.
@ -1120,6 +1209,7 @@ module Google
# Update properties of this object
def update!(**args)
@alcohol_ads_allowed = args[:alcohol_ads_allowed] if args.key?(:alcohol_ads_allowed)
@deal_pause_status = args[:deal_pause_status] if args.key?(:deal_pause_status)
end
end
@ -1180,6 +1270,13 @@ module Google
# @return [String]
attr_accessor :branding_type
# Indicates that this ExternalDealId exists under at least two different
# AdxInventoryDeals. Currently, the only case that the same ExternalDealId will
# exist is programmatic cross sell case.
# Corresponds to the JSON property `crossListedExternalDealIdType`
# @return [String]
attr_accessor :cross_listed_external_deal_id_type
# Description for the proposed terms of the deal.
# Corresponds to the JSON property `description`
# @return [String]
@ -1230,6 +1327,7 @@ module Google
# Update properties of this object
def update!(**args)
@branding_type = args[:branding_type] if args.key?(:branding_type)
@cross_listed_external_deal_id_type = args[:cross_listed_external_deal_id_type] if args.key?(:cross_listed_external_deal_id_type)
@description = args[:description] if args.key?(:description)
@estimated_gross_spend = args[:estimated_gross_spend] if args.key?(:estimated_gross_spend)
@estimated_impressions_per_day = args[:estimated_impressions_per_day] if args.key?(:estimated_impressions_per_day)
@ -1820,11 +1918,18 @@ module Google
# @return [String]
attr_accessor :flight_start_time_ms
# Description for the deal terms. (updatable)
# Description for the deal terms. (buyer-readonly)
# Corresponds to the JSON property `inventoryDescription`
# @return [String]
attr_accessor :inventory_description
# Indicates whether the current deal is a RFP template. RFP template is created
# by buyer and not based on seller created products.
# Corresponds to the JSON property `isRfpTemplate`
# @return [Boolean]
attr_accessor :is_rfp_template
alias_method :is_rfp_template?, :is_rfp_template
# Identifies what kind of resource this is. Value: the fixed string "
# adexchangebuyer#marketplaceDeal".
# Corresponds to the JSON property `kind`
@ -1907,6 +2012,7 @@ module Google
@flight_end_time_ms = args[:flight_end_time_ms] if args.key?(:flight_end_time_ms)
@flight_start_time_ms = args[:flight_start_time_ms] if args.key?(:flight_start_time_ms)
@inventory_description = args[:inventory_description] if args.key?(:inventory_description)
@is_rfp_template = args[:is_rfp_template] if args.key?(:is_rfp_template)
@kind = args[:kind] if args.key?(:kind)
@last_update_time_ms = args[:last_update_time_ms] if args.key?(:last_update_time_ms)
@name = args[:name] if args.key?(:name)
@ -2309,6 +2415,14 @@ module Google
# @return [Array<String>]
attr_accessor :languages
# Requests where the predicted viewability is below the specified decile will
# not match. E.g. if the buyer sets this value to 5, requests from slots where
# the predicted viewability is below 50% will not match. If the predicted
# viewability is unknown this field will be ignored.
# Corresponds to the JSON property `minimumViewabilityDecile`
# @return [Fixnum]
attr_accessor :minimum_viewability_decile
# Requests containing any of these mobile carrier ids will match. Values are
# from mobile-carriers.csv in the downloadable files section.
# Corresponds to the JSON property `mobileCarriers`
@ -2346,6 +2460,14 @@ module Google
# @return [Array<String>]
attr_accessor :supported_creative_attributes
# Requests containing the specified type of user data will match. Possible
# values are HOSTED_MATCH_DATA, which means the request is cookie-targetable and
# has a match in the buyer's hosted match table, and COOKIE_OR_IDFA, which means
# the request has either a targetable cookie or an iOS IDFA.
# Corresponds to the JSON property `userIdentifierDataRequired`
# @return [Array<String>]
attr_accessor :user_identifier_data_required
# Requests containing any of these user list ids will match.
# Corresponds to the JSON property `userLists`
# @return [Array<String>]
@ -2387,12 +2509,14 @@ module Google
@is_active = args[:is_active] if args.key?(:is_active)
@kind = args[:kind] if args.key?(:kind)
@languages = args[:languages] if args.key?(:languages)
@minimum_viewability_decile = args[:minimum_viewability_decile] if args.key?(:minimum_viewability_decile)
@mobile_carriers = args[:mobile_carriers] if args.key?(:mobile_carriers)
@mobile_devices = args[:mobile_devices] if args.key?(:mobile_devices)
@mobile_operating_system_versions = args[:mobile_operating_system_versions] if args.key?(:mobile_operating_system_versions)
@placements = args[:placements] if args.key?(:placements)
@platforms = args[:platforms] if args.key?(:platforms)
@supported_creative_attributes = args[:supported_creative_attributes] if args.key?(:supported_creative_attributes)
@user_identifier_data_required = args[:user_identifier_data_required] if args.key?(:user_identifier_data_required)
@user_lists = args[:user_lists] if args.key?(:user_lists)
@vendor_types = args[:vendor_types] if args.key?(:vendor_types)
@verticals = args[:verticals] if args.key?(:verticals)
@ -2711,6 +2835,14 @@ module Google
# @return [String]
attr_accessor :legacy_offer_id
# Marketplace publisher profile Id. This Id differs from the regular
# publisher_profile_id in that 1. This is a new id, the old Id will be
# deprecated in 2017. 2. This id uniquely identifies a publisher profile by
# itself.
# Corresponds to the JSON property `marketplacePublisherProfileId`
# @return [String]
attr_accessor :marketplace_publisher_profile_id
# The name for this product as set by the seller. (buyer-readonly)
# Corresponds to the JSON property `name`
# @return [String]
@ -2795,6 +2927,7 @@ module Google
@labels = args[:labels] if args.key?(:labels)
@last_update_time_ms = args[:last_update_time_ms] if args.key?(:last_update_time_ms)
@legacy_offer_id = args[:legacy_offer_id] if args.key?(:legacy_offer_id)
@marketplace_publisher_profile_id = args[:marketplace_publisher_profile_id] if args.key?(:marketplace_publisher_profile_id)
@name = args[:name] if args.key?(:name)
@private_auction_id = args[:private_auction_id] if args.key?(:private_auction_id)
@product_id = args[:product_id] if args.key?(:product_id)
@ -2840,6 +2973,11 @@ module Google
# @return [Google::Apis::AdexchangebuyerV1_4::PrivateData]
attr_accessor :buyer_private_data
# IDs of DBM advertisers permission to this proposal.
# Corresponds to the JSON property `dbmAdvertiserIds`
# @return [Array<String>]
attr_accessor :dbm_advertiser_ids
# When an proposal is in an accepted state, indicates whether the buyer has
# signed off. Once both sides have signed off on a deal, the proposal can be
# finalized by the seller. (seller-readonly)
@ -2951,6 +3089,7 @@ module Google
@buyer = args[:buyer] if args.key?(:buyer)
@buyer_contacts = args[:buyer_contacts] if args.key?(:buyer_contacts)
@buyer_private_data = args[:buyer_private_data] if args.key?(:buyer_private_data)
@dbm_advertiser_ids = args[:dbm_advertiser_ids] if args.key?(:dbm_advertiser_ids)
@has_buyer_signed_off = args[:has_buyer_signed_off] if args.key?(:has_buyer_signed_off)
@has_seller_signed_off = args[:has_seller_signed_off] if args.key?(:has_seller_signed_off)
@inventory_source = args[:inventory_source] if args.key?(:inventory_source)

View File

@ -178,6 +178,18 @@ module Google
include Google::Apis::Core::JsonObjectSupport
end
class CreativeDealIds
class Representation < Google::Apis::Core::JsonRepresentation; end
class DealStatus
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
include Google::Apis::Core::JsonObjectSupport
end
class CreativesList
class Representation < Google::Apis::Core::JsonRepresentation; end
@ -687,6 +699,7 @@ module Google
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::AdexchangebuyerV1_4::Creative::NativeAd::Image, decorator: Google::Apis::AdexchangebuyerV1_4::Creative::NativeAd::Image::Representation
@ -697,6 +710,7 @@ module Google
property :price, as: 'price'
property :star_rating, as: 'starRating'
property :store, as: 'store'
property :video_url, as: 'videoURL'
end
class AppIcon
@ -757,6 +771,24 @@ module Google
end
end
class CreativeDealIds
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :deal_statuses, as: 'dealStatuses', class: Google::Apis::AdexchangebuyerV1_4::CreativeDealIds::DealStatus, decorator: Google::Apis::AdexchangebuyerV1_4::CreativeDealIds::DealStatus::Representation
property :kind, as: 'kind'
end
class DealStatus
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :arc_status, as: 'arcStatus'
property :deal_id, as: 'dealId'
property :web_property_id, as: 'webPropertyId'
end
end
end
class CreativesList
# @private
class Representation < Google::Apis::Core::JsonRepresentation
@ -770,6 +802,7 @@ module Google
class DealServingMetadata
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :alcohol_ads_allowed, as: 'alcoholAdsAllowed'
property :deal_pause_status, as: 'dealPauseStatus', class: Google::Apis::AdexchangebuyerV1_4::DealServingMetadataDealPauseStatus, decorator: Google::Apis::AdexchangebuyerV1_4::DealServingMetadataDealPauseStatus::Representation
end
@ -790,6 +823,7 @@ module Google
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :branding_type, as: 'brandingType'
property :cross_listed_external_deal_id_type, as: 'crossListedExternalDealIdType'
property :description, as: 'description'
property :estimated_gross_spend, as: 'estimatedGrossSpend', class: Google::Apis::AdexchangebuyerV1_4::Price, decorator: Google::Apis::AdexchangebuyerV1_4::Price::Representation
@ -990,6 +1024,7 @@ module Google
property :flight_end_time_ms, as: 'flightEndTimeMs'
property :flight_start_time_ms, as: 'flightStartTimeMs'
property :inventory_description, as: 'inventoryDescription'
property :is_rfp_template, as: 'isRfpTemplate'
property :kind, as: 'kind'
property :last_update_time_ms, as: 'lastUpdateTimeMs'
property :name, as: 'name'
@ -1099,6 +1134,7 @@ module Google
property :is_active, as: 'isActive'
property :kind, as: 'kind'
collection :languages, as: 'languages'
property :minimum_viewability_decile, as: 'minimumViewabilityDecile'
collection :mobile_carriers, as: 'mobileCarriers'
collection :mobile_devices, as: 'mobileDevices'
collection :mobile_operating_system_versions, as: 'mobileOperatingSystemVersions'
@ -1106,6 +1142,7 @@ module Google
collection :platforms, as: 'platforms'
collection :supported_creative_attributes, as: 'supportedCreativeAttributes'
collection :user_identifier_data_required, as: 'userIdentifierDataRequired'
collection :user_lists, as: 'userLists'
collection :vendor_types, as: 'vendorTypes'
collection :verticals, as: 'verticals'
@ -1202,6 +1239,7 @@ module Google
property :last_update_time_ms, as: 'lastUpdateTimeMs'
property :legacy_offer_id, as: 'legacyOfferId'
property :marketplace_publisher_profile_id, as: 'marketplacePublisherProfileId'
property :name, as: 'name'
property :private_auction_id, as: 'privateAuctionId'
property :product_id, as: 'productId'
@ -1232,6 +1270,7 @@ module Google
property :buyer_private_data, as: 'buyerPrivateData', class: Google::Apis::AdexchangebuyerV1_4::PrivateData, decorator: Google::Apis::AdexchangebuyerV1_4::PrivateData::Representation
collection :dbm_advertiser_ids, as: 'dbmAdvertiserIds'
property :has_buyer_signed_off, as: 'hasBuyerSignedOff'
property :has_seller_signed_off, as: 'hasSellerSignedOff'
property :inventory_source, as: 'inventorySource'

View File

@ -124,6 +124,8 @@ module Google
# @param [Fixnum] id
# The account id
# @param [Google::Apis::AdexchangebuyerV1_4::Account] account_object
# @param [Boolean] confirm_unsafe_account_change
# Confirmation for erasing bidder and cookie matching urls.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@ -145,13 +147,14 @@ module Google
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def patch_account(id, account_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
def patch_account(id, account_object = nil, confirm_unsafe_account_change: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:patch, 'accounts/{id}', options)
command.request_representation = Google::Apis::AdexchangebuyerV1_4::Account::Representation
command.request_object = account_object
command.response_representation = Google::Apis::AdexchangebuyerV1_4::Account::Representation
command.response_class = Google::Apis::AdexchangebuyerV1_4::Account
command.params['id'] = id unless id.nil?
command.query['confirmUnsafeAccountChange'] = confirm_unsafe_account_change unless confirm_unsafe_account_change.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['userIp'] = user_ip unless user_ip.nil?
@ -162,6 +165,8 @@ module Google
# @param [Fixnum] id
# The account id
# @param [Google::Apis::AdexchangebuyerV1_4::Account] account_object
# @param [Boolean] confirm_unsafe_account_change
# Confirmation for erasing bidder and cookie matching urls.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@ -183,13 +188,14 @@ module Google
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def update_account(id, account_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
def update_account(id, account_object = nil, confirm_unsafe_account_change: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:put, 'accounts/{id}', options)
command.request_representation = Google::Apis::AdexchangebuyerV1_4::Account::Representation
command.request_object = account_object
command.response_representation = Google::Apis::AdexchangebuyerV1_4::Account::Representation
command.response_class = Google::Apis::AdexchangebuyerV1_4::Account
command.params['id'] = id unless id.nil?
command.query['confirmUnsafeAccountChange'] = confirm_unsafe_account_change unless confirm_unsafe_account_change.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['userIp'] = user_ip unless user_ip.nil?
@ -556,6 +562,44 @@ module Google
execute_or_queue_command(command, &block)
end
# Lists the external deal ids associated with the creative.
# @param [Fixnum] account_id
# The id for the account that will serve this creative.
# @param [String] buyer_creative_id
# The buyer-specific id for this 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.
# Overrides userIp if both are provided.
# @param [String] user_ip
# IP address of the site where the request originates. Use this if you want to
# enforce per-user limits.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::AdexchangebuyerV1_4::CreativeDealIds] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::AdexchangebuyerV1_4::CreativeDealIds]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @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_deals(account_id, buyer_creative_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:get, 'creatives/{accountId}/{buyerCreativeId}/listDeals', options)
command.response_representation = Google::Apis::AdexchangebuyerV1_4::CreativeDealIds::Representation
command.response_class = Google::Apis::AdexchangebuyerV1_4::CreativeDealIds
command.params['accountId'] = account_id unless account_id.nil?
command.params['buyerCreativeId'] = buyer_creative_id unless buyer_creative_id.nil?
command.query['fields'] = fields unless fields.nil?
command.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 deal id associated with the creative.
# @param [Fixnum] account_id
# The id for the account that will serve this creative.
@ -1291,7 +1335,8 @@ module Google
# should then fetch the latest proposal at head revision and retry the update at
# that revision.
# @param [String] update_action
# The proposed action to take on the proposal.
# The proposed action to take on the proposal. This field is required and it
# must be set when updating a proposal.
# @param [Google::Apis::AdexchangebuyerV1_4::Proposal] proposal_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
@ -1406,7 +1451,8 @@ module Google
# should then fetch the latest proposal at head revision and retry the update at
# that revision.
# @param [String] update_action
# The proposed action to take on the proposal.
# The proposed action to take on the proposal. This field is required and it
# must be set when updating a proposal.
# @param [Google::Apis::AdexchangebuyerV1_4::Proposal] proposal_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.

View File

@ -26,7 +26,7 @@ module Google
# @see https://developers.google.com/admin-sdk/directory/
module AdminDirectoryV1
VERSION = 'DirectoryV1'
REVISION = '20160715'
REVISION = '20170216'
# View and manage customer related information
AUTH_ADMIN_DIRECTORY_CUSTOMER = 'https://www.googleapis.com/auth/admin.directory.customer'

View File

@ -574,6 +574,32 @@ module Google
end
end
# JSON request template for firing actions on ChromeOs Device in Directory
# Devices API.
class ChromeOsDeviceAction
include Google::Apis::Core::Hashable
# Action to be taken on the ChromeOs Device
# Corresponds to the JSON property `action`
# @return [String]
attr_accessor :action
#
# Corresponds to the JSON property `deprovisionReason`
# @return [String]
attr_accessor :deprovision_reason
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@action = args[:action] if args.key?(:action)
@deprovision_reason = args[:deprovision_reason] if args.key?(:deprovision_reason)
end
end
# JSON response template for List Chrome OS Devices operation in Directory API.
class ChromeOsDevices
include Google::Apis::Core::Hashable
@ -1147,6 +1173,16 @@ module Google
# @return [String]
attr_accessor :baseband_version
# Mobile Device Bootloader version (Read-only)
# Corresponds to the JSON property `bootloaderVersion`
# @return [String]
attr_accessor :bootloader_version
# Mobile Device Brand (Read-only)
# Corresponds to the JSON property `brand`
# @return [String]
attr_accessor :brand
# Mobile Device Build number (Read-only)
# Corresponds to the JSON property `buildNumber`
# @return [String]
@ -1173,11 +1209,21 @@ module Google
# @return [String]
attr_accessor :device_id
# DevicePasswordStatus (Read-only)
# Corresponds to the JSON property `devicePasswordStatus`
# @return [String]
attr_accessor :device_password_status
# List of owner user's email addresses (Read-only)
# Corresponds to the JSON property `email`
# @return [Array<String>]
attr_accessor :email
# Mobile Device Encryption Status (Read-only)
# Corresponds to the JSON property `encryptionStatus`
# @return [String]
attr_accessor :encryption_status
# ETag of the resource.
# Corresponds to the JSON property `etag`
# @return [String]
@ -1189,6 +1235,11 @@ module Google
# @return [DateTime]
attr_accessor :first_sync
# Mobile Device Hardware (Read-only)
# Corresponds to the JSON property `hardware`
# @return [String]
attr_accessor :hardware
# Mobile Device Hardware Id (Read-only)
# Corresponds to the JSON property `hardwareId`
# @return [String]
@ -1222,6 +1273,11 @@ module Google
attr_accessor :managed_account_is_on_owner_profile
alias_method :managed_account_is_on_owner_profile?, :managed_account_is_on_owner_profile
# Mobile Device manufacturer (Read-only)
# Corresponds to the JSON property `manufacturer`
# @return [String]
attr_accessor :manufacturer
# Mobile Device MEID number (Read-only)
# Corresponds to the JSON property `meid`
# @return [String]
@ -1252,11 +1308,26 @@ module Google
# @return [Array<String>]
attr_accessor :other_accounts_info
# DMAgentPermission (Read-only)
# Corresponds to the JSON property `privilege`
# @return [String]
attr_accessor :privilege
# Mobile Device release version version (Read-only)
# Corresponds to the JSON property `releaseVersion`
# @return [String]
attr_accessor :release_version
# Unique identifier of Mobile Device (Read-only)
# Corresponds to the JSON property `resourceId`
# @return [String]
attr_accessor :resource_id
# Mobile Device Security patch level (Read-only)
# Corresponds to the JSON property `securityPatchLevel`
# @return [String]
attr_accessor :security_patch_level
# Mobile Device SSN or Serial Number (Read-only)
# Corresponds to the JSON property `serialNumber`
# @return [String]
@ -1303,27 +1374,36 @@ module Google
@adb_status = args[:adb_status] if args.key?(:adb_status)
@applications = args[:applications] if args.key?(:applications)
@baseband_version = args[:baseband_version] if args.key?(:baseband_version)
@bootloader_version = args[:bootloader_version] if args.key?(:bootloader_version)
@brand = args[:brand] if args.key?(:brand)
@build_number = args[:build_number] if args.key?(:build_number)
@default_language = args[:default_language] if args.key?(:default_language)
@developer_options_status = args[:developer_options_status] if args.key?(:developer_options_status)
@device_compromised_status = args[:device_compromised_status] if args.key?(:device_compromised_status)
@device_id = args[:device_id] if args.key?(:device_id)
@device_password_status = args[:device_password_status] if args.key?(:device_password_status)
@email = args[:email] if args.key?(:email)
@encryption_status = args[:encryption_status] if args.key?(:encryption_status)
@etag = args[:etag] if args.key?(:etag)
@first_sync = args[:first_sync] if args.key?(:first_sync)
@hardware = args[:hardware] if args.key?(:hardware)
@hardware_id = args[:hardware_id] if args.key?(:hardware_id)
@imei = args[:imei] if args.key?(:imei)
@kernel_version = args[:kernel_version] if args.key?(:kernel_version)
@kind = args[:kind] if args.key?(:kind)
@last_sync = args[:last_sync] if args.key?(:last_sync)
@managed_account_is_on_owner_profile = args[:managed_account_is_on_owner_profile] if args.key?(:managed_account_is_on_owner_profile)
@manufacturer = args[:manufacturer] if args.key?(:manufacturer)
@meid = args[:meid] if args.key?(:meid)
@model = args[:model] if args.key?(:model)
@name = args[:name] if args.key?(:name)
@network_operator = args[:network_operator] if args.key?(:network_operator)
@os = args[:os] if args.key?(:os)
@other_accounts_info = args[:other_accounts_info] if args.key?(:other_accounts_info)
@privilege = args[:privilege] if args.key?(:privilege)
@release_version = args[:release_version] if args.key?(:release_version)
@resource_id = args[:resource_id] if args.key?(:resource_id)
@security_patch_level = args[:security_patch_level] if args.key?(:security_patch_level)
@serial_number = args[:serial_number] if args.key?(:serial_number)
@status = args[:status] if args.key?(:status)
@supports_work_profile = args[:supports_work_profile] if args.key?(:supports_work_profile)
@ -2320,6 +2400,18 @@ module Google
attr_accessor :is_delegated_admin
alias_method :is_delegated_admin?, :is_delegated_admin
# Is 2-step verification enforced (Read-only)
# Corresponds to the JSON property `isEnforcedIn2Sv`
# @return [Boolean]
attr_accessor :is_enforced_in2_sv
alias_method :is_enforced_in2_sv?, :is_enforced_in2_sv
# Is enrolled in 2-step verification (Read-only)
# Corresponds to the JSON property `isEnrolledIn2Sv`
# @return [Boolean]
attr_accessor :is_enrolled_in2_sv
alias_method :is_enrolled_in2_sv?, :is_enrolled_in2_sv
# Is mailbox setup (Read-only)
# Corresponds to the JSON property `isMailboxSetup`
# @return [Boolean]
@ -2371,6 +2463,11 @@ module Google
# @return [Object]
attr_accessor :phones
#
# Corresponds to the JSON property `posixAccounts`
# @return [Object]
attr_accessor :posix_accounts
# username of User
# Corresponds to the JSON property `primaryEmail`
# @return [String]
@ -2381,6 +2478,11 @@ module Google
# @return [Object]
attr_accessor :relations
#
# Corresponds to the JSON property `sshPublicKeys`
# @return [Object]
attr_accessor :ssh_public_keys
# Indicates if user is suspended
# Corresponds to the JSON property `suspended`
# @return [Boolean]
@ -2431,6 +2533,8 @@ module Google
@ip_whitelisted = args[:ip_whitelisted] if args.key?(:ip_whitelisted)
@is_admin = args[:is_admin] if args.key?(:is_admin)
@is_delegated_admin = args[:is_delegated_admin] if args.key?(:is_delegated_admin)
@is_enforced_in2_sv = args[:is_enforced_in2_sv] if args.key?(:is_enforced_in2_sv)
@is_enrolled_in2_sv = args[:is_enrolled_in2_sv] if args.key?(:is_enrolled_in2_sv)
@is_mailbox_setup = args[:is_mailbox_setup] if args.key?(:is_mailbox_setup)
@kind = args[:kind] if args.key?(:kind)
@last_login_time = args[:last_login_time] if args.key?(:last_login_time)
@ -2441,8 +2545,10 @@ module Google
@organizations = args[:organizations] if args.key?(:organizations)
@password = args[:password] if args.key?(:password)
@phones = args[:phones] if args.key?(:phones)
@posix_accounts = args[:posix_accounts] if args.key?(:posix_accounts)
@primary_email = args[:primary_email] if args.key?(:primary_email)
@relations = args[:relations] if args.key?(:relations)
@ssh_public_keys = args[:ssh_public_keys] if args.key?(:ssh_public_keys)
@suspended = args[:suspended] if args.key?(:suspended)
@suspension_reason = args[:suspension_reason] if args.key?(:suspension_reason)
@thumbnail_photo_etag = args[:thumbnail_photo_etag] if args.key?(:thumbnail_photo_etag)
@ -2939,6 +3045,69 @@ module Google
end
end
# JSON template for a POSIX account entry. Description of the field family: go/
# fbs-posix.
class UserPosixAccount
include Google::Apis::Core::Hashable
# 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
# If this is user's primary account within the SystemId.
# Corresponds to the JSON property `primary`
# @return [Boolean]
attr_accessor :primary
alias_method :primary?, :primary
# The path to the login shell for this account.
# Corresponds to the JSON property `shell`
# @return [String]
attr_accessor :shell
# System identifier for which account Username or Uid apply to.
# 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 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)
@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
# JSON template for a relation entry.
class UserRelation
include Google::Apis::Core::Hashable
@ -2971,6 +3140,37 @@ module Google
end
end
# JSON template for a POSIX account entry.
class UserSshPublicKey
include Google::Apis::Core::Hashable
# An expiration time in microseconds since epoch.
# Corresponds to the JSON property `expirationTimeUsec`
# @return [String]
attr_accessor :expiration_time_usec
# A SHA-256 fingerprint of the SSH public key. (Read-only)
# Corresponds to the JSON property `fingerprint`
# @return [String]
attr_accessor :fingerprint
# An SSH public key.
# 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
# JSON request template to undelete a user in Directory API.
class UserUndelete
include Google::Apis::Core::Hashable

View File

@ -82,6 +82,12 @@ module Google
include Google::Apis::Core::JsonObjectSupport
end
class ChromeOsDeviceAction
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class ChromeOsDevices
class Representation < Google::Apis::Core::JsonRepresentation; end
@ -340,12 +346,24 @@ module Google
include Google::Apis::Core::JsonObjectSupport
end
class UserPosixAccount
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class UserRelation
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class UserSshPublicKey
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class UserUndelete
class Representation < Google::Apis::Core::JsonRepresentation; end
@ -512,6 +530,14 @@ module Google
end
end
class ChromeOsDeviceAction
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :action, as: 'action'
property :deprovision_reason, as: 'deprovisionReason'
end
end
class ChromeOsDevices
# @private
class Representation < Google::Apis::Core::JsonRepresentation
@ -659,15 +685,20 @@ module Google
collection :applications, as: 'applications', class: Google::Apis::AdminDirectoryV1::MobileDevice::Application, decorator: Google::Apis::AdminDirectoryV1::MobileDevice::Application::Representation
property :baseband_version, as: 'basebandVersion'
property :bootloader_version, as: 'bootloaderVersion'
property :brand, as: 'brand'
property :build_number, as: 'buildNumber'
property :default_language, as: 'defaultLanguage'
property :developer_options_status, as: 'developerOptionsStatus'
property :device_compromised_status, as: 'deviceCompromisedStatus'
property :device_id, as: 'deviceId'
property :device_password_status, as: 'devicePasswordStatus'
collection :email, as: 'email'
property :encryption_status, as: 'encryptionStatus'
property :etag, as: 'etag'
property :first_sync, as: 'firstSync', type: DateTime
property :hardware, as: 'hardware'
property :hardware_id, as: 'hardwareId'
property :imei, as: 'imei'
property :kernel_version, as: 'kernelVersion'
@ -675,13 +706,17 @@ module Google
property :last_sync, as: 'lastSync', type: DateTime
property :managed_account_is_on_owner_profile, as: 'managedAccountIsOnOwnerProfile'
property :manufacturer, as: 'manufacturer'
property :meid, as: 'meid'
property :model, as: 'model'
collection :name, as: 'name'
property :network_operator, as: 'networkOperator'
property :os, as: 'os'
collection :other_accounts_info, as: 'otherAccountsInfo'
property :privilege, as: 'privilege'
property :release_version, as: 'releaseVersion'
property :resource_id, as: 'resourceId'
property :security_patch_level, as: 'securityPatchLevel'
property :serial_number, as: 'serialNumber'
property :status, as: 'status'
property :supports_work_profile, as: 'supportsWorkProfile'
@ -948,6 +983,8 @@ module Google
property :ip_whitelisted, as: 'ipWhitelisted'
property :is_admin, as: 'isAdmin'
property :is_delegated_admin, as: 'isDelegatedAdmin'
property :is_enforced_in2_sv, as: 'isEnforcedIn2Sv'
property :is_enrolled_in2_sv, as: 'isEnrolledIn2Sv'
property :is_mailbox_setup, as: 'isMailboxSetup'
property :kind, as: 'kind'
property :last_login_time, as: 'lastLoginTime', type: DateTime
@ -960,8 +997,10 @@ module Google
property :organizations, as: 'organizations'
property :password, as: 'password'
property :phones, as: 'phones'
property :posix_accounts, as: 'posixAccounts'
property :primary_email, as: 'primaryEmail'
property :relations, as: 'relations'
property :ssh_public_keys, as: 'sshPublicKeys'
property :suspended, as: 'suspended'
property :suspension_reason, as: 'suspensionReason'
property :thumbnail_photo_etag, as: 'thumbnailPhotoEtag'
@ -1085,6 +1124,20 @@ module Google
end
end
class UserPosixAccount
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :gecos, as: 'gecos'
property :gid, as: 'gid'
property :home_directory, as: 'homeDirectory'
property :primary, as: 'primary'
property :shell, as: 'shell'
property :system_id, as: 'systemId'
property :uid, as: 'uid'
property :username, as: 'username'
end
end
class UserRelation
# @private
class Representation < Google::Apis::Core::JsonRepresentation
@ -1094,6 +1147,15 @@ module Google
end
end
class UserSshPublicKey
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :expiration_time_usec, as: 'expirationTimeUsec'
property :fingerprint, as: 'fingerprint'
property :key, as: 'key'
end
end
class UserUndelete
# @private
class Representation < Google::Apis::Core::JsonRepresentation

View File

@ -198,6 +198,45 @@ module Google
execute_or_queue_command(command, &block)
end
# Take action on Chrome OS Device
# @param [String] customer_id
# Immutable id of the Google Apps account
# @param [String] resource_id
# Immutable id of Chrome OS Device
# @param [Google::Apis::AdminDirectoryV1::ChromeOsDeviceAction] chrome_os_device_action_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# Overrides userIp if both are provided.
# @param [String] user_ip
# IP address of the site where the request originates. Use this if you 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 action_chromeosdevice(customer_id, resource_id, chrome_os_device_action_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:post, 'customer/{customerId}/devices/chromeos/{resourceId}/action', options)
command.request_representation = Google::Apis::AdminDirectoryV1::ChromeOsDeviceAction::Representation
command.request_object = chrome_os_device_action_object
command.params['customerId'] = customer_id unless customer_id.nil?
command.params['resourceId'] = resource_id unless resource_id.nil?
command.query['fields'] = fields unless fields.nil?
command.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 Chrome OS Device
# @param [String] customer_id
# Immutable id of the Google Apps account

View File

@ -20,18 +20,18 @@ module Google
module Apis
# Admin Reports API
#
# Fetches reports for the administrators of Google Apps customers about the
# usage, collaboration, security, and risk for their users.
# 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 = '20160704'
REVISION = '20170315'
# View audit reports of Google Apps for your domain
# 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 of Google Apps for your domain
# View usage reports for your G Suite domain
AUTH_ADMIN_REPORTS_USAGE_READONLY = 'https://www.googleapis.com/auth/admin.reports.usage.readonly'
end
end

View File

@ -22,8 +22,8 @@ module Google
module AdminReportsV1
# Admin Reports API
#
# Fetches reports for the administrators of Google Apps customers about the
# usage, collaboration, security, and risk for their users.
# 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'
@ -66,7 +66,7 @@ module Google
# @param [String] customer_id
# Represents the customer for which the data is to be fetched.
# @param [String] end_time
# Return events which occured at or before this time.
# Return events which occurred at or before this time.
# @param [String] event_name
# Name of the event being queried.
# @param [String] filters
@ -77,7 +77,7 @@ module Google
# @param [String] page_token
# Token to specify next page.
# @param [String] start_time
# Return events which occured at or after this 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
@ -133,7 +133,7 @@ module Google
# @param [String] customer_id
# Represents the customer for which the data is to be fetched.
# @param [String] end_time
# Return events which occured at or before this time.
# Return events which occurred at or before this time.
# @param [String] event_name
# Name of the event being queried.
# @param [String] filters
@ -144,7 +144,7 @@ module Google
# @param [String] page_token
# Token to specify next page.
# @param [String] start_time
# Return events which occured at or after this 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

View File

@ -25,7 +25,7 @@ module Google
# @see https://developers.google.com/adsense/management/
module AdsenseV1_4
VERSION = 'V1_4'
REVISION = '20160815'
REVISION = '20170325'
# View and manage your AdSense data
AUTH_ADSENSE = 'https://www.googleapis.com/auth/adsense'

View File

@ -236,7 +236,7 @@ module Google
# @return [Google::Apis::AdsenseV1_4::AdStyle::Colors]
attr_accessor :colors
# The style of the corners in the ad.
# The style of the corners in the ad (deprecated: never populated, ignored).
# Corresponds to the JSON property `corners`
# @return [String]
attr_accessor :corners

View File

@ -26,7 +26,7 @@ module Google
# @see https://developers.google.com/adsense/host/
module AdsensehostV4_1
VERSION = 'V4_1'
REVISION = '20160815'
REVISION = '20170325'
# View and manage your AdSense host data and associated accounts
AUTH_ADSENSEHOST = 'https://www.googleapis.com/auth/adsensehost'

View File

@ -209,8 +209,7 @@ module Google
# @return [Google::Apis::AdsensehostV4_1::AdStyle::Colors]
attr_accessor :colors
# The style of the corners in the ad. Possible values are SQUARE,
# SLIGHTLY_ROUNDED and VERY_ROUNDED.
# The style of the corners in the ad (deprecated: never populated, ignored).
# Corresponds to the JSON property `corners`
# @return [String]
attr_accessor :corners

View File

@ -25,7 +25,7 @@ module Google
# @see https://developers.google.com/analytics/
module AnalyticsV3
VERSION = 'V3'
REVISION = '20160805'
REVISION = '20170321'
# View and manage your Google Analytics data
AUTH_ANALYTICS = 'https://www.googleapis.com/auth/analytics'

View File

@ -2413,6 +2413,11 @@ module Google
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 [String]
attr_accessor :data_last_refreshed
#
# Corresponds to the JSON property `dataTable`
# @return [Google::Apis::AnalyticsV3::GaData::DataTable]
@ -2498,6 +2503,7 @@ module Google
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)
@ -3212,9 +3218,7 @@ module Google
# @return [String]
attr_accessor :kind
# Number of days a user remains in the audience. Use any integer from 1-540. In
# remarketing audiences for search ads, membership duration is truncated to 180
# days.
# 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
@ -3666,8 +3670,10 @@ module Google
# The currency type associated with this view (profile), defaults to USD. The
# supported values are:
# ARS, AUD, BGN, BRL, CAD, CHF, CNY, CZK, DKK, EUR, GBP, HKD, HUF, IDR, INR, JPY,
# KRW, LTL, MXN, NOK, NZD, PHP, PLN, RUB, SEK, THB, TRY, TWD, USD, VND, ZAR
# 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

View File

@ -1201,6 +1201,7 @@ module Google
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, as: 'dataLastRefreshed'
property :data_table, as: 'dataTable', class: Google::Apis::AnalyticsV3::GaData::DataTable, decorator: Google::Apis::AnalyticsV3::GaData::DataTable::Representation
property :id, as: 'id'

View File

@ -2450,13 +2450,52 @@ module Google
execute_or_queue_command(command, &block)
end
# Gets remarketing audiences to which the user has access.
# Delete a remarketing audience.
# @param [String] account_id
# Account ID for the remarketing audience to retrieve.
# Account ID to which the remarketing audience belongs.
# @param [String] web_property_id
# Web property ID for the remarketing audience to retrieve.
# Web property ID to which the remarketing audience belongs.
# @param [String] remarketing_audience_id
# The ID to retrieve the Remarketing Audience for.
# 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
@ -2491,11 +2530,11 @@ module Google
execute_or_queue_command(command, &block)
end
# Creates a new remarketing audiences.
# Creates a new remarketing audience.
# @param [String] account_id
# Account ID to create the remarketing audience for.
# The account ID for which to create the remarketing audience.
# @param [String] web_property_id
# Web property ID to create the remarketing audience for.
# 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.
@ -2534,9 +2573,9 @@ module Google
# Lists remarketing audiences to which the user has access.
# @param [String] account_id
# Account ID for the remarketing audience to retrieve.
# The account ID of the remarketing audiences to retrieve.
# @param [String] web_property_id
# Web property ID for the remarketing audience to retrieve.
# 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
@ -2579,14 +2618,13 @@ module Google
execute_or_queue_command(command, &block)
end
# Updates an existing remarketing audiences. This method supports patch
# semantics.
# Updates an existing remarketing audience. This method supports patch semantics.
# @param [String] account_id
# Account ID for the remarketing audience to update.
# The account ID of the remarketing audience to update.
# @param [String] web_property_id
# Web property ID for the remarketing audience to update.
# The web property ID of the remarketing audience to update.
# @param [String] remarketing_audience_id
# Remarketing audience ID of the remarketing audience to update.
# 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.
@ -2624,13 +2662,13 @@ module Google
execute_or_queue_command(command, &block)
end
# Updates an existing remarketing audiences.
# Updates an existing remarketing audience.
# @param [String] account_id
# Account ID for the remarketing audience to update.
# The account ID of the remarketing audience to update.
# @param [String] web_property_id
# Web property ID for the remarketing audience to update.
# The web property ID of the remarketing audience to update.
# @param [String] remarketing_audience_id
# Remarketing audience ID of the remarketing audience to update.
# 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.

View File

@ -25,7 +25,7 @@ module Google
# @see https://developers.google.com/analytics/devguides/reporting/core/v4/
module AnalyticsreportingV4
VERSION = 'V4'
REVISION = '20160809'
REVISION = '20170309'
# View your Google Analytics data
AUTH_ANALYTICS_READONLY = 'https://www.googleapis.com/auth/analytics.readonly'

File diff suppressed because it is too large Load Diff

View File

@ -22,169 +22,19 @@ module Google
module Apis
module AnalyticsreportingV4
class PivotHeader
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 ColumnHeader
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 MetricHeader
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 SegmentFilterClause
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 SegmentDimensionFilter
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 SimpleSegment
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 SegmentMetricFilter
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 GetReportsRequest
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 Cohort
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 SequenceSegment
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 PivotHeaderEntry
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 SegmentSequenceStep
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 DateRangeValues
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 Segment
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class DateRange
class Cohort
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
@ -196,7 +46,19 @@ module Google
include Google::Apis::Core::JsonObjectSupport
end
class CohortGroup
class OrFiltersForSegment
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 DimensionFilterClause
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
@ -208,19 +70,103 @@ module Google
include Google::Apis::Core::JsonObjectSupport
end
class SequenceSegment
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 DateRangeValues
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 GetReportsRequest
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 PivotHeaderEntry
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 SegmentDefinition
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 MetricFilter
class ReportData
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class Dimension
class DimensionFilter
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 OrderBy
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 SegmentSequenceStep
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
@ -232,200 +178,96 @@ module Google
include Google::Apis::Core::JsonObjectSupport
end
class Report
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class PivotHeader
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :total_pivot_groups_count, as: 'totalPivotGroupsCount'
collection :pivot_header_entries, as: 'pivotHeaderEntries', class: Google::Apis::AnalyticsreportingV4::PivotHeaderEntry, decorator: Google::Apis::AnalyticsreportingV4::PivotHeaderEntry::Representation
class Representation < Google::Apis::Core::JsonRepresentation; end
end
include Google::Apis::Core::JsonObjectSupport
end
class Metric
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :alias, as: 'alias'
property :formatting_type, as: 'formattingType'
property :expression, as: 'expression'
end
class DateRange
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
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
class MetricFilter
class Representation < Google::Apis::Core::JsonRepresentation; end
end
include Google::Apis::Core::JsonObjectSupport
end
class ReportRequest
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 DynamicSegment
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :session_segment, as: 'sessionSegment', class: Google::Apis::AnalyticsreportingV4::SegmentDefinition, decorator: Google::Apis::AnalyticsreportingV4::SegmentDefinition::Representation
class Representation < Google::Apis::Core::JsonRepresentation; end
property :name, as: 'name'
property :user_segment, as: 'userSegment', class: Google::Apis::AnalyticsreportingV4::SegmentDefinition, decorator: Google::Apis::AnalyticsreportingV4::SegmentDefinition::Representation
end
include Google::Apis::Core::JsonObjectSupport
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
class SimpleSegment
class Representation < Google::Apis::Core::JsonRepresentation; end
collection :pivot_headers, as: 'pivotHeaders', class: Google::Apis::AnalyticsreportingV4::PivotHeader, decorator: Google::Apis::AnalyticsreportingV4::PivotHeader::Representation
end
include Google::Apis::Core::JsonObjectSupport
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
class ColumnHeader
class Representation < Google::Apis::Core::JsonRepresentation; end
property :data, as: 'data', class: Google::Apis::AnalyticsreportingV4::ReportData, decorator: Google::Apis::AnalyticsreportingV4::ReportData::Representation
property :next_page_token, as: 'nextPageToken'
end
include Google::Apis::Core::JsonObjectSupport
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'
property :dimension_filter, as: 'dimensionFilter', class: Google::Apis::AnalyticsreportingV4::SegmentDimensionFilter, decorator: Google::Apis::AnalyticsreportingV4::SegmentDimensionFilter::Representation
end
end
class DimensionFilter
class MetricFilterClause
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :dimension_name, as: 'dimensionName'
property :operator, as: 'operator'
property :case_sensitive, as: 'caseSensitive'
collection :expressions, as: 'expressions'
property :not, as: 'not'
end
end
collection :filters, as: 'filters', class: Google::Apis::AnalyticsreportingV4::MetricFilter, decorator: Google::Apis::AnalyticsreportingV4::MetricFilter::Representation
class SegmentDimensionFilter
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :max_comparison_value, as: 'maxComparisonValue'
property :dimension_name, as: 'dimensionName'
property :case_sensitive, as: 'caseSensitive'
property :operator, as: 'operator'
collection :expressions, as: 'expressions'
property :min_comparison_value, as: 'minComparisonValue'
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 :dimensions, as: 'dimensions', class: Google::Apis::AnalyticsreportingV4::Dimension, decorator: Google::Apis::AnalyticsreportingV4::Dimension::Representation
collection :metric_filter_clauses, as: 'metricFilterClauses', class: Google::Apis::AnalyticsreportingV4::MetricFilterClause, decorator: Google::Apis::AnalyticsreportingV4::MetricFilterClause::Representation
property :hide_totals, as: 'hideTotals'
property :include_empty_rows, as: 'includeEmptyRows'
collection :dimension_filter_clauses, as: 'dimensionFilterClauses', class: Google::Apis::AnalyticsreportingV4::DimensionFilterClause, decorator: Google::Apis::AnalyticsreportingV4::DimensionFilterClause::Representation
collection :pivots, as: 'pivots', class: Google::Apis::AnalyticsreportingV4::Pivot, decorator: Google::Apis::AnalyticsreportingV4::Pivot::Representation
collection :date_ranges, as: 'dateRanges', class: Google::Apis::AnalyticsreportingV4::DateRange, decorator: Google::Apis::AnalyticsreportingV4::DateRange::Representation
collection :segments, as: 'segments', class: Google::Apis::AnalyticsreportingV4::Segment, decorator: Google::Apis::AnalyticsreportingV4::Segment::Representation
property :sampling_level, as: 'samplingLevel'
collection :metrics, as: 'metrics', class: Google::Apis::AnalyticsreportingV4::Metric, decorator: Google::Apis::AnalyticsreportingV4::Metric::Representation
property :page_size, as: 'pageSize'
collection :order_bys, as: 'orderBys', class: Google::Apis::AnalyticsreportingV4::OrderBy, decorator: Google::Apis::AnalyticsreportingV4::OrderBy::Representation
property :filters_expression, as: 'filtersExpression'
property :hide_value_ranges, as: 'hideValueRanges'
property :view_id, as: 'viewId'
property :page_token, as: 'pageToken'
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
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 SegmentMetricFilter
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :metric_name, as: 'metricName'
property :operator, as: 'operator'
property :comparison_value, as: 'comparisonValue'
property :scope, as: 'scope'
property :max_comparison_value, as: 'maxComparisonValue'
end
end
class ReportData
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :row_count, as: 'rowCount'
collection :sampling_space_sizes, as: 'samplingSpaceSizes'
collection :maximums, as: 'maximums', class: Google::Apis::AnalyticsreportingV4::DateRangeValues, decorator: Google::Apis::AnalyticsreportingV4::DateRangeValues::Representation
collection :samples_read_counts, as: 'samplesReadCounts'
collection :minimums, as: 'minimums', class: Google::Apis::AnalyticsreportingV4::DateRangeValues, decorator: Google::Apis::AnalyticsreportingV4::DateRangeValues::Representation
collection :rows, as: 'rows', class: Google::Apis::AnalyticsreportingV4::ReportRow, decorator: Google::Apis::AnalyticsreportingV4::ReportRow::Representation
collection :totals, as: 'totals', class: Google::Apis::AnalyticsreportingV4::DateRangeValues, decorator: Google::Apis::AnalyticsreportingV4::DateRangeValues::Representation
property :is_data_golden, as: 'isDataGolden'
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
end
end
class OrderBy
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :sort_order, as: 'sortOrder'
property :order_type, as: 'orderType'
property :field_name, as: 'fieldName'
end
end
class Cohort
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :type, as: 'type'
property :name, as: 'name'
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 ReportRow
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :metrics, as: 'metrics', class: Google::Apis::AnalyticsreportingV4::DateRangeValues, decorator: Google::Apis::AnalyticsreportingV4::DateRangeValues::Representation
collection :dimensions, as: 'dimensions'
end
end
@ -437,6 +279,33 @@ module Google
end
end
class MetricHeader
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :pivot_headers, as: 'pivotHeaders', class: Google::Apis::AnalyticsreportingV4::PivotHeader, decorator: Google::Apis::AnalyticsreportingV4::PivotHeader::Representation
collection :metric_header_entries, as: 'metricHeaderEntries', class: Google::Apis::AnalyticsreportingV4::MetricHeaderEntry, decorator: Google::Apis::AnalyticsreportingV4::MetricHeaderEntry::Representation
end
end
class DimensionFilterClause
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :operator, as: 'operator'
collection :filters, as: 'filters', class: Google::Apis::AnalyticsreportingV4::DimensionFilter, decorator: Google::Apis::AnalyticsreportingV4::DimensionFilter::Representation
end
end
class GetReportsResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :reports, as: 'reports', class: Google::Apis::AnalyticsreportingV4::Report, decorator: Google::Apis::AnalyticsreportingV4::Report::Representation
end
end
class SequenceSegment
# @private
class Representation < Google::Apis::Core::JsonRepresentation
@ -446,6 +315,67 @@ module Google
end
end
class SegmentMetricFilter
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :metric_name, as: 'metricName'
property :scope, as: 'scope'
property :max_comparison_value, as: 'maxComparisonValue'
property :comparison_value, as: 'comparisonValue'
property :operator, as: 'operator'
end
end
class DateRangeValues
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :values, as: 'values'
collection :pivot_value_regions, as: 'pivotValueRegions', class: Google::Apis::AnalyticsreportingV4::PivotValueRegion, decorator: Google::Apis::AnalyticsreportingV4::PivotValueRegion::Representation
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 GetReportsRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :report_requests, as: 'reportRequests', class: Google::Apis::AnalyticsreportingV4::ReportRequest, decorator: Google::Apis::AnalyticsreportingV4::ReportRequest::Representation
end
end
class Pivot
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :max_group_count, as: 'maxGroupCount'
property :start_group, as: 'startGroup'
collection :metrics, as: 'metrics', class: Google::Apis::AnalyticsreportingV4::Metric, decorator: Google::Apis::AnalyticsreportingV4::Metric::Representation
collection :dimensions, as: 'dimensions', class: Google::Apis::AnalyticsreportingV4::Dimension, decorator: Google::Apis::AnalyticsreportingV4::Dimension::Representation
collection :dimension_filter_clauses, as: 'dimensionFilterClauses', class: Google::Apis::AnalyticsreportingV4::DimensionFilterClause, decorator: Google::Apis::AnalyticsreportingV4::DimensionFilterClause::Representation
end
end
class PivotHeaderEntry
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :dimension_names, as: 'dimensionNames'
property :metric, as: 'metric', class: Google::Apis::AnalyticsreportingV4::MetricHeaderEntry, decorator: Google::Apis::AnalyticsreportingV4::MetricHeaderEntry::Representation
collection :dimension_values, as: 'dimensionValues'
end
end
class SegmentFilter
# @private
class Representation < Google::Apis::Core::JsonRepresentation
@ -457,105 +387,10 @@ module Google
end
end
class PivotHeaderEntry
class SegmentDefinition
# @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 DimensionFilterClause
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :operator, as: 'operator'
collection :filters, as: 'filters', class: Google::Apis::AnalyticsreportingV4::DimensionFilter, decorator: Google::Apis::AnalyticsreportingV4::DimensionFilter::Representation
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 Pivot
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :dimensions, as: 'dimensions', class: Google::Apis::AnalyticsreportingV4::Dimension, decorator: Google::Apis::AnalyticsreportingV4::Dimension::Representation
collection :metrics, as: 'metrics', class: Google::Apis::AnalyticsreportingV4::Metric, decorator: Google::Apis::AnalyticsreportingV4::Metric::Representation
property :max_group_count, as: 'maxGroupCount'
collection :dimension_filter_clauses, as: 'dimensionFilterClauses', class: Google::Apis::AnalyticsreportingV4::DimensionFilterClause, decorator: Google::Apis::AnalyticsreportingV4::DimensionFilterClause::Representation
property :start_group, as: 'startGroup'
end
end
class DateRangeValues
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :values, as: 'values'
collection :pivot_value_regions, as: 'pivotValueRegions', class: Google::Apis::AnalyticsreportingV4::PivotValueRegion, decorator: Google::Apis::AnalyticsreportingV4::PivotValueRegion::Representation
end
end
class MetricFilterClause
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :operator, as: 'operator'
collection :filters, as: 'filters', class: Google::Apis::AnalyticsreportingV4::MetricFilter, decorator: Google::Apis::AnalyticsreportingV4::MetricFilter::Representation
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 DateRange
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :start_date, as: 'startDate'
property :end_date, as: 'endDate'
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 CohortGroup
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :lifetime_value, as: 'lifetimeValue'
collection :cohorts, as: 'cohorts', class: Google::Apis::AnalyticsreportingV4::Cohort, decorator: Google::Apis::AnalyticsreportingV4::Cohort::Representation
end
end
class GetReportsResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :reports, as: 'reports', class: Google::Apis::AnalyticsreportingV4::Report, decorator: Google::Apis::AnalyticsreportingV4::Report::Representation
collection :segment_filters, as: 'segmentFilters', class: Google::Apis::AnalyticsreportingV4::SegmentFilter, decorator: Google::Apis::AnalyticsreportingV4::SegmentFilter::Representation
end
end
@ -568,16 +403,161 @@ module Google
end
end
class ReportData
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :minimums, as: 'minimums', class: Google::Apis::AnalyticsreportingV4::DateRangeValues, decorator: Google::Apis::AnalyticsreportingV4::DateRangeValues::Representation
collection :sampling_space_sizes, as: 'samplingSpaceSizes'
collection :totals, as: 'totals', class: Google::Apis::AnalyticsreportingV4::DateRangeValues, decorator: Google::Apis::AnalyticsreportingV4::DateRangeValues::Representation
collection :samples_read_counts, as: 'samplesReadCounts'
property :is_data_golden, as: 'isDataGolden'
collection :rows, as: 'rows', class: Google::Apis::AnalyticsreportingV4::ReportRow, decorator: Google::Apis::AnalyticsreportingV4::ReportRow::Representation
property :row_count, as: 'rowCount'
property :data_last_refreshed, as: 'dataLastRefreshed'
collection :maximums, as: 'maximums', class: Google::Apis::AnalyticsreportingV4::DateRangeValues, decorator: Google::Apis::AnalyticsreportingV4::DateRangeValues::Representation
end
end
class DimensionFilter
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :case_sensitive, as: 'caseSensitive'
property :dimension_name, as: 'dimensionName'
property :operator, as: 'operator'
property :not, as: 'not'
collection :expressions, as: 'expressions'
end
end
class SegmentDimensionFilter
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :min_comparison_value, as: 'minComparisonValue'
property :max_comparison_value, as: 'maxComparisonValue'
property :dimension_name, as: 'dimensionName'
property :operator, as: 'operator'
collection :expressions, as: 'expressions'
property :case_sensitive, as: 'caseSensitive'
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 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 SegmentSequenceStep
# @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
property :match_type, as: 'matchType'
end
end
class Metric
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :expression, as: 'expression'
property :formatting_type, as: 'formattingType'
property :alias, as: 'alias'
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 :data, as: 'data', class: Google::Apis::AnalyticsreportingV4::ReportData, decorator: Google::Apis::AnalyticsreportingV4::ReportData::Representation
property :next_page_token, as: 'nextPageToken'
property :column_header, as: 'columnHeader', class: Google::Apis::AnalyticsreportingV4::ColumnHeader, decorator: Google::Apis::AnalyticsreportingV4::ColumnHeader::Representation
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 DateRange
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :start_date, as: 'startDate'
property :end_date, as: 'endDate'
end
end
class MetricFilter
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :metric_name, as: 'metricName'
property :operator, as: 'operator'
property :comparison_value, as: 'comparisonValue'
property :operator, as: 'operator'
property :not, as: 'not'
end
end
class ReportRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :metric_filter_clauses, as: 'metricFilterClauses', class: Google::Apis::AnalyticsreportingV4::MetricFilterClause, decorator: Google::Apis::AnalyticsreportingV4::MetricFilterClause::Representation
property :page_size, as: 'pageSize'
property :hide_totals, as: 'hideTotals'
property :hide_value_ranges, as: 'hideValueRanges'
property :filters_expression, as: 'filtersExpression'
property :cohort_group, as: 'cohortGroup', class: Google::Apis::AnalyticsreportingV4::CohortGroup, decorator: Google::Apis::AnalyticsreportingV4::CohortGroup::Representation
property :view_id, as: 'viewId'
collection :metrics, as: 'metrics', class: Google::Apis::AnalyticsreportingV4::Metric, decorator: Google::Apis::AnalyticsreportingV4::Metric::Representation
collection :dimension_filter_clauses, as: 'dimensionFilterClauses', class: Google::Apis::AnalyticsreportingV4::DimensionFilterClause, decorator: Google::Apis::AnalyticsreportingV4::DimensionFilterClause::Representation
collection :order_bys, as: 'orderBys', class: Google::Apis::AnalyticsreportingV4::OrderBy, decorator: Google::Apis::AnalyticsreportingV4::OrderBy::Representation
collection :segments, as: 'segments', class: Google::Apis::AnalyticsreportingV4::Segment, decorator: Google::Apis::AnalyticsreportingV4::Segment::Representation
property :sampling_level, as: 'samplingLevel'
collection :dimensions, as: 'dimensions', class: Google::Apis::AnalyticsreportingV4::Dimension, decorator: Google::Apis::AnalyticsreportingV4::Dimension::Representation
property :page_token, as: 'pageToken'
collection :date_ranges, as: 'dateRanges', class: Google::Apis::AnalyticsreportingV4::DateRange, decorator: Google::Apis::AnalyticsreportingV4::DateRange::Representation
collection :pivots, as: 'pivots', class: Google::Apis::AnalyticsreportingV4::Pivot, decorator: Google::Apis::AnalyticsreportingV4::Pivot::Representation
property :include_empty_rows, as: 'includeEmptyRows'
end
end
class Dimension
# @private
class Representation < Google::Apis::Core::JsonRepresentation
@ -586,10 +566,31 @@ module Google
end
end
class PivotValueRegion
class DynamicSegment
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :values, as: 'values'
property :session_segment, as: 'sessionSegment', class: Google::Apis::AnalyticsreportingV4::SegmentDefinition, decorator: Google::Apis::AnalyticsreportingV4::SegmentDefinition::Representation
property :name, as: 'name'
property :user_segment, as: 'userSegment', class: Google::Apis::AnalyticsreportingV4::SegmentDefinition, decorator: Google::Apis::AnalyticsreportingV4::SegmentDefinition::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
class ColumnHeader
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :metric_header, as: 'metricHeader', class: Google::Apis::AnalyticsreportingV4::MetricHeader, decorator: Google::Apis::AnalyticsreportingV4::MetricHeader::Representation
collection :dimensions, as: 'dimensions'
end
end
end

View File

@ -48,11 +48,11 @@ module Google
# 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 [String] fields
# Selector specifying which fields to include in a partial response.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
@ -65,14 +65,14 @@ module Google
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def batch_get_reports(get_reports_request_object = nil, quota_user: nil, fields: nil, options: nil, &block)
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['quotaUser'] = quota_user unless quota_user.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end

View File

@ -25,7 +25,7 @@ module Google
# @see https://developers.google.com/android/work/play/emm-api
module AndroidenterpriseV1
VERSION = 'V1'
REVISION = '20160803'
REVISION = '20170322'
# Manage corporate Android devices
AUTH_ANDROIDENTERPRISE = 'https://www.googleapis.com/auth/androidenterprise'

View File

@ -22,12 +22,12 @@ module Google
module Apis
module AndroidenterpriseV1
# This represents an enterprise administrator who can manage the enterprise in
# the Google Play for Work Store.
# This represents an enterprise admin who can manage the enterprise in the
# managed Google Play store.
class Administrator
include Google::Apis::Core::Hashable
# The administrator's email address.
# The admin's email address.
# Corresponds to the JSON property `email`
# @return [String]
attr_accessor :email
@ -42,6 +42,70 @@ module Google
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<String>]
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
# Represents the list of app restrictions available to be pre-configured for the
# product.
class AppRestrictionsSchema
@ -113,7 +177,9 @@ module Google
attr_accessor :entry
# For choice or multiselect restrictions, the list of possible entries' machine-
# readable values.
# 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<String>]
attr_accessor :entry_value
@ -124,7 +190,9 @@ module Google
# @return [String]
attr_accessor :key
# For bundle or bundleArray restrictions, the list of nested restrictions.
# 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<Google::Apis::AndroidenterpriseV1::AppRestrictionsSchemaRestriction>]
attr_accessor :nested_restriction
@ -232,7 +300,7 @@ module Google
# @return [Fixnum]
attr_accessor :version_code
# The string used in the Play Store by the app developer to identify the version.
# 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`
@ -306,129 +374,15 @@ module Google
end
end
# A collection resource defines a named set of apps that is visible to a set of
# users in the Google Play Store app running on those users' managed devices.
# Those users can then install any of those apps if they wish (which will
# trigger creation of install and entitlement resources). A user cannot install
# an app on a managed device unless the app is listed in at least one collection
# that is visible to that user.
# Note that the API can be used to directly install an app regardless of whether
# it is in any collection - so an enterprise has a choice of either directly
# pushing apps to users, or allowing users to install apps if they want. Which
# is appropriate will depend on the enterprise's policies and the purpose of the
# apps concerned.
class Collection
include Google::Apis::Core::Hashable
# Arbitrary unique ID, allocated by the API on creation.
# Corresponds to the JSON property `collectionId`
# @return [String]
attr_accessor :collection_id
# Identifies what kind of resource this is. Value: the fixed string "
# androidenterprise#collection".
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# A user-friendly name for the collection (should be unique), e.g. "Accounting
# apps".
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# The IDs of the products in the collection, in the order in which they should
# be displayed.
# Corresponds to the JSON property `productId`
# @return [Array<String>]
attr_accessor :product_id
# Whether this collection is visible to all users, or only to the users that
# have been granted access through the "Collectionviewers" API. With the launch
# of the "setAvailableProductSet" API, this property should always be set to "
# viewersOnly", as the "allUsers" option will bypass the "availableProductSet"
# for all users within a domain.
# The "allUsers" setting is deprecated, and will be removed.
# 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)
@collection_id = args[:collection_id] if args.key?(:collection_id)
@kind = args[:kind] if args.key?(:kind)
@name = args[:name] if args.key?(:name)
@product_id = args[:product_id] if args.key?(:product_id)
@visibility = args[:visibility] if args.key?(:visibility)
end
end
# The user resources for the collection.
class ListCollectionViewersResponse
include Google::Apis::Core::Hashable
# Identifies what kind of resource this is. Value: the fixed string "
# androidenterprise#collectionViewersListResponse".
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# A user of an enterprise.
# Corresponds to the JSON property `user`
# @return [Array<Google::Apis::AndroidenterpriseV1::User>]
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 collection resources for the enterprise.
class ListCollectionsResponse
include Google::Apis::Core::Hashable
# An ordered collection of products which can be made visible on the Google Play
# Store to a selected group of users.
# Corresponds to the JSON property `collection`
# @return [Array<Google::Apis::AndroidenterpriseV1::Collection>]
attr_accessor :collection
# Identifies what kind of resource this is. Value: the fixed string "
# androidenterprise#collectionsListResponse".
# 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)
@collection = args[:collection] if args.key?(:collection)
@kind = args[:kind] if args.key?(:kind)
end
end
# A device resource represents a mobile device managed by the EMM and belonging
# A Devices resource represents a mobile device managed by the EMM and belonging
# to a specific enterprise user.
# This collection cannot be modified via the API; it is automatically populated
# This collection cannot be modified via the API. It is automatically populated
# as devices are set up to be managed.
class Device
include Google::Apis::Core::Hashable
# The Google Play Services Android ID for the device encoded as a lowercase hex
# string, e.g. "123456789abcdef0".
# string. For example, "123456789abcdef0".
# Corresponds to the JSON property `androidId`
# @return [String]
attr_accessor :android_id
@ -439,11 +393,19 @@ module Google
# @return [String]
attr_accessor :kind
# The mechanism by which this device is managed by the EMM. "managedDevice"
# means that the EMM's app is a device owner. "managedProfile" means that the
# EMM's app is the profile owner (and there is a separate personal profile which
# is not managed). "containerApp" means that the EMM's app is managing the
# Android for Work container app on the device.
# 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", a device running the container App. The container App is
# managed by the DPC,
# - "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
@ -523,16 +485,16 @@ module Google
# 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 Android for Work Accounts customers, the process involves using
# - For managed Google Play Accounts customers, the process involves using
# Enterprises.generateSignupUrl and Enterprises.completeSignup in conjunction
# with the Android for Work Sign-up UI (Google-provided mechanism) to create the
# binding without manual steps. As an EMM, you can support either or both
# 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
# Administrators of the enterprise. This is only supported for enterprises
# created via the EMM-initiated flow.
# Admins of the enterprise. This is only supported for enterprises created via
# the EMM-initiated flow.
# Corresponds to the JSON property `administrator`
# @return [Array<Google::Apis::AndroidenterpriseV1::Administrator>]
attr_accessor :administrator
@ -651,30 +613,26 @@ module Google
end
end
# The existence of an entitlement resource means that a user has the right to
# use a particular app on any of their devices. This might be because the app is
# free or because they have been allocated a license to the app from a group
# license purchased by the enterprise.
# It should always be true that a user has an app installed on one of their
# devices only if they have an entitlement to it. So if an entitlement is
# deleted, the app will be uninstalled from all devices. Similarly if the user
# installs an app (and is permitted to do so), or the EMM triggers an install of
# the app, an entitlement to that app is automatically created. If this is
# impossible - e.g. the enterprise has not purchased sufficient licenses - then
# installation fails.
# Note that entitlements are always user specific, not device specific; a user
# may have an entitlement even though they have not installed the app anywhere.
# Once they have an entitlement they can install the app on multiple devices.
# The API can be used to create an entitlement. If the app is a free app, a
# group license for that app is created. If it's a paid app, creating the
# entitlement consumes one license; it remains consumed until the entitlement is
# removed. Optionally an installation of the app on all the user's managed
# devices can be triggered at the time the entitlement is created. An
# entitlement cannot be created for an app if the app requires permissions that
# the enterprise has not yet accepted.
# Entitlements for paid apps that are due to purchases by the user on a non-
# managed profile will have "userPurchase" as entitlement reason; those
# entitlements cannot be removed via the API.
# 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
@ -684,14 +642,15 @@ module Google
# @return [String]
attr_accessor :kind
# The ID of the product that the entitlement is for, e.g. "app:com.google.
# android.gm".
# 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, e.g. "free" for free apps. This is temporary,
# it will be replaced by the acquisition kind field of group licenses.
# 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
@ -755,19 +714,18 @@ module Google
class GroupLicense
include Google::Apis::Core::Hashable
# How this group license was acquired. "bulkPurchase" means that this group
# license object was created because the enterprise purchased licenses for this
# product; this is "free" otherwise (for free products).
# 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, as either "approved" or "unapproved". 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.
# 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
@ -785,14 +743,14 @@ module Google
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 (e.g. if the acquisition kind is "free").
# 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 ID of the product that the license is for, e.g. "app:com.google.android.gm"
# .
# 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
@ -864,18 +822,18 @@ module Google
end
end
# The existence of an install resource indicates that an app is installed on a
# 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 (e.g. 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
# 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.
# 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.
@ -900,8 +858,8 @@ module Google
# @return [String]
attr_accessor :kind
# The ID of the product that the install is for, e.g. "app:com.google.android.gm"
# .
# 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
@ -1190,6 +1148,41 @@ module Google
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
# 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)
@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
@ -1255,6 +1248,11 @@ module Google
# @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]
@ -1286,6 +1284,7 @@ module Google
@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)
@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)
@ -1360,17 +1359,18 @@ module Google
end
end
# A permission 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.
# 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 EMM
# 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 giving more details of what it affects.
# 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
@ -1404,7 +1404,7 @@ module Google
end
end
# A Products resource represents an app in the Google Play Store that is
# 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.)
@ -1420,7 +1420,7 @@ module Google
# @return [Array<Google::Apis::AndroidenterpriseV1::AppVersion>]
attr_accessor :app_version
# The name of the author of the product (e.g. the app developer).
# 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
@ -1431,7 +1431,7 @@ module Google
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
# 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
@ -1465,8 +1465,8 @@ module Google
# @return [String]
attr_accessor :product_pricing
# Whether this app can only be installed on devices using the Android for Work
# container app.
# Whether this app can only be installed on devices using the Android container
# app.
# Corresponds to the JSON property `requiresContainerApp`
# @return [Boolean]
attr_accessor :requires_container_app
@ -1483,8 +1483,8 @@ module Google
# @return [String]
attr_accessor :title
# A link to the Google Play for Work details page for the product, for use by an
# Enterprise administrator.
# 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
@ -1640,6 +1640,17 @@ module Google
# @return [Array<String>]
attr_accessor :product_id
# The interpretation of this product set. "unknown" should never be sent and is
# ignored if received. "whitelist" means that this product set constitutes a
# whitelist. "includeAll" means that all products are accessible, including
# products that are approved, products with revoked approval, and products that
# have never been approved. If the value is "includeAll", the value of the
# productId field is therefore ignored. If a value is not supplied, it is
# interpreted to be "whitelist" for backwards compatibility.
# Corresponds to the JSON property `productSetBehavior`
# @return [String]
attr_accessor :product_set_behavior
def initialize(**args)
update!(**args)
end
@ -1648,6 +1659,7 @@ module Google
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)
end
end
@ -1711,7 +1723,7 @@ module Google
# @return [Google::Apis::AndroidenterpriseV1::PageInfo]
attr_accessor :page_info
# Information about a product (e.g. an app) in the Google Play Store, for
# 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<Google::Apis::AndroidenterpriseV1::Product>]
@ -1791,6 +1803,13 @@ module Google
# @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]
@ -1805,6 +1824,7 @@ module Google
@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
@ -1863,7 +1883,7 @@ module Google
end
end
# Definition of a Google Play for Work store cluster, a list of products
# 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
@ -1916,17 +1936,15 @@ module Google
end
end
# General setting for the Google Play for Work store layout, currently only
# 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 will be used
# as the first page shown in the Google Play for Work store.
# If a homepage has not been set, the Play store shown on devices will be empty.
# Not specifying a homepage on a store layout effectively empties the store.
# If there exists at least one page, this field must be set to the ID of a valid
# page.
# 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
@ -1937,6 +1955,14 @@ module Google
# @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
@ -1945,6 +1971,7 @@ module Google
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
@ -2000,7 +2027,7 @@ module Google
end
end
# Definition of a Google Play for Work store page, made of a localized name and
# 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
@ -2072,14 +2099,14 @@ module Google
# 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 Google
# Play for Work only, or to other Google services, depending on the identity
# model:
# - Google managed domain identity model requires synchronization to Google
# 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).
# - Android for Work Accounts identity model provides a dynamic means for
# - 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 Google Play for Work only.
# provide access to managed Google Play.
class User
include Google::Apis::Core::Hashable
@ -2147,9 +2174,9 @@ module Google
end
# A UserToken is used by a user when setting up a managed device or profile with
# their work account on a device. When the user enters their email address and
# token (activation code) the appropriate EMM app can be automatically
# downloaded.
# 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

View File

@ -28,6 +28,18 @@ module Google
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 AppRestrictionsSchema
class Representation < Google::Apis::Core::JsonRepresentation; end
@ -76,24 +88,6 @@ module Google
include Google::Apis::Core::JsonObjectSupport
end
class Collection
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class ListCollectionViewersResponse
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class ListCollectionsResponse
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class Device
class Representation < Google::Apis::Core::JsonRepresentation; end
@ -220,6 +214,12 @@ module Google
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
@ -389,6 +389,23 @@ module Google
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 AppRestrictionsSchema
# @private
class Representation < Google::Apis::Core::JsonRepresentation
@ -463,35 +480,6 @@ module Google
end
end
class Collection
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :collection_id, as: 'collectionId'
property :kind, as: 'kind'
property :name, as: 'name'
collection :product_id, as: 'productId'
property :visibility, as: 'visibility'
end
end
class ListCollectionViewersResponse
# @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 ListCollectionsResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :collection, as: 'collection', class: Google::Apis::AndroidenterpriseV1::Collection, decorator: Google::Apis::AndroidenterpriseV1::Collection::Representation
property :kind, as: 'kind'
end
end
class Device
# @private
class Representation < Google::Apis::Core::JsonRepresentation
@ -692,6 +680,15 @@ module Google
end
end
class NewDeviceEvent
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :device_id, as: 'deviceId'
property :management_type, as: 'managementType'
property :user_id, as: 'userId'
end
end
class NewPermissionsEvent
# @private
class Representation < Google::Apis::Core::JsonRepresentation
@ -711,6 +708,8 @@ module Google
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 :product_approval_event, as: 'productApprovalEvent', class: Google::Apis::AndroidenterpriseV1::ProductApprovalEvent, decorator: Google::Apis::AndroidenterpriseV1::ProductApprovalEvent::Representation
@ -808,6 +807,7 @@ module Google
class Representation < Google::Apis::Core::JsonRepresentation
property :kind, as: 'kind'
collection :product_id, as: 'productId'
property :product_set_behavior, as: 'productSetBehavior'
end
end
@ -855,6 +855,7 @@ module Google
property :data, as: 'data'
property :id, as: 'id'
property :kind, as: 'kind'
property :public_data, as: 'publicData'
property :type, as: 'type'
end
end
@ -893,6 +894,7 @@ module Google
class Representation < Google::Apis::Core::JsonRepresentation
property :homepage_id, as: 'homepageId'
property :kind, as: 'kind'
property :store_layout_type, as: 'storeLayoutType'
end
end

View File

@ -52,451 +52,6 @@ module Google
super('https://www.googleapis.com/', 'androidenterprise/v1/')
end
# Deletes a collection.
# @param [String] enterprise_id
# The ID of the enterprise.
# @param [String] collection_id
# The ID of the collection.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# Overrides userIp if both are provided.
# @param [String] user_ip
# IP address of the site where the request originates. Use this if you 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_collection(enterprise_id, collection_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:delete, 'enterprises/{enterpriseId}/collections/{collectionId}', options)
command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil?
command.params['collectionId'] = collection_id unless collection_id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['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 a collection.
# @param [String] enterprise_id
# The ID of the enterprise.
# @param [String] collection_id
# The ID of the collection.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# Overrides userIp if both are provided.
# @param [String] user_ip
# IP address of the site where the request originates. Use this if you want to
# 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::Collection] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::AndroidenterpriseV1::Collection]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_collection(enterprise_id, collection_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:get, 'enterprises/{enterpriseId}/collections/{collectionId}', options)
command.response_representation = Google::Apis::AndroidenterpriseV1::Collection::Representation
command.response_class = Google::Apis::AndroidenterpriseV1::Collection
command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil?
command.params['collectionId'] = collection_id unless collection_id.nil?
command.query['fields'] = fields unless fields.nil?
command.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 collection.
# @param [String] enterprise_id
# The ID of the enterprise.
# @param [Google::Apis::AndroidenterpriseV1::Collection] collection_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# Overrides userIp if both are provided.
# @param [String] user_ip
# IP address of the site where the request originates. Use this if you want to
# 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::Collection] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::AndroidenterpriseV1::Collection]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_collection(enterprise_id, collection_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:post, 'enterprises/{enterpriseId}/collections', options)
command.request_representation = Google::Apis::AndroidenterpriseV1::Collection::Representation
command.request_object = collection_object
command.response_representation = Google::Apis::AndroidenterpriseV1::Collection::Representation
command.response_class = Google::Apis::AndroidenterpriseV1::Collection
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 all the collections for 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::ListCollectionsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::AndroidenterpriseV1::ListCollectionsResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_collections(enterprise_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:get, 'enterprises/{enterpriseId}/collections', options)
command.response_representation = Google::Apis::AndroidenterpriseV1::ListCollectionsResponse::Representation
command.response_class = Google::Apis::AndroidenterpriseV1::ListCollectionsResponse
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 a collection. This method supports patch semantics.
# @param [String] enterprise_id
# The ID of the enterprise.
# @param [String] collection_id
# The ID of the collection.
# @param [Google::Apis::AndroidenterpriseV1::Collection] collection_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# Overrides userIp if both are provided.
# @param [String] user_ip
# IP address of the site where the request originates. Use this if you want to
# 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::Collection] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::AndroidenterpriseV1::Collection]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_collection(enterprise_id, collection_id, collection_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:patch, 'enterprises/{enterpriseId}/collections/{collectionId}', options)
command.request_representation = Google::Apis::AndroidenterpriseV1::Collection::Representation
command.request_object = collection_object
command.response_representation = Google::Apis::AndroidenterpriseV1::Collection::Representation
command.response_class = Google::Apis::AndroidenterpriseV1::Collection
command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil?
command.params['collectionId'] = collection_id unless collection_id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['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 collection.
# @param [String] enterprise_id
# The ID of the enterprise.
# @param [String] collection_id
# The ID of the collection.
# @param [Google::Apis::AndroidenterpriseV1::Collection] collection_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# Overrides userIp if both are provided.
# @param [String] user_ip
# IP address of the site where the request originates. Use this if you want to
# 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::Collection] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::AndroidenterpriseV1::Collection]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_collection(enterprise_id, collection_id, collection_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:put, 'enterprises/{enterpriseId}/collections/{collectionId}', options)
command.request_representation = Google::Apis::AndroidenterpriseV1::Collection::Representation
command.request_object = collection_object
command.response_representation = Google::Apis::AndroidenterpriseV1::Collection::Representation
command.response_class = Google::Apis::AndroidenterpriseV1::Collection
command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil?
command.params['collectionId'] = collection_id unless collection_id.nil?
command.query['fields'] = fields unless fields.nil?
command.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 user from the list of those specifically allowed to see the
# collection. If the collection's visibility is set to viewersOnly then only
# such users will see the collection.
# @param [String] enterprise_id
# The ID of the enterprise.
# @param [String] collection_id
# The ID of the collection.
# @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_collection_viewer(enterprise_id, collection_id, user_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:delete, 'enterprises/{enterpriseId}/collections/{collectionId}/users/{userId}', options)
command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil?
command.params['collectionId'] = collection_id unless collection_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 ID of the user if they have been specifically allowed to see the
# collection. If the collection's visibility is set to viewersOnly then only
# these users will see the collection.
# @param [String] enterprise_id
# The ID of the enterprise.
# @param [String] collection_id
# The ID of the collection.
# @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_collection_viewer(enterprise_id, collection_id, user_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:get, 'enterprises/{enterpriseId}/collections/{collectionId}/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['collectionId'] = collection_id unless collection_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 IDs of the users who have been specifically allowed to see the
# collection. If the collection's visibility is set to viewersOnly then only
# these users will see the collection.
# @param [String] enterprise_id
# The ID of the enterprise.
# @param [String] collection_id
# The ID of the collection.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# Overrides userIp if both are provided.
# @param [String] user_ip
# IP address of the site where the request originates. Use this if you want to
# 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::ListCollectionViewersResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::AndroidenterpriseV1::ListCollectionViewersResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_collection_viewers(enterprise_id, collection_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:get, 'enterprises/{enterpriseId}/collections/{collectionId}/users', options)
command.response_representation = Google::Apis::AndroidenterpriseV1::ListCollectionViewersResponse::Representation
command.response_class = Google::Apis::AndroidenterpriseV1::ListCollectionViewersResponse
command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil?
command.params['collectionId'] = collection_id unless collection_id.nil?
command.query['fields'] = fields unless fields.nil?
command.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 user to the list of those specifically allowed to see the collection.
# If the collection's visibility is set to viewersOnly then only such users will
# see the collection. This method supports patch semantics.
# @param [String] enterprise_id
# The ID of the enterprise.
# @param [String] collection_id
# The ID of the collection.
# @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_collection_viewer(enterprise_id, collection_id, user_id, user_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:patch, 'enterprises/{enterpriseId}/collections/{collectionId}/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['collectionId'] = collection_id unless collection_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 the user to the list of those specifically allowed to see the collection.
# If the collection's visibility is set to viewersOnly then only such users will
# see the collection.
# @param [String] enterprise_id
# The ID of the enterprise.
# @param [String] collection_id
# The ID of the collection.
# @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_collection_viewer(enterprise_id, collection_id, user_id, user_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:put, 'enterprises/{enterpriseId}/collections/{collectionId}/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['collectionId'] = collection_id unless collection_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 details of a device.
# @param [String] enterprise_id
# The ID of the enterprise.
@ -745,9 +300,50 @@ module Google
execute_or_queue_command(command, &block)
end
# Deletes the binding between the EMM and enterprise. This is now deprecated;
# use this to unenroll customers that were previously enrolled with the 'insert'
# call, then enroll them again with the 'enroll' call.
# 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
@ -943,7 +539,7 @@ module Google
end
# Returns the store layout for the enterprise. If the store layout has not been
# set, or if the store layout has no homepageId set, returns a NOT_FOUND error.
# set, returns "basic" as the store layout type and no homepage.
# @param [String] enterprise_id
# The ID of the enterprise.
# @param [String] fields
@ -1069,11 +665,16 @@ module Google
# 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. If omitted, defaults to
# WAIT_FOR_NOTIFCATIONS.
# If this is set to WAIT_FOR_NOTIFCATIONS, the request will eventually timeout,
# in which case it should be retried.
# 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
@ -1142,7 +743,8 @@ module Google
execute_or_queue_command(command, &block)
end
# Set the account that will be used to authenticate to the API as the enterprise.
# 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
@ -1180,7 +782,13 @@ module Google
execute_or_queue_command(command, &block)
end
# Sets the store layout for the enterprise.
# 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
@ -1251,7 +859,7 @@ module Google
execute_or_queue_command(command, &block)
end
# Removes an entitlement to an app for a user and uninstalls it.
# Removes an entitlement to an app for a user.
# @param [String] enterprise_id
# The ID of the enterprise.
# @param [String] user_id
@ -1331,7 +939,7 @@ module Google
execute_or_queue_command(command, &block)
end
# List of all entitlements for the specified user. Only the ID is set.
# 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
@ -1715,7 +1323,7 @@ module Google
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
# 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.
@ -1765,7 +1373,7 @@ module Google
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.
# 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
@ -2297,8 +1905,8 @@ module Google
# 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 Google Play for Work to design and create a store layout
# to display approved products to your users, see Store Layout Design.
# 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
@ -2430,7 +2038,7 @@ module Google
# 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 administrator to configure the product. To apply a managed
# 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
@ -2527,11 +2135,11 @@ module Google
# 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
# 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
# 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
@ -2607,52 +2215,6 @@ module Google
execute_or_queue_command(command, &block)
end
# This method has been deprecated. To programmatically approve applications, you
# must use the iframe mechanism via the generateApprovalUrl and approve
# methods of the Products resource. For more information, see the Play EMM API
# usage requirements.
# The updatePermissions method (deprecated) updates the set of Android app
# permissions for this app that have been accepted by the enterprise.
# @param [String] enterprise_id
# The ID of the enterprise.
# @param [String] product_id
# The ID of the product.
# @param [Google::Apis::AndroidenterpriseV1::ProductPermissions] product_permissions_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# Overrides userIp if both are provided.
# @param [String] user_ip
# IP address of the site where the request originates. Use this if you want to
# 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 update_product_permissions(enterprise_id, product_id, product_permissions_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:put, 'enterprises/{enterpriseId}/products/{productId}/permissions', options)
command.request_representation = Google::Apis::AndroidenterpriseV1::ProductPermissions::Representation
command.request_object = product_permissions_object
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
# 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
@ -3326,8 +2888,9 @@ module Google
execute_or_queue_command(command, &block)
end
# Generates a token (activation code) to allow this user to configure their work
# account in the Android Setup Wizard. Revokes any previously generated token.
# 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.
@ -3445,6 +3008,9 @@ module Google
# 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
@ -3603,7 +3169,9 @@ module Google
execute_or_queue_command(command, &block)
end
# Modifies the set of products a user is entitled to access.
# 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

View File

@ -25,7 +25,7 @@ module Google
# @see https://developers.google.com/android-publisher
module AndroidpublisherV2
VERSION = 'V2'
REVISION = '20160816'
REVISION = '20170222'
# View and manage your Google Play Developer account
AUTH_ANDROIDPUBLISHER = 'https://www.googleapis.com/auth/androidpublisher'

View File

@ -277,6 +277,44 @@ module Google
end
end
# Represents a deobfuscation file.
class DeobfuscationFile
include Google::Apis::Core::Hashable
# The type of the deobfuscation file.
# Corresponds to the JSON property `symbolType`
# @return [String]
attr_accessor :symbol_type
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@symbol_type = args[:symbol_type] if args.key?(:symbol_type)
end
end
#
class DeobfuscationFilesUploadResponse
include Google::Apis::Core::Hashable
# Represents a deobfuscation file.
# Corresponds to the JSON property `deobfuscationFile`
# @return [Google::Apis::AndroidpublisherV2::DeobfuscationFile]
attr_accessor :deobfuscation_file
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@deobfuscation_file = args[:deobfuscation_file] if args.key?(:deobfuscation_file)
end
end
#
class DeveloperComment
include Google::Apis::Core::Hashable
@ -302,6 +340,85 @@ module Google
end
end
#
class DeviceMetadata
include Google::Apis::Core::Hashable
# Device CPU make e.g. "Qualcomm"
# Corresponds to the JSON property `cpuMake`
# @return [String]
attr_accessor :cpu_make
# Device CPU model e.g. "MSM8974"
# Corresponds to the JSON property `cpuModel`
# @return [String]
attr_accessor :cpu_model
# Device class (e.g. tablet)
# Corresponds to the JSON property `deviceClass`
# @return [String]
attr_accessor :device_class
# OpenGL version
# Corresponds to the JSON property `glEsVersion`
# @return [Fixnum]
attr_accessor :gl_es_version
# Device manufacturer (e.g. Motorola)
# Corresponds to the JSON property `manufacturer`
# @return [String]
attr_accessor :manufacturer
# Comma separated list of native platforms (e.g. "arm", "arm7")
# Corresponds to the JSON property `nativePlatform`
# @return [String]
attr_accessor :native_platform
# Device model name (e.g. Droid)
# Corresponds to the JSON property `productName`
# @return [String]
attr_accessor :product_name
# Device RAM in Megabytes e.g. "2048"
# Corresponds to the JSON property `ramMb`
# @return [Fixnum]
attr_accessor :ram_mb
# Screen density in DPI
# Corresponds to the JSON property `screenDensityDpi`
# @return [Fixnum]
attr_accessor :screen_density_dpi
# Screen height in pixels
# Corresponds to the JSON property `screenHeightPx`
# @return [Fixnum]
attr_accessor :screen_height_px
# Screen width in pixels
# Corresponds to the JSON property `screenWidthPx`
# @return [Fixnum]
attr_accessor :screen_width_px
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@cpu_make = args[:cpu_make] if args.key?(:cpu_make)
@cpu_model = args[:cpu_model] if args.key?(:cpu_model)
@device_class = args[:device_class] if args.key?(:device_class)
@gl_es_version = args[:gl_es_version] if args.key?(:gl_es_version)
@manufacturer = args[:manufacturer] if args.key?(:manufacturer)
@native_platform = args[:native_platform] if args.key?(:native_platform)
@product_name = args[:product_name] if args.key?(:product_name)
@ram_mb = args[:ram_mb] if args.key?(:ram_mb)
@screen_density_dpi = args[:screen_density_dpi] if args.key?(:screen_density_dpi)
@screen_height_px = args[:screen_height_px] if args.key?(:screen_height_px)
@screen_width_px = args[:screen_width_px] if args.key?(:screen_width_px)
end
end
# An Entitlement resource indicates a user's current entitlement to an inapp
# item or subscription.
class Entitlement
@ -1466,6 +1583,12 @@ module Google
# @return [String]
attr_accessor :start_time_millis
# The time at which the subscription was canceled by the user, in milliseconds
# since the epoch. Only present if cancelReason is 0.
# Corresponds to the JSON property `userCancellationTimeMillis`
# @return [String]
attr_accessor :user_cancellation_time_millis
def initialize(**args)
update!(**args)
end
@ -1482,6 +1605,7 @@ module Google
@price_amount_micros = args[:price_amount_micros] if args.key?(:price_amount_micros)
@price_currency_code = args[:price_currency_code] if args.key?(:price_currency_code)
@start_time_millis = args[:start_time_millis] if args.key?(:start_time_millis)
@user_cancellation_time_millis = args[:user_cancellation_time_millis] if args.key?(:user_cancellation_time_millis)
end
end
@ -1683,11 +1807,22 @@ module Google
# @return [String]
attr_accessor :device
# Some information about the characteristics of the user's device
# Corresponds to the JSON property `deviceMetadata`
# @return [Google::Apis::AndroidpublisherV2::DeviceMetadata]
attr_accessor :device_metadata
# The last time at which this comment was updated.
# Corresponds to the JSON property `lastModified`
# @return [Google::Apis::AndroidpublisherV2::Timestamp]
attr_accessor :last_modified
# Untranslated text of the review, in the case where the review has been
# translated. If the review has not been translated this is left blank.
# Corresponds to the JSON property `originalText`
# @return [String]
attr_accessor :original_text
# Language code for the reviewer. This is taken from the device settings so is
# not guaranteed to match the language the review is written in. May be absent.
# Corresponds to the JSON property `reviewerLanguage`
@ -1706,6 +1841,16 @@ module Google
# @return [String]
attr_accessor :text
# Number of users who have given this review a thumbs down
# Corresponds to the JSON property `thumbsDownCount`
# @return [Fixnum]
attr_accessor :thumbs_down_count
# Number of users who have given this review a thumbs up
# Corresponds to the JSON property `thumbsUpCount`
# @return [Fixnum]
attr_accessor :thumbs_up_count
def initialize(**args)
update!(**args)
end
@ -1716,10 +1861,86 @@ module Google
@app_version_code = args[:app_version_code] if args.key?(:app_version_code)
@app_version_name = args[:app_version_name] if args.key?(:app_version_name)
@device = args[:device] if args.key?(:device)
@device_metadata = args[:device_metadata] if args.key?(:device_metadata)
@last_modified = args[:last_modified] if args.key?(:last_modified)
@original_text = args[:original_text] if args.key?(:original_text)
@reviewer_language = args[:reviewer_language] if args.key?(:reviewer_language)
@star_rating = args[:star_rating] if args.key?(:star_rating)
@text = args[:text] if args.key?(:text)
@thumbs_down_count = args[:thumbs_down_count] if args.key?(:thumbs_down_count)
@thumbs_up_count = args[:thumbs_up_count] if args.key?(:thumbs_up_count)
end
end
# A VoidedPurchase resource indicates a purchase that was either cancelled/
# refunded/charged-back.
class VoidedPurchase
include Google::Apis::Core::Hashable
# This kind represents a voided purchase object in the androidpublisher service.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# The time at which the purchase was made, in milliseconds since the epoch (Jan
# 1, 1970).
# Corresponds to the JSON property `purchaseTimeMillis`
# @return [String]
attr_accessor :purchase_time_millis
# The token that was generated when a purchase was made. This uniquely
# identifies a purchase.
# Corresponds to the JSON property `purchaseToken`
# @return [String]
attr_accessor :purchase_token
# The time at which the purchase was cancelled/refunded/charged-back, in
# milliseconds since the epoch (Jan 1, 1970).
# Corresponds to the JSON property `voidedTimeMillis`
# @return [String]
attr_accessor :voided_time_millis
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@kind = args[:kind] if args.key?(:kind)
@purchase_time_millis = args[:purchase_time_millis] if args.key?(:purchase_time_millis)
@purchase_token = args[:purchase_token] if args.key?(:purchase_token)
@voided_time_millis = args[:voided_time_millis] if args.key?(:voided_time_millis)
end
end
#
class VoidedPurchasesListResponse
include Google::Apis::Core::Hashable
#
# Corresponds to the JSON property `pageInfo`
# @return [Google::Apis::AndroidpublisherV2::PageInfo]
attr_accessor :page_info
#
# Corresponds to the JSON property `tokenPagination`
# @return [Google::Apis::AndroidpublisherV2::TokenPagination]
attr_accessor :token_pagination
#
# Corresponds to the JSON property `voidedPurchases`
# @return [Array<Google::Apis::AndroidpublisherV2::VoidedPurchase>]
attr_accessor :voided_purchases
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@page_info = args[:page_info] if args.key?(:page_info)
@token_pagination = args[:token_pagination] if args.key?(:token_pagination)
@voided_purchases = args[:voided_purchases] if args.key?(:voided_purchases)
end
end
end

View File

@ -82,12 +82,30 @@ module Google
include Google::Apis::Core::JsonObjectSupport
end
class DeobfuscationFile
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class DeobfuscationFilesUploadResponse
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class DeveloperComment
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class DeviceMetadata
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class Entitlement
class Representation < Google::Apis::Core::JsonRepresentation; end
@ -352,6 +370,18 @@ module Google
include Google::Apis::Core::JsonObjectSupport
end
class VoidedPurchase
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class VoidedPurchasesListResponse
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class Apk
# @private
class Representation < Google::Apis::Core::JsonRepresentation
@ -438,6 +468,21 @@ module Google
end
end
class DeobfuscationFile
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :symbol_type, as: 'symbolType'
end
end
class DeobfuscationFilesUploadResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :deobfuscation_file, as: 'deobfuscationFile', class: Google::Apis::AndroidpublisherV2::DeobfuscationFile, decorator: Google::Apis::AndroidpublisherV2::DeobfuscationFile::Representation
end
end
class DeveloperComment
# @private
class Representation < Google::Apis::Core::JsonRepresentation
@ -447,6 +492,23 @@ module Google
end
end
class DeviceMetadata
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :cpu_make, as: 'cpuMake'
property :cpu_model, as: 'cpuModel'
property :device_class, as: 'deviceClass'
property :gl_es_version, as: 'glEsVersion'
property :manufacturer, as: 'manufacturer'
property :native_platform, as: 'nativePlatform'
property :product_name, as: 'productName'
property :ram_mb, as: 'ramMb'
property :screen_density_dpi, as: 'screenDensityDpi'
property :screen_height_px, as: 'screenHeightPx'
property :screen_width_px, as: 'screenWidthPx'
end
end
class Entitlement
# @private
class Representation < Google::Apis::Core::JsonRepresentation
@ -807,6 +869,7 @@ module Google
property :price_amount_micros, as: 'priceAmountMicros'
property :price_currency_code, as: 'priceCurrencyCode'
property :start_time_millis, as: 'startTimeMillis'
property :user_cancellation_time_millis, as: 'userCancellationTimeMillis'
end
end
@ -874,11 +937,38 @@ module Google
property :app_version_code, as: 'appVersionCode'
property :app_version_name, as: 'appVersionName'
property :device, as: 'device'
property :device_metadata, as: 'deviceMetadata', class: Google::Apis::AndroidpublisherV2::DeviceMetadata, decorator: Google::Apis::AndroidpublisherV2::DeviceMetadata::Representation
property :last_modified, as: 'lastModified', class: Google::Apis::AndroidpublisherV2::Timestamp, decorator: Google::Apis::AndroidpublisherV2::Timestamp::Representation
property :original_text, as: 'originalText'
property :reviewer_language, as: 'reviewerLanguage'
property :star_rating, as: 'starRating'
property :text, as: 'text'
property :thumbs_down_count, as: 'thumbsDownCount'
property :thumbs_up_count, as: 'thumbsUpCount'
end
end
class VoidedPurchase
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :kind, as: 'kind'
property :purchase_time_millis, as: 'purchaseTimeMillis'
property :purchase_token, as: 'purchaseToken'
property :voided_time_millis, as: 'voidedTimeMillis'
end
end
class VoidedPurchasesListResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :page_info, as: 'pageInfo', class: Google::Apis::AndroidpublisherV2::PageInfo, decorator: Google::Apis::AndroidpublisherV2::PageInfo::Representation
property :token_pagination, as: 'tokenPagination', class: Google::Apis::AndroidpublisherV2::TokenPagination, decorator: Google::Apis::AndroidpublisherV2::TokenPagination::Representation
collection :voided_purchases, as: 'voidedPurchases', class: Google::Apis::AndroidpublisherV2::VoidedPurchase, decorator: Google::Apis::AndroidpublisherV2::VoidedPurchase::Representation
end
end
end

View File

@ -660,6 +660,61 @@ module Google
execute_or_queue_command(command, &block)
end
# Uploads the deobfuscation file of the specified APK. If a deobfuscation file
# already exists, it will be replaced.
# @param [String] package_name
# Unique identifier of the Android app for which the deobfuscatiuon files are
# being uploaded; for example, "com.spiffygame".
# @param [String] edit_id
# Unique identifier for this edit.
# @param [Fixnum] apk_version_code
# The version code of the APK whose deobfuscation file is being uploaded.
# @param [String] deobfuscation_file_type
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# Overrides userIp if both are provided.
# @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::AndroidpublisherV2::DeobfuscationFilesUploadResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::AndroidpublisherV2::DeobfuscationFilesUploadResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def upload_edit_deobfuscationfile(package_name, edit_id, apk_version_code, deobfuscation_file_type, fields: nil, quota_user: nil, user_ip: nil, upload_source: nil, content_type: nil, options: nil, &block)
if upload_source.nil?
command = make_simple_command(:post, '{packageName}/edits/{editId}/apks/{apkVersionCode}/deobfuscationFiles/{deobfuscationFileType}', options)
else
command = make_upload_command(:post, '{packageName}/edits/{editId}/apks/{apkVersionCode}/deobfuscationFiles/{deobfuscationFileType}', options)
command.upload_source = upload_source
command.upload_content_type = content_type
end
command.response_representation = Google::Apis::AndroidpublisherV2::DeobfuscationFilesUploadResponse::Representation
command.response_class = Google::Apis::AndroidpublisherV2::DeobfuscationFilesUploadResponse
command.params['packageName'] = package_name unless package_name.nil?
command.params['editId'] = edit_id unless edit_id.nil?
command.params['apkVersionCode'] = apk_version_code unless apk_version_code.nil?
command.params['deobfuscationFileType'] = deobfuscation_file_type unless deobfuscation_file_type.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['userIp'] = user_ip unless user_ip.nil?
execute_or_queue_command(command, &block)
end
# Fetches app details for this edit. This includes the default language and
# developer support contact information.
# @param [String] package_name
@ -2325,11 +2380,66 @@ module Google
execute_or_queue_command(command, &block)
end
# Lists the purchases that were cancelled, refunded or charged-back.
# @param [String] package_name
# The package name of the application for which voided purchases need to be
# returned (for example, 'com.some.thing').
# @param [String] end_time
# The time, in milliseconds since the Epoch, of the newest voided in-app product
# purchase that you want to see in the response. The value of this parameter
# cannot be greater than the current time and is ignored if a pagination token
# is set. Default value is current time.
# @param [Fixnum] max_results
# @param [Fixnum] start_index
# @param [String] start_time
# The time, in milliseconds since the Epoch, of the oldest voided in-app product
# purchase that you want to see in the response. The value of this parameter
# cannot be older than 30 days and is ignored if a pagination token is set.
# Default value is current time minus 30 days.
# @param [String] 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::AndroidpublisherV2::VoidedPurchasesListResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::AndroidpublisherV2::VoidedPurchasesListResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_purchase_voidedpurchases(package_name, end_time: nil, max_results: nil, start_index: nil, start_time: nil, token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:get, '{packageName}/purchases/voidedpurchases', options)
command.response_representation = Google::Apis::AndroidpublisherV2::VoidedPurchasesListResponse::Representation
command.response_class = Google::Apis::AndroidpublisherV2::VoidedPurchasesListResponse
command.params['packageName'] = package_name unless package_name.nil?
command.query['endTime'] = end_time unless end_time.nil?
command.query['maxResults'] = max_results unless max_results.nil?
command.query['startIndex'] = start_index unless start_index.nil?
command.query['startTime'] = start_time unless start_time.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
# Returns a single review.
# @param [String] package_name
# Unique identifier for the Android app for which we want reviews; for example, "
# com.spiffygame".
# @param [String] review_id
# @param [String] translation_language
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@ -2351,25 +2461,27 @@ module Google
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_review(package_name, review_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
def get_review(package_name, review_id, translation_language: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:get, '{packageName}/reviews/{reviewId}', options)
command.response_representation = Google::Apis::AndroidpublisherV2::Review::Representation
command.response_class = Google::Apis::AndroidpublisherV2::Review
command.params['packageName'] = package_name unless package_name.nil?
command.params['reviewId'] = review_id unless review_id.nil?
command.query['translationLanguage'] = translation_language unless translation_language.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['userIp'] = user_ip unless user_ip.nil?
execute_or_queue_command(command, &block)
end
# Returns a list of reviews.
# Returns a list of reviews. Only reviews from last week will be returned.
# @param [String] package_name
# Unique identifier for the Android app for which we want reviews; for example, "
# com.spiffygame".
# @param [Fixnum] max_results
# @param [Fixnum] start_index
# @param [String] token
# @param [String] translation_language
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@ -2391,7 +2503,7 @@ module Google
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_reviews(package_name, max_results: nil, start_index: nil, token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
def list_reviews(package_name, max_results: nil, start_index: nil, token: nil, translation_language: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:get, '{packageName}/reviews', options)
command.response_representation = Google::Apis::AndroidpublisherV2::ReviewsListResponse::Representation
command.response_class = Google::Apis::AndroidpublisherV2::ReviewsListResponse
@ -2399,6 +2511,7 @@ module Google
command.query['maxResults'] = max_results unless max_results.nil?
command.query['startIndex'] = start_index unless start_index.nil?
command.query['token'] = token unless token.nil?
command.query['translationLanguage'] = translation_language unless translation_language.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['userIp'] = user_ip unless user_ip.nil?

View File

@ -25,10 +25,16 @@ module Google
# @see https://cloud.google.com/appengine/docs/admin-api/
module AppengineV1beta5
VERSION = 'V1beta5'
REVISION = '20160802'
REVISION = '20170324'
# 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

File diff suppressed because it is too large Load Diff

View File

@ -22,6 +22,12 @@ module Google
module Apis
module AppengineV1beta5
class ListOperationsResponse
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class Operation
class Representation < Google::Apis::Core::JsonRepresentation; end
@ -34,12 +40,6 @@ module Google
include Google::Apis::Core::JsonObjectSupport
end
class ListOperationsResponse
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class Application
class Representation < Google::Apis::Core::JsonRepresentation; end
@ -52,6 +52,12 @@ module Google
include Google::Apis::Core::JsonObjectSupport
end
class IdentityAwareProxy
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class Version
class Representation < Google::Apis::Core::JsonRepresentation; end
@ -112,6 +118,12 @@ module Google
include Google::Apis::Core::JsonObjectSupport
end
class Volume
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class UrlMap
class Representation < Google::Apis::Core::JsonRepresentation; end
@ -184,6 +196,12 @@ module Google
include Google::Apis::Core::JsonObjectSupport
end
class EndpointsApiService
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class ListVersionsResponse
class Representation < Google::Apis::Core::JsonRepresentation; end
@ -238,6 +256,12 @@ module Google
include Google::Apis::Core::JsonObjectSupport
end
class OperationMetadataExperimental
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class OperationMetadata
class Representation < Google::Apis::Core::JsonRepresentation; end
@ -250,6 +274,12 @@ module Google
include Google::Apis::Core::JsonObjectSupport
end
class OperationMetadataV1Beta
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class OperationMetadataV1
class Representation < Google::Apis::Core::JsonRepresentation; end
@ -262,6 +292,15 @@ module Google
include Google::Apis::Core::JsonObjectSupport
end
class ListOperationsResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :operations, as: 'operations', class: Google::Apis::AppengineV1beta5::Operation, decorator: Google::Apis::AppengineV1beta5::Operation::Representation
property :next_page_token, as: 'nextPageToken'
end
end
class Operation
# @private
class Representation < Google::Apis::Core::JsonRepresentation
@ -283,15 +322,6 @@ module Google
end
end
class ListOperationsResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :operations, as: 'operations', class: Google::Apis::AppengineV1beta5::Operation, decorator: Google::Apis::AppengineV1beta5::Operation::Representation
property :next_page_token, as: 'nextPageToken'
end
end
class Application
# @private
class Representation < Google::Apis::Core::JsonRepresentation
@ -305,6 +335,8 @@ module Google
property :default_cookie_expiration, as: 'defaultCookieExpiration'
property :default_hostname, as: 'defaultHostname'
property :default_bucket, as: 'defaultBucket'
property :iap, as: 'iap', class: Google::Apis::AppengineV1beta5::IdentityAwareProxy, decorator: Google::Apis::AppengineV1beta5::IdentityAwareProxy::Representation
end
end
@ -317,6 +349,16 @@ module Google
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 Version
# @private
class Representation < Google::Apis::Core::JsonRepresentation
@ -358,6 +400,8 @@ module Google
property :nobuild_files_regex, as: 'nobuildFilesRegex'
property :deployment, as: 'deployment', class: Google::Apis::AppengineV1beta5::Deployment, decorator: Google::Apis::AppengineV1beta5::Deployment::Representation
property :endpoints_api_service, as: 'endpointsApiService', class: Google::Apis::AppengineV1beta5::EndpointsApiService, decorator: Google::Apis::AppengineV1beta5::EndpointsApiService::Representation
end
end
@ -440,6 +484,7 @@ module Google
collection :forwarded_ports, as: 'forwardedPorts'
property :instance_tag, as: 'instanceTag'
property :name, as: 'name'
property :subnetwork_name, as: 'subnetworkName'
end
end
@ -449,6 +494,17 @@ module Google
property :cpu, as: 'cpu'
property :disk_gb, as: 'diskGb'
property :memory_gb, as: 'memoryGb'
collection :volumes, as: 'volumes', class: Google::Apis::AppengineV1beta5::Volume, decorator: Google::Apis::AppengineV1beta5::Volume::Representation
end
end
class Volume
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :name, as: 'name'
property :volume_type, as: 'volumeType'
property :size_gb, as: 'sizeGb'
end
end
@ -573,6 +629,14 @@ module Google
end
end
class EndpointsApiService
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :name, as: 'name'
property :config_id, as: 'configId'
end
end
class ListVersionsResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
@ -627,6 +691,7 @@ module Google
property :memory_usage, as: 'memoryUsage'
property :vm_status, as: 'vmStatus'
property :vm_unlocked, as: 'vmUnlocked'
property :vm_ip, as: 'vmIp'
end
end
@ -642,6 +707,7 @@ module Google
class DebugInstanceRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :ssh_key, as: 'sshKey'
end
end
@ -664,6 +730,17 @@ module Google
end
end
class OperationMetadataExperimental
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :method_prop, as: 'method'
property :insert_time, as: 'insertTime'
property :end_time, as: 'endTime'
property :user, as: 'user'
property :target, as: 'target'
end
end
class OperationMetadata
# @private
class Representation < Google::Apis::Core::JsonRepresentation
@ -687,6 +764,19 @@ module Google
end
end
class OperationMetadataV1Beta
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :method_prop, as: 'method'
property :insert_time, as: 'insertTime'
property :end_time, as: 'endTime'
property :user, as: 'user'
property :target, as: 'target'
property :ephemeral_message, as: 'ephemeralMessage'
collection :warning, as: 'warning'
end
end
class OperationMetadataV1
# @private
class Representation < Google::Apis::Core::JsonRepresentation
@ -695,6 +785,8 @@ module Google
property :end_time, as: 'endTime'
property :user, as: 'user'
property :target, as: 'target'
property :ephemeral_message, as: 'ephemeralMessage'
collection :warning, as: 'warning'
end
end

View File

@ -46,11 +46,12 @@ module Google
super('https://appengine.googleapis.com/', '')
end
# Creates an App Engine application for a Google Cloud Platform project. This
# requires a project that excludes an App Engine application. For details about
# creating a project without an application, see the [Google Cloud Resource
# Manager create project topic](https://cloud.google.com/resource-manager/docs/
# creating-project).
# 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/python/console/).
# @param [Google::Apis::AppengineV1beta5::Application] application_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
@ -82,10 +83,10 @@ module Google
# Gets information about an application.
# @param [String] apps_id
# Part of `name`. Name of the application to get. Example: `apps/myapp`.
# Part of `name`. Name of the application to get. Example: apps/myapp.
# @param [Boolean] ensure_resources_exist
# Certain resources associated with an application are created on-demand.
# Controls whether these resources should be created when performing the `GET`
# Controls whether these resources should be created when performing the GET
# operation. If specified and any resources could not be created, the request
# will fail with an error code. Additionally, this parameter can cause the
# request to take longer to complete. Note: This parameter will be deprecated in
@ -118,6 +119,89 @@ module Google
execute_or_queue_command(command, &block)
end
# Updates the specified Application resource. You can update the following
# fields: auth_domain (https://cloud.google.com/appengine/docs/admin-api/
# reference/rest/v1beta5/apps#Application.FIELDS.auth_domain)
# default_cookie_expiration (https://cloud.google.com/appengine/docs/admin-api/
# reference/rest/v1beta5/apps#Application.FIELDS.default_cookie_expiration)
# @param [String] apps_id
# Part of `name`. Name of the Application resource to update. Example: apps/
# myapp.
# @param [Google::Apis::AppengineV1beta5::Application] application_object
# @param [String] 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::AppengineV1beta5::Operation] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::AppengineV1beta5::Operation]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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, mask: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:patch, 'v1beta5/apps/{appsId}', options)
command.request_representation = Google::Apis::AppengineV1beta5::Application::Representation
command.request_object = application_object
command.response_representation = Google::Apis::AppengineV1beta5::Operation::Representation
command.response_class = Google::Apis::AppengineV1beta5::Operation
command.params['appsId'] = apps_id unless apps_id.nil?
command.query['mask'] = mask unless 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 operations that match the specified filter in the request. If the server
# doesn't support this method, it returns UNIMPLEMENTED.NOTE: the name binding
# below allows API services to override the binding to use different resource
# name schemes, such as users/*/operations.
# @param [String] apps_id
# Part of `name`. The name of the operation collection.
# @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::AppengineV1beta5::ListOperationsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::AppengineV1beta5::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, 'v1beta5/apps/{appsId}/operations', options)
command.response_representation = Google::Apis::AppengineV1beta5::ListOperationsResponse::Representation
command.response_class = Google::Apis::AppengineV1beta5::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
# 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
@ -152,52 +236,10 @@ module Google
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 below allows API services to override the binding to use different
# resource name schemes, such as `users/*/operations`.
# @param [String] apps_id
# Part of `name`. The name of the operation collection.
# @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::AppengineV1beta5::ListOperationsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::AppengineV1beta5::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, 'v1beta5/apps/{appsId}/operations', options)
command.response_representation = Google::Apis::AppengineV1beta5::ListOperationsResponse::Representation
command.response_class = Google::Apis::AppengineV1beta5::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`.
# 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
@ -230,8 +272,8 @@ module Google
# 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`.
# 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
@ -264,7 +306,7 @@ module Google
# Lists all the services in the application.
# @param [String] apps_id
# Part of `name`. Name of the resource requested. Example: `apps/myapp`.
# Part of `name`. Name of the resource requested. Example: apps/myapp.
# @param [Fixnum] page_size
# Maximum results to return per page.
# @param [String] page_token
@ -300,25 +342,25 @@ module Google
# 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`.
# 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::AppengineV1beta5::Service] service_object
# @param [String] mask
# Standard field mask for the set of fields to be updated.
# @param [Boolean] migrate_traffic
# Set to `true` to gradually shift traffic from one version to another single
# version. By default, traffic is shifted immediately. For gradual traffic
# migration, the target version must be located within instances that are
# configured for both [warmup requests](https://cloud.google.com/appengine/docs/
# 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/v1beta5/apps.services.versions#inboundservicetype)
# and [automatic scaling](https://cloud.google.com/appengine/docs/admin-api/
# and automatic scaling (https://cloud.google.com/appengine/docs/admin-api/
# reference/rest/v1beta5/apps.services.versions#automaticscaling). You must
# specify the [`shardBy`](https://cloud.google.com/appengine/docs/admin-api/
# specify the shardBy (https://cloud.google.com/appengine/docs/admin-api/
# reference/rest/v1beta5/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.
# environment. For examples, see Migrating and Splitting Traffic (https://cloud.
# google.com/appengine/docs/admin-api/migrating-splitting-traffic).
# @param [String] fields
# Selector specifying which fields to include in a partial response.
@ -391,8 +433,8 @@ module Google
# Deletes an existing version.
# @param [String] apps_id
# Part of `name`. Name of the resource requested. Example: `apps/myapp/services/
# default/versions/v1`.
# 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
@ -426,17 +468,17 @@ module Google
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.
# 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`.
# 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.
# 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
@ -469,12 +511,12 @@ module Google
# Lists the versions of a service.
# @param [String] apps_id
# Part of `name`. Name of the resource requested. Example: `apps/myapp/services/
# default`.
# 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] view
# Controls the set of fields returned in the `List` response.
# Controls the set of fields returned in the List response.
# @param [Fixnum] page_size
# Maximum results to return per page.
# @param [String] page_token
@ -512,23 +554,23 @@ module Google
# 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/v1beta5/apps.services.versions#Version.FIELDS.
# resource uses: serving_status (https://cloud.google.com/appengine/docs/admin-
# api/reference/rest/v1beta5/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/v1beta5/apps.services.
# or run in the App Engine flexible environment. instance_class (https://cloud.
# google.com/appengine/docs/admin-api/reference/rest/v1beta5/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/v1beta5/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/
# App Engine standard environment. automatic_scaling.min_idle_instances (https://
# cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta5/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/v1beta5/apps.services.versions#Version.FIELDS.
# automatic_scaling): For Version resources that use automatic scaling and run
# in the App Engine standard environment.
# @param [String] apps_id
# Part of `name`. Name of the resource to update. Example: `apps/myapp/services/
# default/versions/1`.
# 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
@ -610,8 +652,8 @@ module Google
# 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`.
# 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
@ -648,10 +690,12 @@ module Google
execute_or_queue_command(command, &block)
end
# Lists the instances of a version.
# 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 `name`. Name of the resource requested. Example: `apps/myapp/services/
# default/versions/v1`.
# 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
@ -695,11 +739,11 @@ module Google
# 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
# 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`.
# 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

View File

@ -18,16 +18,16 @@ require 'google/apis/appsactivity_v1/representations.rb'
module Google
module Apis
# Google Apps Activity API
# G Suite Activity API
#
# Provides a historical view of activity.
#
# @see https://developers.google.com/google-apps/activity/
module AppsactivityV1
VERSION = 'V1'
REVISION = '20160805'
REVISION = '20170215'
# View the activity history of your Google Apps
# View the activity history of your Google apps
AUTH_ACTIVITY = 'https://www.googleapis.com/auth/activity'
# View and manage the files in your Google Drive

View File

@ -374,6 +374,12 @@ module Google
attr_accessor :is_deleted
alias_method :is_deleted?, :is_deleted
# Whether the user is the authenticated user.
# Corresponds to the JSON property `isMe`
# @return [Boolean]
attr_accessor :is_me
alias_method :is_me?, :is_me
# The displayable name of the user.
# Corresponds to the JSON property `name`
# @return [String]
@ -398,6 +404,7 @@ module Google
# Update properties of this object
def update!(**args)
@is_deleted = args[:is_deleted] if args.key?(:is_deleted)
@is_me = args[:is_me] if args.key?(:is_me)
@name = args[:name] if args.key?(:name)
@permission_id = args[:permission_id] if args.key?(:permission_id)
@photo = args[:photo] if args.key?(:photo)

View File

@ -197,6 +197,7 @@ module Google
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :is_deleted, as: 'isDeleted'
property :is_me, as: 'isMe'
property :name, as: 'name'
property :permission_id, as: 'permissionId'
property :photo, as: 'photo', class: Google::Apis::AppsactivityV1::Photo, decorator: Google::Apis::AppsactivityV1::Photo::Representation

View File

@ -20,7 +20,7 @@ require 'google/apis/errors'
module Google
module Apis
module AppsactivityV1
# Google Apps Activity API
# G Suite Activity API
#
# Provides a historical view of activity.
#

View File

@ -25,7 +25,7 @@ module Google
# @see https://developers.google.com/games/services/web/api/states
module AppstateV1
VERSION = 'V1'
REVISION = '20160810'
REVISION = '20170323'
# View and manage your data for this application
AUTH_APPSTATE = 'https://www.googleapis.com/auth/appstate'

View File

@ -25,7 +25,7 @@ module Google
# @see https://cloud.google.com/bigquery/
module BigqueryV2
VERSION = 'V2'
REVISION = '20160804'
REVISION = '20170319'
# View and manage your data in Google BigQuery
AUTH_BIGQUERY = 'https://www.googleapis.com/auth/bigquery'

View File

@ -334,13 +334,9 @@ module Google
# @return [String]
attr_accessor :kind
# [Experimental] The labels associated with this dataset. You can use these to
# organize and group your datasets. You can set this property when inserting or
# updating a dataset. Label keys and values can be no longer than 63 characters,
# can only contain letters, numeric characters, underscores and dashes.
# International characters are allowed. Label values are optional. Label keys
# must start with a letter and must be unique within a dataset. Both keys and
# values are additionally constrained to be <= 128 bytes in size.
# The labels associated with this dataset. You can use these to organize and
# group your datasets. You can set this property when inserting or updating a
# dataset. See Labeling Datasets for more information.
# Corresponds to the JSON property `labels`
# @return [Hash<String,String>]
attr_accessor :labels
@ -351,8 +347,8 @@ module Google
# @return [String]
attr_accessor :last_modified_time
# [Experimental] The geographic location where the dataset should reside.
# Possible values include EU and US. The default value is US.
# The geographic location where the dataset should reside. Possible values
# include EU and US. The default value is US.
# Corresponds to the JSON property `location`
# @return [String]
attr_accessor :location
@ -511,8 +507,8 @@ module Google
# @return [String]
attr_accessor :kind
# [Experimental] The labels associated with this dataset. You can use these to
# organize and group your datasets.
# The labels associated with this dataset. You can use these to organize and
# group your datasets.
# Corresponds to the JSON property `labels`
# @return [Hash<String,String>]
attr_accessor :labels
@ -641,6 +637,11 @@ module Google
# @return [String]
attr_accessor :records_written
# Current status for the stage.
# Corresponds to the JSON property `status`
# @return [String]
attr_accessor :status
# List of operations within the stage in dependency order (approximately
# chronological).
# Corresponds to the JSON property `steps`
@ -681,6 +682,7 @@ module Google
@read_ratio_max = args[:read_ratio_max] if args.key?(:read_ratio_max)
@records_read = args[:records_read] if args.key?(:records_read)
@records_written = args[:records_written] if args.key?(:records_written)
@status = args[:status] if args.key?(:status)
@steps = args[:steps] if args.key?(:steps)
@wait_ratio_avg = args[:wait_ratio_avg] if args.key?(:wait_ratio_avg)
@wait_ratio_max = args[:wait_ratio_max] if args.key?(:wait_ratio_max)
@ -718,8 +720,8 @@ module Google
class ExternalDataConfiguration
include Google::Apis::Core::Hashable
# [Experimental] Try to detect schema and format options automatically. Any
# option specified explicitly will be honored.
# Try to detect schema and format options automatically. Any option specified
# explicitly will be honored.
# Corresponds to the JSON property `autodetect`
# @return [Boolean]
attr_accessor :autodetect
@ -780,10 +782,8 @@ module Google
# [Required] The data format. For CSV files, specify "CSV". For Google sheets,
# specify "GOOGLE_SHEETS". For newline-delimited JSON, specify "
# NEWLINE_DELIMITED_JSON". For Avro files, specify "AVRO". For Google Cloud
# Datastore backups, specify "DATASTORE_BACKUP". [Experimental] For Google Cloud
# Bigtable, specify "BIGTABLE". Please note that reading from Google Cloud
# Bigtable is experimental and has to be enabled for your project. Please
# contact Google Cloud Support to enable this for your project.
# Datastore backups, specify "DATASTORE_BACKUP". [Beta] For Google Cloud
# Bigtable, specify "BIGTABLE".
# Corresponds to the JSON property `sourceFormat`
# @return [String]
attr_accessor :source_format
@ -862,8 +862,8 @@ module Google
# @return [String]
attr_accessor :kind
# [Output-only, Experimental] The number of rows affected by a DML statement.
# Present only for DML statements INSERT, UPDATE or DELETE.
# [Output-only] The number of rows affected by a DML statement. Present only for
# DML statements INSERT, UPDATE or DELETE.
# Corresponds to the JSON property `numDmlAffectedRows`
# @return [String]
attr_accessor :num_dml_affected_rows
@ -1065,6 +1065,16 @@ module Google
# @return [Google::Apis::BigqueryV2::JobConfigurationExtract]
attr_accessor :extract
# [Experimental] The labels associated with this job. You can use these to
# organize and group your jobs. Label keys and values can be no longer than 63
# characters, can only contain lowercase letters, numeric characters,
# underscores and dashes. International characters are allowed. Label values are
# optional. Label keys must start with a letter and each label in the list must
# have a different key.
# Corresponds to the JSON property `labels`
# @return [Hash<String,String>]
attr_accessor :labels
# [Pick one] Configures a load job.
# Corresponds to the JSON property `load`
# @return [Google::Apis::BigqueryV2::JobConfigurationLoad]
@ -1084,6 +1094,7 @@ module Google
@copy = args[:copy] if args.key?(:copy)
@dry_run = args[:dry_run] if args.key?(:dry_run)
@extract = args[:extract] if args.key?(:extract)
@labels = args[:labels] if args.key?(:labels)
@load = args[:load] if args.key?(:load)
@query = args[:query] if args.key?(:query)
end
@ -1172,8 +1183,8 @@ module Google
attr_accessor :allow_quoted_newlines
alias_method :allow_quoted_newlines?, :allow_quoted_newlines
# [Experimental] Indicates if we should automatically infer the options and
# schema for CSV and JSON sources.
# Indicates if we should automatically infer the options and schema for CSV and
# JSON sources.
# Corresponds to the JSON property `autodetect`
# @return [Boolean]
attr_accessor :autodetect
@ -1232,12 +1243,21 @@ module Google
# @return [Fixnum]
attr_accessor :max_bad_records
# [Experimental] If sourceFormat is set to "DATASTORE_BACKUP", indicates which
# entity properties to load into BigQuery from a Cloud Datastore backup.
# Property names are case sensitive and must be top-level properties. If no
# properties are specified, BigQuery loads all properties. If any named property
# isn't found in the Cloud Datastore backup, an invalid error is returned in the
# job result.
# [Optional] Specifies a string that represents a null value in a CSV file. For
# example, if you specify "\N", BigQuery interprets "\N" as a null value when
# loading a CSV file. The default value is the empty string. If you set this
# property to a custom value, BigQuery still interprets the empty string as a
# null value for all data types except for STRING and BYTE. For STRING and BYTE
# columns, BigQuery interprets the empty string as an empty value.
# Corresponds to the JSON property `nullMarker`
# @return [String]
attr_accessor :null_marker
# If sourceFormat is set to "DATASTORE_BACKUP", indicates which entity
# properties to load into BigQuery from a Cloud Datastore backup. Property names
# are case sensitive and must be top-level properties. If no properties are
# specified, BigQuery loads all properties. If any named property isn't found in
# the Cloud Datastore backup, an invalid error is returned in the job result.
# Corresponds to the JSON property `projectionFields`
# @return [Array<String>]
attr_accessor :projection_fields
@ -1271,6 +1291,18 @@ module Google
# @return [String]
attr_accessor :schema_inline_format
# [Experimental] Allows the schema of the desitination table to be updated as a
# side effect of the load job. Schema update options are supported in two cases:
# when writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE
# and the destination table is a partition of a table, specified by partition
# decorators. For normal tables, WRITE_TRUNCATE will always overwrite the schema.
# One or more of the following values are specified: ALLOW_FIELD_ADDITION:
# allow adding a nullable field to the schema. ALLOW_FIELD_RELAXATION: allow
# relaxing a required field in the original schema to nullable.
# Corresponds to the JSON property `schemaUpdateOptions`
# @return [Array<String>]
attr_accessor :schema_update_options
# [Optional] The number of rows at the top of a CSV file that BigQuery will skip
# when loading the data. The default value is 0. This property is useful if you
# have header rows in the file that should be skipped.
@ -1320,11 +1352,13 @@ module Google
@field_delimiter = args[:field_delimiter] if args.key?(:field_delimiter)
@ignore_unknown_values = args[:ignore_unknown_values] if args.key?(:ignore_unknown_values)
@max_bad_records = args[:max_bad_records] if args.key?(:max_bad_records)
@null_marker = args[:null_marker] if args.key?(:null_marker)
@projection_fields = args[:projection_fields] if args.key?(:projection_fields)
@quote = args[:quote] if args.key?(:quote)
@schema = args[:schema] if args.key?(:schema)
@schema_inline = args[:schema_inline] if args.key?(:schema_inline)
@schema_inline_format = args[:schema_inline_format] if args.key?(:schema_inline_format)
@schema_update_options = args[:schema_update_options] if args.key?(:schema_update_options)
@skip_leading_rows = args[:skip_leading_rows] if args.key?(:skip_leading_rows)
@source_format = args[:source_format] if args.key?(:source_format)
@source_uris = args[:source_uris] if args.key?(:source_uris)
@ -1386,6 +1420,12 @@ module Google
# @return [String]
attr_accessor :maximum_bytes_billed
# Standard SQL only. Set to POSITIONAL to use positional (?) query parameters or
# to NAMED to use named (@myparam) query parameters in this query.
# Corresponds to the JSON property `parameterMode`
# @return [String]
attr_accessor :parameter_mode
# [Deprecated] This property is deprecated.
# Corresponds to the JSON property `preserveNulls`
# @return [Boolean]
@ -1403,6 +1443,24 @@ module Google
# @return [String]
attr_accessor :query
# Query parameters for standard SQL queries.
# Corresponds to the JSON property `queryParameters`
# @return [Array<Google::Apis::BigqueryV2::QueryParameter>]
attr_accessor :query_parameters
# [Experimental] Allows the schema of the destination table to be updated as a
# side effect of the query job. Schema update options are supported in two cases:
# when writeDisposition is WRITE_APPEND; when writeDisposition is
# WRITE_TRUNCATE and the destination table is a partition of a table, specified
# by partition decorators. For normal tables, WRITE_TRUNCATE will always
# overwrite the schema. One or more of the following values are specified:
# ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema.
# ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema
# to nullable.
# Corresponds to the JSON property `schemaUpdateOptions`
# @return [Array<String>]
attr_accessor :schema_update_options
# [Optional] If querying an external data source outside of BigQuery, describes
# the data format, location and other properties of the data source. By defining
# these properties, the data source can then be queried as if it were a standard
@ -1411,12 +1469,11 @@ module Google
# @return [Hash<String,Google::Apis::BigqueryV2::ExternalDataConfiguration>]
attr_accessor :table_definitions
# [Experimental] Specifies whether to use BigQuery's legacy SQL dialect for this
# query. The default value is true. If set to false, the query will use BigQuery'
# s standard SQL: https://cloud.google.com/bigquery/sql-reference/ When
# useLegacySql is set to false, the values of allowLargeResults and
# flattenResults are ignored; query will be run as if allowLargeResults is true
# and flattenResults is false.
# Specifies whether to use BigQuery's legacy SQL dialect for this query. The
# default value is true. If set to false, the query will use BigQuery's standard
# SQL: https://cloud.google.com/bigquery/sql-reference/ When useLegacySql is set
# to false, the values of allowLargeResults and flattenResults are ignored;
# query will be run as if allowLargeResults is true and flattenResults is false.
# Corresponds to the JSON property `useLegacySql`
# @return [Boolean]
attr_accessor :use_legacy_sql
@ -1431,7 +1488,7 @@ module Google
attr_accessor :use_query_cache
alias_method :use_query_cache?, :use_query_cache
# [Experimental] Describes user-defined function resources used in the query.
# Describes user-defined function resources used in the query.
# Corresponds to the JSON property `userDefinedFunctionResources`
# @return [Array<Google::Apis::BigqueryV2::UserDefinedFunctionResource>]
attr_accessor :user_defined_function_resources
@ -1461,9 +1518,12 @@ module Google
@flatten_results = args[:flatten_results] if args.key?(:flatten_results)
@maximum_billing_tier = args[:maximum_billing_tier] if args.key?(:maximum_billing_tier)
@maximum_bytes_billed = args[:maximum_bytes_billed] if args.key?(:maximum_bytes_billed)
@parameter_mode = args[:parameter_mode] if args.key?(:parameter_mode)
@preserve_nulls = args[:preserve_nulls] if args.key?(:preserve_nulls)
@priority = args[:priority] if args.key?(:priority)
@query = args[:query] if args.key?(:query)
@query_parameters = args[:query_parameters] if args.key?(:query_parameters)
@schema_update_options = args[:schema_update_options] if args.key?(:schema_update_options)
@table_definitions = args[:table_definitions] if args.key?(:table_definitions)
@use_legacy_sql = args[:use_legacy_sql] if args.key?(:use_legacy_sql)
@use_query_cache = args[:use_query_cache] if args.key?(:use_query_cache)
@ -1735,13 +1795,13 @@ module Google
attr_accessor :cache_hit
alias_method :cache_hit?, :cache_hit
# [Output-only, Experimental] The number of rows affected by a DML statement.
# Present only for DML statements INSERT, UPDATE or DELETE.
# [Output-only] The number of rows affected by a DML statement. Present only for
# DML statements INSERT, UPDATE or DELETE.
# Corresponds to the JSON property `numDmlAffectedRows`
# @return [String]
attr_accessor :num_dml_affected_rows
# [Output-only, Experimental] Describes execution plan for the query.
# [Output-only] Describes execution plan for the query.
# Corresponds to the JSON property `queryPlan`
# @return [Array<Google::Apis::BigqueryV2::ExplainQueryStage>]
attr_accessor :query_plan
@ -1758,6 +1818,11 @@ module Google
# @return [Google::Apis::BigqueryV2::TableSchema]
attr_accessor :schema
# [Output-only, Experimental] The type of query statement, if valid.
# Corresponds to the JSON property `statementType`
# @return [String]
attr_accessor :statement_type
# [Output-only] Total bytes billed for the job.
# Corresponds to the JSON property `totalBytesBilled`
# @return [String]
@ -1768,6 +1833,12 @@ module Google
# @return [String]
attr_accessor :total_bytes_processed
# [Output-only, Experimental] Standard SQL only: list of undeclared query
# parameters detected during a dry run validation.
# Corresponds to the JSON property `undeclaredQueryParameters`
# @return [Array<Google::Apis::BigqueryV2::QueryParameter>]
attr_accessor :undeclared_query_parameters
def initialize(**args)
update!(**args)
end
@ -1780,8 +1851,10 @@ module Google
@query_plan = args[:query_plan] if args.key?(:query_plan)
@referenced_tables = args[:referenced_tables] if args.key?(:referenced_tables)
@schema = args[:schema] if args.key?(:schema)
@statement_type = args[:statement_type] if args.key?(:statement_type)
@total_bytes_billed = args[:total_bytes_billed] if args.key?(:total_bytes_billed)
@total_bytes_processed = args[:total_bytes_processed] if args.key?(:total_bytes_processed)
@undeclared_query_parameters = args[:undeclared_query_parameters] if args.key?(:undeclared_query_parameters)
end
end
@ -1984,6 +2057,132 @@ module Google
end
end
#
class QueryParameter
include Google::Apis::Core::Hashable
# [Optional] If unset, this is a positional parameter. Otherwise, should be
# unique within a query.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# [Required] The type of this parameter.
# Corresponds to the JSON property `parameterType`
# @return [Google::Apis::BigqueryV2::QueryParameterType]
attr_accessor :parameter_type
# [Required] The value of this parameter.
# Corresponds to the JSON property `parameterValue`
# @return [Google::Apis::BigqueryV2::QueryParameterValue]
attr_accessor :parameter_value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@name = args[:name] if args.key?(:name)
@parameter_type = args[:parameter_type] if args.key?(:parameter_type)
@parameter_value = args[:parameter_value] if args.key?(:parameter_value)
end
end
#
class QueryParameterType
include Google::Apis::Core::Hashable
# [Optional] The type of the array's elements, if this is an array.
# Corresponds to the JSON property `arrayType`
# @return [Google::Apis::BigqueryV2::QueryParameterType]
attr_accessor :array_type
# [Optional] The types of the fields of this struct, in order, if this is a
# struct.
# Corresponds to the JSON property `structTypes`
# @return [Array<Google::Apis::BigqueryV2::QueryParameterType::StructType>]
attr_accessor :struct_types
# [Required] The top level type of this field.
# Corresponds to the JSON property `type`
# @return [String]
attr_accessor :type
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@array_type = args[:array_type] if args.key?(:array_type)
@struct_types = args[:struct_types] if args.key?(:struct_types)
@type = args[:type] if args.key?(:type)
end
#
class StructType
include Google::Apis::Core::Hashable
# [Optional] Human-oriented description of the field.
# Corresponds to the JSON property `description`
# @return [String]
attr_accessor :description
# [Optional] The name of this field.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# [Required] The type of this field.
# Corresponds to the JSON property `type`
# @return [Google::Apis::BigqueryV2::QueryParameterType]
attr_accessor :type
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@description = args[:description] if args.key?(:description)
@name = args[:name] if args.key?(:name)
@type = args[:type] if args.key?(:type)
end
end
end
#
class QueryParameterValue
include Google::Apis::Core::Hashable
# [Optional] The array values, if this is an array type.
# Corresponds to the JSON property `arrayValues`
# @return [Array<Google::Apis::BigqueryV2::QueryParameterValue>]
attr_accessor :array_values
# [Optional] The struct field values, in order of the struct type's declaration.
# Corresponds to the JSON property `structValues`
# @return [Hash<String,Google::Apis::BigqueryV2::QueryParameterValue>]
attr_accessor :struct_values
# [Optional] The value of this value, if a simple scalar 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)
@array_values = args[:array_values] if args.key?(:array_values)
@struct_values = args[:struct_values] if args.key?(:struct_values)
@value = args[:value] if args.key?(:value)
end
end
#
class QueryRequest
include Google::Apis::Core::Hashable
@ -2018,6 +2217,12 @@ module Google
# @return [Fixnum]
attr_accessor :max_results
# Standard SQL only. Set to POSITIONAL to use positional (?) query parameters or
# to NAMED to use named (@myparam) query parameters in this query.
# Corresponds to the JSON property `parameterMode`
# @return [String]
attr_accessor :parameter_mode
# [Deprecated] This property is deprecated.
# Corresponds to the JSON property `preserveNulls`
# @return [Boolean]
@ -2031,6 +2236,11 @@ module Google
# @return [String]
attr_accessor :query
# Query parameters for Standard SQL queries.
# Corresponds to the JSON property `queryParameters`
# @return [Array<Google::Apis::BigqueryV2::QueryParameter>]
attr_accessor :query_parameters
# [Optional] How long to wait for the query to complete, in milliseconds, before
# the request times out and returns. Note that this is only a timeout for the
# request, not the query. If the query takes longer to run than the timeout
@ -2041,12 +2251,11 @@ module Google
# @return [Fixnum]
attr_accessor :timeout_ms
# [Experimental] Specifies whether to use BigQuery's legacy SQL dialect for this
# query. The default value is true. If set to false, the query will use BigQuery'
# s standard SQL: https://cloud.google.com/bigquery/sql-reference/ When
# useLegacySql is set to false, the values of allowLargeResults and
# flattenResults are ignored; query will be run as if allowLargeResults is true
# and flattenResults is false.
# Specifies whether to use BigQuery's legacy SQL dialect for this query. The
# default value is true. If set to false, the query will use BigQuery's standard
# SQL: https://cloud.google.com/bigquery/sql-reference/ When useLegacySql is set
# to false, the values of allowLargeResults and flattenResults are ignored;
# query will be run as if allowLargeResults is true and flattenResults is false.
# Corresponds to the JSON property `useLegacySql`
# @return [Boolean]
attr_accessor :use_legacy_sql
@ -2070,8 +2279,10 @@ module Google
@dry_run = args[:dry_run] if args.key?(:dry_run)
@kind = args[:kind] if args.key?(:kind)
@max_results = args[:max_results] if args.key?(:max_results)
@parameter_mode = args[:parameter_mode] if args.key?(:parameter_mode)
@preserve_nulls = args[:preserve_nulls] if args.key?(:preserve_nulls)
@query = args[:query] if args.key?(:query)
@query_parameters = args[:query_parameters] if args.key?(:query_parameters)
@timeout_ms = args[:timeout_ms] if args.key?(:timeout_ms)
@use_legacy_sql = args[:use_legacy_sql] if args.key?(:use_legacy_sql)
@use_query_cache = args[:use_query_cache] if args.key?(:use_query_cache)
@ -2116,8 +2327,8 @@ module Google
# @return [String]
attr_accessor :kind
# [Output-only, Experimental] The number of rows affected by a DML statement.
# Present only for DML statements INSERT, UPDATE or DELETE.
# [Output-only] The number of rows affected by a DML statement. Present only for
# DML statements INSERT, UPDATE or DELETE.
# Corresponds to the JSON property `numDmlAffectedRows`
# @return [String]
attr_accessor :num_dml_affected_rows
@ -2254,6 +2465,16 @@ module Google
# @return [String]
attr_accessor :kind
# [Experimental] The labels associated with this table. You can use these to
# organize and group your tables. Label keys and values can be no longer than 63
# characters, can only contain lowercase letters, numeric characters,
# underscores and dashes. International characters are allowed. Label values are
# optional. Label keys must start with a letter and each label in the list must
# have a different key.
# Corresponds to the JSON property `labels`
# @return [Hash<String,String>]
attr_accessor :labels
# [Output-only] The time when this table was last modified, in milliseconds
# since the epoch.
# Corresponds to the JSON property `lastModifiedTime`
@ -2338,6 +2559,7 @@ module Google
@friendly_name = args[:friendly_name] if args.key?(:friendly_name)
@id = args[:id] if args.key?(:id)
@kind = args[:kind] if args.key?(:kind)
@labels = args[:labels] if args.key?(:labels)
@last_modified_time = args[:last_modified_time] if args.key?(:last_modified_time)
@location = args[:location] if args.key?(:location)
@num_bytes = args[:num_bytes] if args.key?(:num_bytes)
@ -2576,8 +2798,9 @@ module Google
attr_accessor :name
# [Required] The field data type. Possible values include STRING, BYTES, INTEGER,
# FLOAT, BOOLEAN, TIMESTAMP or RECORD (where RECORD indicates that the field
# contains a nested schema).
# INT64 (same as INTEGER), FLOAT, FLOAT64 (same as FLOAT), BOOLEAN, BOOL (same
# as BOOLEAN), TIMESTAMP, DATE, TIME, DATETIME, RECORD (where RECORD indicates
# that the field contains a nested schema) or STRUCT (same as RECORD).
# Corresponds to the JSON property `type`
# @return [String]
attr_accessor :type
@ -2657,6 +2880,12 @@ module Google
# @return [String]
attr_accessor :kind
# [Experimental] The labels associated with this table. You can use these to
# organize and group your tables.
# Corresponds to the JSON property `labels`
# @return [Hash<String,String>]
attr_accessor :labels
# A reference uniquely identifying the table.
# Corresponds to the JSON property `tableReference`
# @return [Google::Apis::BigqueryV2::TableReference]
@ -2667,6 +2896,11 @@ module Google
# @return [String]
attr_accessor :type
# Additional details for a view.
# Corresponds to the JSON property `view`
# @return [Google::Apis::BigqueryV2::TableList::Table::View]
attr_accessor :view
def initialize(**args)
update!(**args)
end
@ -2676,8 +2910,30 @@ module Google
@friendly_name = args[:friendly_name] if args.key?(:friendly_name)
@id = args[:id] if args.key?(:id)
@kind = args[:kind] if args.key?(:kind)
@labels = args[:labels] if args.key?(:labels)
@table_reference = args[:table_reference] if args.key?(:table_reference)
@type = args[:type] if args.key?(:type)
@view = args[:view] if args.key?(:view)
end
# Additional details for a view.
class View
include Google::Apis::Core::Hashable
# True if view is defined in legacy SQL dialect, false if in standard SQL.
# Corresponds to the JSON property `useLegacySql`
# @return [Boolean]
attr_accessor :use_legacy_sql
alias_method :use_legacy_sql?, :use_legacy_sql
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@use_legacy_sql = args[:use_legacy_sql] if args.key?(:use_legacy_sql)
end
end
end
end
@ -2816,16 +3072,16 @@ module Google
# @return [String]
attr_accessor :query
# [Experimental] Specifies whether to use BigQuery's legacy SQL for this view.
# The default value is true. If set to false, the view will use BigQuery's
# standard SQL: https://cloud.google.com/bigquery/sql-reference/ Queries and
# views that reference this view must use the same flag value.
# Specifies whether to use BigQuery's legacy SQL for this view. The default
# value is true. If set to false, the view will use BigQuery's standard SQL:
# https://cloud.google.com/bigquery/sql-reference/ Queries and views that
# reference this view must use the same flag value.
# Corresponds to the JSON property `useLegacySql`
# @return [Boolean]
attr_accessor :use_legacy_sql
alias_method :use_legacy_sql?, :use_legacy_sql
# [Experimental] Describes user-defined function resources used in the query.
# Describes user-defined function resources used in the query.
# Corresponds to the JSON property `userDefinedFunctionResources`
# @return [Array<Google::Apis::BigqueryV2::UserDefinedFunctionResource>]
attr_accessor :user_defined_function_resources

View File

@ -220,6 +220,30 @@ module Google
include Google::Apis::Core::JsonObjectSupport
end
class QueryParameter
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class QueryParameterType
class Representation < Google::Apis::Core::JsonRepresentation; end
class StructType
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
include Google::Apis::Core::JsonObjectSupport
end
class QueryParameterValue
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class QueryRequest
class Representation < Google::Apis::Core::JsonRepresentation; end
@ -291,6 +315,12 @@ module Google
class Table
class Representation < Google::Apis::Core::JsonRepresentation; end
class View
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
include Google::Apis::Core::JsonObjectSupport
end
@ -466,6 +496,7 @@ module Google
property :read_ratio_max, as: 'readRatioMax'
property :records_read, as: 'recordsRead'
property :records_written, as: 'recordsWritten'
property :status, as: 'status'
collection :steps, as: 'steps', class: Google::Apis::BigqueryV2::ExplainQueryStep, decorator: Google::Apis::BigqueryV2::ExplainQueryStep::Representation
property :wait_ratio_avg, as: 'waitRatioAvg'
@ -568,6 +599,7 @@ module Google
property :dry_run, as: 'dryRun'
property :extract, as: 'extract', class: Google::Apis::BigqueryV2::JobConfigurationExtract, decorator: Google::Apis::BigqueryV2::JobConfigurationExtract::Representation
hash :labels, as: 'labels'
property :load, as: 'load', class: Google::Apis::BigqueryV2::JobConfigurationLoad, decorator: Google::Apis::BigqueryV2::JobConfigurationLoad::Representation
property :query, as: 'query', class: Google::Apis::BigqueryV2::JobConfigurationQuery, decorator: Google::Apis::BigqueryV2::JobConfigurationQuery::Representation
@ -602,12 +634,14 @@ module Google
property :field_delimiter, as: 'fieldDelimiter'
property :ignore_unknown_values, as: 'ignoreUnknownValues'
property :max_bad_records, as: 'maxBadRecords'
property :null_marker, as: 'nullMarker'
collection :projection_fields, as: 'projectionFields'
property :quote, as: 'quote'
property :schema, as: 'schema', class: Google::Apis::BigqueryV2::TableSchema, decorator: Google::Apis::BigqueryV2::TableSchema::Representation
property :schema_inline, as: 'schemaInline'
property :schema_inline_format, as: 'schemaInlineFormat'
collection :schema_update_options, as: 'schemaUpdateOptions'
property :skip_leading_rows, as: 'skipLeadingRows'
property :source_format, as: 'sourceFormat'
collection :source_uris, as: 'sourceUris'
@ -627,9 +661,13 @@ module Google
property :flatten_results, as: 'flattenResults'
property :maximum_billing_tier, as: 'maximumBillingTier'
property :maximum_bytes_billed, as: 'maximumBytesBilled'
property :parameter_mode, as: 'parameterMode'
property :preserve_nulls, as: 'preserveNulls'
property :priority, as: 'priority'
property :query, as: 'query'
collection :query_parameters, as: 'queryParameters', class: Google::Apis::BigqueryV2::QueryParameter, decorator: Google::Apis::BigqueryV2::QueryParameter::Representation
collection :schema_update_options, as: 'schemaUpdateOptions'
hash :table_definitions, as: 'tableDefinitions', class: Google::Apis::BigqueryV2::ExternalDataConfiguration, decorator: Google::Apis::BigqueryV2::ExternalDataConfiguration::Representation
property :use_legacy_sql, as: 'useLegacySql'
@ -721,8 +759,11 @@ module Google
property :schema, as: 'schema', class: Google::Apis::BigqueryV2::TableSchema, decorator: Google::Apis::BigqueryV2::TableSchema::Representation
property :statement_type, as: 'statementType'
property :total_bytes_billed, as: 'totalBytesBilled'
property :total_bytes_processed, as: 'totalBytesProcessed'
collection :undeclared_query_parameters, as: 'undeclaredQueryParameters', class: Google::Apis::BigqueryV2::QueryParameter, decorator: Google::Apis::BigqueryV2::QueryParameter::Representation
end
end
@ -785,6 +826,49 @@ module Google
end
end
class QueryParameter
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :name, as: 'name'
property :parameter_type, as: 'parameterType', class: Google::Apis::BigqueryV2::QueryParameterType, decorator: Google::Apis::BigqueryV2::QueryParameterType::Representation
property :parameter_value, as: 'parameterValue', class: Google::Apis::BigqueryV2::QueryParameterValue, decorator: Google::Apis::BigqueryV2::QueryParameterValue::Representation
end
end
class QueryParameterType
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :array_type, as: 'arrayType', class: Google::Apis::BigqueryV2::QueryParameterType, decorator: Google::Apis::BigqueryV2::QueryParameterType::Representation
collection :struct_types, as: 'structTypes', class: Google::Apis::BigqueryV2::QueryParameterType::StructType, decorator: Google::Apis::BigqueryV2::QueryParameterType::StructType::Representation
property :type, as: 'type'
end
class StructType
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :description, as: 'description'
property :name, as: 'name'
property :type, as: 'type', class: Google::Apis::BigqueryV2::QueryParameterType, decorator: Google::Apis::BigqueryV2::QueryParameterType::Representation
end
end
end
class QueryParameterValue
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :array_values, as: 'arrayValues', class: Google::Apis::BigqueryV2::QueryParameterValue, decorator: Google::Apis::BigqueryV2::QueryParameterValue::Representation
hash :struct_values, as: 'structValues', class: Google::Apis::BigqueryV2::QueryParameterValue, decorator: Google::Apis::BigqueryV2::QueryParameterValue::Representation
property :value, as: 'value'
end
end
class QueryRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation
@ -793,8 +877,11 @@ module Google
property :dry_run, as: 'dryRun'
property :kind, as: 'kind'
property :max_results, as: 'maxResults'
property :parameter_mode, as: 'parameterMode'
property :preserve_nulls, as: 'preserveNulls'
property :query, as: 'query'
collection :query_parameters, as: 'queryParameters', class: Google::Apis::BigqueryV2::QueryParameter, decorator: Google::Apis::BigqueryV2::QueryParameter::Representation
property :timeout_ms, as: 'timeoutMs'
property :use_legacy_sql, as: 'useLegacySql'
property :use_query_cache, as: 'useQueryCache'
@ -843,6 +930,7 @@ module Google
property :friendly_name, as: 'friendlyName'
property :id, as: 'id'
property :kind, as: 'kind'
hash :labels, as: 'labels'
property :last_modified_time, as: 'lastModifiedTime'
property :location, as: 'location'
property :num_bytes, as: 'numBytes'
@ -949,9 +1037,19 @@ module Google
property :friendly_name, as: 'friendlyName'
property :id, as: 'id'
property :kind, as: 'kind'
hash :labels, as: 'labels'
property :table_reference, as: 'tableReference', class: Google::Apis::BigqueryV2::TableReference, decorator: Google::Apis::BigqueryV2::TableReference::Representation
property :type, as: 'type'
property :view, as: 'view', class: Google::Apis::BigqueryV2::TableList::Table::View, decorator: Google::Apis::BigqueryV2::TableList::Table::View::Representation
end
class View
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :use_legacy_sql, as: 'useLegacySql'
end
end
end
end

View File

@ -179,10 +179,9 @@ module Google
# Whether to list all datasets, including hidden ones
# @param [String] filter
# An expression for filtering the results of the request by label. The syntax is
# "labels.[:]". Multiple filters can be ANDed together by connecting with a
# space. Example: "labels.department:receiving labels.active". See https://cloud.
# google.com/bigquery/docs/labeling-datasets#filtering_datasets_using_labels for
# details.
# "labels.<name>[:<value>]". Multiple filters can be ANDed together by
# connecting with a space. Example: "labels.department:receiving labels.active".
# See Filtering datasets using labels for details.
# @param [Fixnum] max_results
# The maximum number of results to return
# @param [String] page_token
@ -339,7 +338,7 @@ module Google
# @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, job_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:post, 'project/{projectId}/jobs/{jobId}/cancel', options)
command = make_simple_command(:post, 'projects/{projectId}/jobs/{jobId}/cancel', options)
command.response_representation = Google::Apis::BigqueryV2::CancelJobResponse::Representation
command.response_class = Google::Apis::BigqueryV2::CancelJobResponse
command.params['projectId'] = project_id unless project_id.nil?
@ -677,6 +676,9 @@ module Google
# Maximum number of results to return
# @param [String] page_token
# Page token, returned by a previous call, identifying the result set
# @param [String] selected_fields
# List of fields to return (comma-separated). If unspecified, all fields are
# returned
# @param [String] start_index
# Zero-based index of the starting row to read
# @param [String] fields
@ -700,7 +702,7 @@ module Google
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_table_data(project_id, dataset_id, table_id, max_results: nil, page_token: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
def list_table_data(project_id, dataset_id, table_id, max_results: nil, page_token: nil, selected_fields: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:get, 'projects/{projectId}/datasets/{datasetId}/tables/{tableId}/data', options)
command.response_representation = Google::Apis::BigqueryV2::TableDataList::Representation
command.response_class = Google::Apis::BigqueryV2::TableDataList
@ -709,6 +711,7 @@ module Google
command.params['tableId'] = table_id unless table_id.nil?
command.query['maxResults'] = max_results unless max_results.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['selectedFields'] = selected_fields unless selected_fields.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?
@ -765,6 +768,9 @@ module Google
# Dataset ID of the requested table
# @param [String] table_id
# Table ID of the requested table
# @param [String] selected_fields
# List of fields to return (comma-separated). If unspecified, all fields are
# returned
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@ -786,13 +792,14 @@ module Google
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_table(project_id, dataset_id, table_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
def get_table(project_id, dataset_id, table_id, selected_fields: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:get, 'projects/{projectId}/datasets/{datasetId}/tables/{tableId}', options)
command.response_representation = Google::Apis::BigqueryV2::Table::Representation
command.response_class = Google::Apis::BigqueryV2::Table
command.params['projectId'] = project_id unless project_id.nil?
command.params['datasetId'] = dataset_id unless dataset_id.nil?
command.params['tableId'] = table_id unless table_id.nil?
command.query['selectedFields'] = selected_fields unless selected_fields.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['userIp'] = user_ip unless user_ip.nil?

View File

@ -25,7 +25,7 @@ module Google
# @see https://developers.google.com/books/docs/v1/getting_started
module BooksV1
VERSION = 'V1'
REVISION = '20160629'
REVISION = '20161206'
# Manage your books
AUTH_BOOKS = 'https://www.googleapis.com/auth/books'

View File

@ -2026,6 +2026,11 @@ module Google
# @return [String]
attr_accessor :kind
#
# Corresponds to the JSON property `notificationGroup`
# @return [String]
attr_accessor :notification_group
#
# Corresponds to the JSON property `notification_type`
# @return [String]
@ -2070,6 +2075,7 @@ module Google
@dont_show_notification = args[:dont_show_notification] if args.key?(:dont_show_notification)
@icon_url = args[:icon_url] if args.key?(:icon_url)
@kind = args[:kind] if args.key?(:kind)
@notification_group = args[:notification_group] if args.key?(:notification_group)
@notification_type = args[:notification_type] if args.key?(:notification_type)
@pcampaign_id = args[:pcampaign_id] if args.key?(:pcampaign_id)
@reason = args[:reason] if args.key?(:reason)

View File

@ -1212,6 +1212,7 @@ module Google
property :dont_show_notification, as: 'dont_show_notification'
property :icon_url, as: 'iconUrl'
property :kind, as: 'kind'
property :notification_group, as: 'notificationGroup'
property :notification_type, as: 'notification_type'
property :pcampaign_id, as: 'pcampaign_id'
property :reason, as: 'reason'

View File

@ -1979,6 +1979,9 @@ module Google
# Restrict results to books with this language code.
# @param [String] library_restrict
# Restrict search to this user's library.
# @param [String] max_allowed_maturity_rating
# The maximum allowed maturity rating of returned recommendations. Books with a
# higher maturity rating are filtered out.
# @param [Fixnum] max_results
# Maximum number of results to return.
# @param [String] order_by
@ -2016,7 +2019,7 @@ module Google
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_volumes(q, download: nil, filter: nil, lang_restrict: nil, library_restrict: nil, max_results: nil, order_by: nil, partner: nil, print_type: nil, projection: nil, show_preorders: nil, source: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
def list_volumes(q, download: nil, filter: nil, lang_restrict: nil, library_restrict: nil, max_allowed_maturity_rating: nil, max_results: nil, order_by: nil, partner: nil, print_type: nil, projection: nil, show_preorders: nil, source: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:get, 'volumes', options)
command.response_representation = Google::Apis::BooksV1::Volumes::Representation
command.response_class = Google::Apis::BooksV1::Volumes
@ -2024,6 +2027,7 @@ module Google
command.query['filter'] = filter unless filter.nil?
command.query['langRestrict'] = lang_restrict unless lang_restrict.nil?
command.query['libraryRestrict'] = library_restrict unless library_restrict.nil?
command.query['maxAllowedMaturityRating'] = max_allowed_maturity_rating unless max_allowed_maturity_rating.nil?
command.query['maxResults'] = max_results unless max_results.nil?
command.query['orderBy'] = order_by unless order_by.nil?
command.query['partner'] = partner unless partner.nil?

View File

@ -25,7 +25,7 @@ module Google
# @see https://developers.google.com/google-apps/calendar/firstapp
module CalendarV3
VERSION = 'V3'
REVISION = '20160815'
REVISION = '20170319'
# Manage your calendars
AUTH_CALENDAR = 'https://www.googleapis.com/auth/calendar'

View File

@ -427,8 +427,7 @@ module Google
# The method used to deliver the notification. Possible values are:
# - "email" - Reminders are sent via email.
# - "sms" - Reminders are sent via SMS. This value is read-only and is ignored
# on inserts and updates. SMS reminders are only available for Google Apps for
# Work, Education, and Government customers.
# on inserts and updates. SMS reminders are only available for G Suite customers.
# Corresponds to the JSON property `method`
# @return [String]
attr_accessor :delivery_method
@ -600,6 +599,74 @@ module Google
end
end
#
class DeepLinkData
include Google::Apis::Core::Hashable
#
# Corresponds to the JSON property `links`
# @return [Array<Google::Apis::CalendarV3::Link>]
attr_accessor :links
#
# 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)
@links = args[:links] if args.key?(:links)
@url = args[:url] if args.key?(:url)
end
end
#
class DisplayInfo
include Google::Apis::Core::Hashable
#
# Corresponds to the JSON property `appIconUrl`
# @return [String]
attr_accessor :app_icon_url
#
# Corresponds to the JSON property `appShortTitle`
# @return [String]
attr_accessor :app_short_title
#
# Corresponds to the JSON property `appTitle`
# @return [String]
attr_accessor :app_title
#
# Corresponds to the JSON property `linkShortTitle`
# @return [String]
attr_accessor :link_short_title
#
# Corresponds to the JSON property `linkTitle`
# @return [String]
attr_accessor :link_title
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@app_icon_url = args[:app_icon_url] if args.key?(:app_icon_url)
@app_short_title = args[:app_short_title] if args.key?(:app_short_title)
@app_title = args[:app_title] if args.key?(:app_title)
@link_short_title = args[:link_short_title] if args.key?(:link_short_title)
@link_title = args[:link_title] if args.key?(:link_title)
end
end
#
class Error
include Google::Apis::Core::Hashable
@ -1340,15 +1407,39 @@ module Google
end
end
#
class EventHabitInstance
include Google::Apis::Core::Hashable
# Metadata specific to this instance.
# Corresponds to the JSON property `data`
# @return [Google::Apis::CalendarV3::HabitInstanceData]
attr_accessor :data
# Id of the habit this instance belongs to.
# Corresponds to the JSON property `parentId`
# @return [String]
attr_accessor :parent_id
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@data = args[:data] if args.key?(:data)
@parent_id = args[:parent_id] if args.key?(:parent_id)
end
end
#
class EventReminder
include Google::Apis::Core::Hashable
# The method used by this reminder. Possible values are:
# - "email" - Reminders are sent via email.
# - "sms" - Reminders are sent via SMS. These are only available for Google Apps
# for Work, Education, and Government customers. Requests to set SMS reminders
# for other account types are ignored.
# - "sms" - Reminders are sent via SMS. These are only available for G Suite
# customers. Requests to set SMS reminders for other account types are ignored.
# - "popup" - Reminders are sent via a UI popup.
# Corresponds to the JSON property `method`
# @return [String]
@ -1629,6 +1720,118 @@ module Google
end
end
#
class HabitInstanceData
include Google::Apis::Core::Hashable
#
# Corresponds to the JSON property `status`
# @return [String]
attr_accessor :status
#
# Corresponds to the JSON property `statusInferred`
# @return [Boolean]
attr_accessor :status_inferred
alias_method :status_inferred?, :status_inferred
#
# 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)
@status = args[:status] if args.key?(:status)
@status_inferred = args[:status_inferred] if args.key?(:status_inferred)
@type = args[:type] if args.key?(:type)
end
end
#
class LaunchInfo
include Google::Apis::Core::Hashable
#
# Corresponds to the JSON property `appId`
# @return [String]
attr_accessor :app_id
#
# Corresponds to the JSON property `installUrl`
# @return [String]
attr_accessor :install_url
#
# Corresponds to the JSON property `intentAction`
# @return [String]
attr_accessor :intent_action
#
# Corresponds to the JSON property `uri`
# @return [String]
attr_accessor :uri
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@app_id = args[:app_id] if args.key?(:app_id)
@install_url = args[:install_url] if args.key?(:install_url)
@intent_action = args[:intent_action] if args.key?(:intent_action)
@uri = args[:uri] if args.key?(:uri)
end
end
#
class Link
include Google::Apis::Core::Hashable
#
# Corresponds to the JSON property `applinkingSource`
# @return [String]
attr_accessor :applinking_source
#
# Corresponds to the JSON property `displayInfo`
# @return [Google::Apis::CalendarV3::DisplayInfo]
attr_accessor :display_info
#
# Corresponds to the JSON property `launchInfo`
# @return [Google::Apis::CalendarV3::LaunchInfo]
attr_accessor :launch_info
#
# Corresponds to the JSON property `platform`
# @return [String]
attr_accessor :platform
#
# 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)
@applinking_source = args[:applinking_source] if args.key?(:applinking_source)
@display_info = args[:display_info] if args.key?(:display_info)
@launch_info = args[:launch_info] if args.key?(:launch_info)
@platform = args[:platform] if args.key?(:platform)
@url = args[:url] if args.key?(:url)
end
end
#
class Setting
include Google::Apis::Core::Hashable

View File

@ -88,6 +88,18 @@ module Google
include Google::Apis::Core::JsonObjectSupport
end
class DeepLinkData
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class DisplayInfo
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class Error
class Representation < Google::Apis::Core::JsonRepresentation; end
@ -154,6 +166,12 @@ module Google
include Google::Apis::Core::JsonObjectSupport
end
class EventHabitInstance
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class EventReminder
class Representation < Google::Apis::Core::JsonRepresentation; end
@ -196,6 +214,24 @@ module Google
include Google::Apis::Core::JsonObjectSupport
end
class HabitInstanceData
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class LaunchInfo
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 Setting
class Representation < Google::Apis::Core::JsonRepresentation; end
@ -350,6 +386,26 @@ module Google
end
end
class DeepLinkData
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :links, as: 'links', class: Google::Apis::CalendarV3::Link, decorator: Google::Apis::CalendarV3::Link::Representation
property :url, as: 'url'
end
end
class DisplayInfo
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :app_icon_url, as: 'appIconUrl'
property :app_short_title, as: 'appShortTitle'
property :app_title, as: 'appTitle'
property :link_short_title, as: 'linkShortTitle'
property :link_title, as: 'linkTitle'
end
end
class Error
# @private
class Representation < Google::Apis::Core::JsonRepresentation
@ -511,6 +567,15 @@ module Google
end
end
class EventHabitInstance
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :data, as: 'data', class: Google::Apis::CalendarV3::HabitInstanceData, decorator: Google::Apis::CalendarV3::HabitInstanceData::Representation
property :parent_id, as: 'parentId'
end
end
class EventReminder
# @private
class Representation < Google::Apis::Core::JsonRepresentation
@ -595,6 +660,38 @@ module Google
end
end
class HabitInstanceData
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :status, as: 'status'
property :status_inferred, as: 'statusInferred'
property :type, as: 'type'
end
end
class LaunchInfo
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :app_id, as: 'appId'
property :install_url, as: 'installUrl'
property :intent_action, as: 'intentAction'
property :uri, as: 'uri'
end
end
class Link
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :applinking_source, as: 'applinkingSource'
property :display_info, as: 'displayInfo', class: Google::Apis::CalendarV3::DisplayInfo, decorator: Google::Apis::CalendarV3::DisplayInfo::Representation
property :launch_info, as: 'launchInfo', class: Google::Apis::CalendarV3::LaunchInfo, decorator: Google::Apis::CalendarV3::LaunchInfo::Representation
property :platform, as: 'platform'
property :url, as: 'url'
end
end
class Setting
# @private
class Representation < Google::Apis::Core::JsonRepresentation

View File

@ -26,7 +26,7 @@ module Google
# @see https://developers.google.com/civic-information
module CivicinfoV2
VERSION = 'V2'
REVISION = '20160707'
REVISION = '20161102'
end
end
end

View File

@ -191,7 +191,9 @@ module Google
# @return [String]
attr_accessor :email
# The candidate's name.
# 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
@ -322,9 +324,8 @@ module Google
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,
# or a judge's name for a retention contest. This field is only populated for
# contests of type 'Referendum'.
# 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<String>]
attr_accessor :referendum_ballot_responses
@ -403,7 +404,8 @@ module Google
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 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
@ -441,6 +443,63 @@ module Google
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 DivisionSearchResponse
include Google::Apis::Core::Hashable
@ -585,6 +644,25 @@ module Google
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
@ -621,6 +699,11 @@ module Google
# @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]
@ -641,6 +724,7 @@ module Google
# 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
@ -881,6 +965,206 @@ module Google
end
end
#
class PostalAddress
include Google::Apis::Core::Hashable
#
# Corresponds to the JSON property `addressLines`
# @return [Array<String>]
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
@ -914,6 +1198,26 @@ module Google
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
@ -1041,6 +1345,31 @@ module Google
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
@ -1128,6 +1457,43 @@ module Google
@state = args[:state] if args.key?(:state)
end
end
#
class VoterInfoSegmentResult
include Google::Apis::Core::Hashable
#
# Corresponds to the JSON property `generatedMillis`
# @return [String]
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

View File

@ -52,6 +52,24 @@ module Google
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 DivisionSearchResponse
class Representation < Google::Apis::Core::JsonRepresentation; end
@ -76,6 +94,12 @@ module Google
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
@ -112,12 +136,24 @@ module Google
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
@ -136,12 +172,24 @@ module Google
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
@ -235,6 +283,29 @@ module Google
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 DivisionSearchResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
@ -274,6 +345,14 @@ module Google
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
@ -287,6 +366,7 @@ module Google
# @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
@ -347,6 +427,43 @@ module Google
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
@ -359,6 +476,14 @@ module Google
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
@ -395,6 +520,16 @@ module Google
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
@ -419,6 +554,19 @@ module Google
end
end
class VoterInfoSegmentResult
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :generated_millis, 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

View File

@ -54,6 +54,7 @@ module Google
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.
@ -80,8 +81,10 @@ module Google
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def search_divisions(query: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
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::DivisionSearchResponse::Representation
command.response_class = Google::Apis::CivicinfoV2::DivisionSearchResponse
command.query['query'] = query unless query.nil?
@ -92,6 +95,7 @@ module Google
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
@ -113,8 +117,10 @@ module Google
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def query_election(fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
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?
@ -127,11 +133,16 @@ module Google
# address.
# @param [String] address
# The registered address of the voter to look up.
# @param [Google::Apis::CivicinfoV2::VoterInfoRequest] voter_info_request_object
# @param [String] 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
@ -153,13 +164,16 @@ module Google
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def query_voter_info(address, election_id: nil, official_only: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
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?
@ -168,6 +182,7 @@ module Google
# 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.
@ -203,8 +218,10 @@ module Google
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def representative_info_by_address(address: nil, include_offices: nil, levels: nil, roles: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
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?
@ -220,6 +237,7 @@ module Google
# 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>, 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
@ -253,8 +271,10 @@ module Google
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def representative_info_by_division(ocd_id, levels: nil, recursive: nil, roles: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
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?

View File

@ -25,37 +25,7 @@ module Google
# @see https://developers.google.com/classroom/
module ClassroomV1
VERSION = 'V1'
REVISION = '20160816'
# View instructions for teacher-assigned work in your Google Classroom classes
AUTH_CLASSROOM_COURSE_WORK_READONLY = 'https://www.googleapis.com/auth/classroom.course-work.readonly'
# Manage your Google Classroom classes
AUTH_CLASSROOM_COURSES = 'https://www.googleapis.com/auth/classroom.courses'
# View your Google Classroom classes
AUTH_CLASSROOM_COURSES_READONLY = 'https://www.googleapis.com/auth/classroom.courses.readonly'
# Manage your course work and view your grades in Google Classroom
AUTH_CLASSROOM_COURSEWORK_ME = 'https://www.googleapis.com/auth/classroom.coursework.me'
# View your course work and grades in Google Classroom
AUTH_CLASSROOM_COURSEWORK_ME_READONLY = 'https://www.googleapis.com/auth/classroom.coursework.me.readonly'
# Manage course work and grades for students in the Google Classroom classes you teach and view the course work and grades for classes you administer
AUTH_CLASSROOM_COURSEWORK_STUDENTS = 'https://www.googleapis.com/auth/classroom.coursework.students'
# View course work and grades for students in the Google Classroom classes you teach or administer
AUTH_CLASSROOM_COURSEWORK_STUDENTS_READONLY = 'https://www.googleapis.com/auth/classroom.coursework.students.readonly'
# View the email addresses of people in your classes
AUTH_CLASSROOM_PROFILE_EMAILS = 'https://www.googleapis.com/auth/classroom.profile.emails'
# View the profile photos of people in your classes
AUTH_CLASSROOM_PROFILE_PHOTOS = 'https://www.googleapis.com/auth/classroom.profile.photos'
# Manage your Google Classroom class rosters
AUTH_CLASSROOM_ROSTERS = 'https://www.googleapis.com/auth/classroom.rosters'
REVISION = '20170322'
# View your Google Classroom class rosters
AUTH_CLASSROOM_ROSTERS_READONLY = 'https://www.googleapis.com/auth/classroom.rosters.readonly'
@ -63,8 +33,35 @@ module Google
# View your course work and grades in Google Classroom
AUTH_CLASSROOM_STUDENT_SUBMISSIONS_ME_READONLY = 'https://www.googleapis.com/auth/classroom.student-submissions.me.readonly'
# View course work and grades for students in the Google Classroom classes you teach or administer
AUTH_CLASSROOM_COURSEWORK_STUDENTS_READONLY = 'https://www.googleapis.com/auth/classroom.coursework.students.readonly'
# View course work and grades for students in the Google Classroom classes you teach or administer
AUTH_CLASSROOM_STUDENT_SUBMISSIONS_STUDENTS_READONLY = 'https://www.googleapis.com/auth/classroom.student-submissions.students.readonly'
# Manage your Google Classroom class rosters
AUTH_CLASSROOM_ROSTERS = 'https://www.googleapis.com/auth/classroom.rosters'
# View your course work and grades in Google Classroom
AUTH_CLASSROOM_COURSEWORK_ME_READONLY = 'https://www.googleapis.com/auth/classroom.coursework.me.readonly'
# View your Google Classroom classes
AUTH_CLASSROOM_COURSES_READONLY = 'https://www.googleapis.com/auth/classroom.courses.readonly'
# Manage your Google Classroom classes
AUTH_CLASSROOM_COURSES = 'https://www.googleapis.com/auth/classroom.courses'
# Manage your course work and view your grades in Google Classroom
AUTH_CLASSROOM_COURSEWORK_ME = 'https://www.googleapis.com/auth/classroom.coursework.me'
# Manage course work and grades for students in the Google Classroom classes you teach and view the course work and grades for classes you administer
AUTH_CLASSROOM_COURSEWORK_STUDENTS = 'https://www.googleapis.com/auth/classroom.coursework.students'
# View the profile photos of people in your classes
AUTH_CLASSROOM_PROFILE_PHOTOS = 'https://www.googleapis.com/auth/classroom.profile.photos'
# View the email addresses of people in your classes
AUTH_CLASSROOM_PROFILE_EMAILS = 'https://www.googleapis.com/auth/classroom.profile.emails'
end
end
end

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

View File

@ -20,13 +20,13 @@ module Google
module Apis
# Google Cloud Billing API
#
# Retrieves Google Developers Console billing accounts and associates them with
# projects.
# Allows developers to manage billing for their Google Cloud Platform projects
# programmatically.
#
# @see https://cloud.google.com/billing/
module CloudbillingV1
VERSION = 'V1'
REVISION = '20151222'
REVISION = '20170210'
# View and manage your data across Google Cloud Platform services
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'

View File

@ -22,19 +22,122 @@ module Google
module Apis
module CloudbillingV1
# A billing account in [Google Developers Console](https://console.developers.
# google.com/). You can assign a billing account to one or more projects.
class BillingAccount
# 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. 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`.
# 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
# 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
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@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)
@billing_account_name = args[:billing_account_name] if args.key?(:billing_account_name)
end
end
# Request message for `ListProjectBillingInfoResponse`.
class ListProjectBillingInfoResponse
include Google::Apis::Core::Hashable
# A token to retrieve the next page of results. To retrieve the next page,
# call `ListProjectBillingInfo` again with the `page_token` field set to this
# value. This field is empty if there are no more results to retrieve.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# A list of `ProjectBillingInfo` resources representing the projects
# associated with the billing account.
# Corresponds to the JSON property `projectBillingInfo`
# @return [Array<Google::Apis::CloudbillingV1::ProjectBillingInfo>]
attr_accessor :project_billing_info
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
@project_billing_info = args[:project_billing_info] if args.key?(:project_billing_info)
end
end
# Response message for `ListBillingAccounts`.
class ListBillingAccountsResponse
include Google::Apis::Core::Hashable
# 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
# A list of billing accounts.
# Corresponds to the JSON property `billingAccounts`
# @return [Array<Google::Apis::CloudbillingV1::BillingAccount>]
attr_accessor :billing_accounts
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)
@billing_accounts = args[:billing_accounts] if args.key?(:billing_accounts)
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
# 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.
@ -43,125 +146,23 @@ module Google
attr_accessor :open
alias_method :open?, :open
# The display name given to the billing account, such as `My Billing Account`.
# This name is displayed in the Google Developers Console.
# 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)
@name = args[:name] if args.key?(:name)
@open = args[:open] if args.key?(:open)
@display_name = args[:display_name] if args.key?(:display_name)
end
end
# Response message for `ListBillingAccounts`.
class ListBillingAccountsResponse
include Google::Apis::Core::Hashable
# A list of billing accounts.
# Corresponds to the JSON property `billingAccounts`
# @return [Array<Google::Apis::CloudbillingV1::BillingAccount>]
attr_accessor :billing_accounts
# A token to retrieve the next page of results. To retrieve the next page, call `
# ListBillingAccounts` again with the `page_token` field set to this value. This
# field is empty if there are no more results to retrieve.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@billing_accounts = args[:billing_accounts] if args.key?(:billing_accounts)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
end
end
# Request message for `ListProjectBillingInfoResponse`.
class ListProjectBillingInfoResponse
include Google::Apis::Core::Hashable
# A list of `ProjectBillingInfo` resources representing the projects associated
# with the billing account.
# Corresponds to the JSON property `projectBillingInfo`
# @return [Array<Google::Apis::CloudbillingV1::ProjectBillingInfo>]
attr_accessor :project_billing_info
# 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
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@project_billing_info = args[:project_billing_info] if args.key?(:project_billing_info)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
end
end
# Encapsulation of billing information for a Developers 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 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.
# 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
# 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
# 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
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@display_name = args[:display_name] if args.key?(:display_name)
@open = args[:open] if args.key?(:open)
@name = args[:name] if args.key?(:name)
@project_id = args[:project_id] if args.key?(:project_id)
@billing_account_name = args[:billing_account_name] if args.key?(:billing_account_name)
@billing_enabled = args[:billing_enabled] if args.key?(:billing_enabled)
end
end
end

View File

@ -22,13 +22,7 @@ module Google
module Apis
module CloudbillingV1
class BillingAccount
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class ListBillingAccountsResponse
class ProjectBillingInfo
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
@ -40,46 +34,52 @@ module Google
include Google::Apis::Core::JsonObjectSupport
end
class ProjectBillingInfo
class ListBillingAccountsResponse
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class BillingAccount
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :name, as: 'name'
property :open, as: 'open'
property :display_name, as: 'displayName'
end
end
class Representation < Google::Apis::Core::JsonRepresentation; 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
collection :project_billing_info, as: 'projectBillingInfo', class: Google::Apis::CloudbillingV1::ProjectBillingInfo, decorator: Google::Apis::CloudbillingV1::ProjectBillingInfo::Representation
property :next_page_token, as: 'nextPageToken'
end
include Google::Apis::Core::JsonObjectSupport
end
class ProjectBillingInfo
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :billing_enabled, as: 'billingEnabled'
property :name, as: 'name'
property :project_id, as: 'projectId'
property :billing_account_name, as: 'billingAccountName'
property :billing_enabled, as: 'billingEnabled'
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 ListBillingAccountsResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :next_page_token, as: 'nextPageToken'
collection :billing_accounts, as: 'billingAccounts', class: Google::Apis::CloudbillingV1::BillingAccount, decorator: Google::Apis::CloudbillingV1::BillingAccount::Representation
end
end
class BillingAccount
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :display_name, as: 'displayName'
property :open, as: 'open'
property :name, as: 'name'
end
end
end

View File

@ -22,8 +22,8 @@ module Google
module CloudbillingV1
# Google Cloud Billing API
#
# Retrieves Google Developers Console billing accounts and associates them with
# projects.
# Allows developers to manage billing for their Google Cloud Platform projects
# programmatically.
#
# @example
# require 'google/apis/cloudbilling_v1'
@ -47,17 +47,111 @@ module Google
super('https://cloudbilling.googleapis.com/', '')
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).
# 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 billing account to retrieve. For example, `
# billingAccounts/012345-567890-ABCDEF`.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# 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] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @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, quota_user: nil, fields: 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['quotaUser'] = quota_user unless quota_user.nil?
command.query['fields'] = fields unless fields.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] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @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, quota_user: nil, fields: 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['quotaUser'] = quota_user unless quota_user.nil?
command.query['fields'] = fields unless fields.nil?
execute_or_queue_command(command, &block)
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] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
@ -70,29 +164,30 @@ module Google
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_billing_account(name, fields: nil, quota_user: nil, options: nil, &block)
def get_billing_account(name, quota_user: nil, fields: 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?
command.query['fields'] = fields unless fields.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).
# 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.
# 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.
# 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] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
@ -105,34 +200,35 @@ module Google
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_billing_accounts(page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
def list_billing_accounts(page_size: nil, page_token: nil, quota_user: nil, fields: 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?
command.query['fields'] = fields unless fields.nil?
execute_or_queue_command(command, &block)
end
# Lists the projects associated with a billing account. The current
# authenticated user must be an [owner of the billing account](https://support.
# google.com/cloud/answer/4430947).
# 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 associated with the projects that you
# want to list. For example, `billingAccounts/012345-567890-ABCDEF`.
# 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.
# 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.
# 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] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
@ -145,104 +241,15 @@ module Google
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_billing_account_projects(name, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
def list_billing_account_projects(name, page_size: nil, page_token: nil, quota_user: nil, fields: 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 Developers 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

View File

@ -25,7 +25,7 @@ module Google
# @see https://cloud.google.com/container-builder/docs/
module CloudbuildV1
VERSION = 'V1'
REVISION = '20160817'
REVISION = '20170327'
# View and manage your data across Google Cloud Platform services
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'

File diff suppressed because it is too large Load Diff

View File

@ -22,37 +22,13 @@ module Google
module Apis
module CloudbuildV1
class Status
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 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 Operation
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class BuildTrigger
class ListBuildTriggersResponse
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
@ -64,12 +40,84 @@ module Google
include Google::Apis::Core::JsonObjectSupport
end
class RepoSource
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 BuildStep
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 Status
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 BuildTrigger
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class Build
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 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 Source
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 StorageSource
class Representation < Google::Apis::Core::JsonRepresentation; end
@ -82,80 +130,173 @@ module Google
include Google::Apis::Core::JsonObjectSupport
end
class Build
class BuildOperationMetadata
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 CancelOperationRequest
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class Operation
# @private
class Representation < Google::Apis::Core::JsonRepresentation
hash :response, as: 'response'
property :name, as: 'name'
property :error, as: 'error', class: Google::Apis::CloudbuildV1::Status, decorator: Google::Apis::CloudbuildV1::Status::Representation
hash :metadata, as: 'metadata'
property :done, as: 'done'
end
end
class ListBuildTriggersResponse
class Representation < Google::Apis::Core::JsonRepresentation; end
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :triggers, as: 'triggers', class: Google::Apis::CloudbuildV1::BuildTrigger, decorator: Google::Apis::CloudbuildV1::BuildTrigger::Representation
include Google::Apis::Core::JsonObjectSupport
end
end
class CancelBuildRequest
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 ListOperationsResponse
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
class BuiltImage
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :name, as: 'name'
property :digest, as: 'digest'
end
end
class RepoSource
class Representation < Google::Apis::Core::JsonRepresentation; end
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :tag_name, as: 'tagName'
property :commit_sha, as: 'commitSha'
property :project_id, as: 'projectId'
property :repo_name, as: 'repoName'
property :branch_name, as: 'branchName'
end
end
include Google::Apis::Core::JsonObjectSupport
class HashProp
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :type, as: 'type'
property :value, :base64 => true, as: 'value'
end
end
class BuildStep
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :entrypoint, as: 'entrypoint'
property :id, as: 'id'
property :dir, as: 'dir'
collection :env, as: 'env'
collection :wait_for, as: 'waitFor'
collection :args, as: 'args'
property :name, as: 'name'
end
end
class Empty
class Representation < Google::Apis::Core::JsonRepresentation; 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
include Google::Apis::Core::JsonObjectSupport
end
class BuildOptions
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
end
class Status
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :code, as: 'code'
collection :details, as: 'details'
property :code, as: 'code'
property :message, as: 'message'
end
end
class BuildOperationMetadata
class Empty
# @private
class Representation < Google::Apis::Core::JsonRepresentation
end
end
class BuildTrigger
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :disabled, as: 'disabled'
property :create_time, as: 'createTime'
property :trigger_template, as: 'triggerTemplate', class: Google::Apis::CloudbuildV1::RepoSource, decorator: Google::Apis::CloudbuildV1::RepoSource::Representation
property :filename, as: 'filename'
property :id, as: 'id'
property :build, as: 'build', class: Google::Apis::CloudbuildV1::Build, decorator: Google::Apis::CloudbuildV1::Build::Representation
hash :substitutions, as: 'substitutions'
property :description, as: 'description'
end
end
class Build
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :create_time, as: 'createTime'
property :source_provenance, as: 'sourceProvenance', class: Google::Apis::CloudbuildV1::SourceProvenance, decorator: Google::Apis::CloudbuildV1::SourceProvenance::Representation
collection :images, as: 'images'
property :project_id, as: 'projectId'
property :log_url, as: 'logUrl'
property :finish_time, as: 'finishTime'
property :options, as: 'options', class: Google::Apis::CloudbuildV1::BuildOptions, decorator: Google::Apis::CloudbuildV1::BuildOptions::Representation
property :source, as: 'source', class: Google::Apis::CloudbuildV1::Source, decorator: Google::Apis::CloudbuildV1::Source::Representation
property :timeout, as: 'timeout'
property :status, as: 'status'
property :status_detail, as: 'statusDetail'
property :results, as: 'results', class: Google::Apis::CloudbuildV1::Results, decorator: Google::Apis::CloudbuildV1::Results::Representation
property :logs_bucket, as: 'logsBucket'
collection :steps, as: 'steps', class: Google::Apis::CloudbuildV1::BuildStep, decorator: Google::Apis::CloudbuildV1::BuildStep::Representation
property :build_trigger_id, as: 'buildTriggerId'
property :id, as: 'id'
property :start_time, as: 'startTime'
hash :substitutions, as: 'substitutions'
end
end
class CancelBuildRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation
end
end
class ListBuildsResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :next_page_token, as: 'nextPageToken'
collection :builds, as: 'builds', class: Google::Apis::CloudbuildV1::Build, decorator: Google::Apis::CloudbuildV1::Build::Representation
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
@ -169,163 +310,6 @@ module Google
end
end
class SourceProvenance
# @private
class Representation < Google::Apis::Core::JsonRepresentation
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
hash :file_hashes, as: 'fileHashes', class: Google::Apis::CloudbuildV1::FileHashes, decorator: Google::Apis::CloudbuildV1::FileHashes::Representation
end
end
class Operation
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :error, as: 'error', class: Google::Apis::CloudbuildV1::Status, decorator: Google::Apis::CloudbuildV1::Status::Representation
property :done, as: 'done'
hash :metadata, as: 'metadata'
hash :response, as: 'response'
property :name, as: 'name'
end
end
class BuildTrigger
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :trigger_template, as: 'triggerTemplate', class: Google::Apis::CloudbuildV1::RepoSource, decorator: Google::Apis::CloudbuildV1::RepoSource::Representation
property :build, as: 'build', class: Google::Apis::CloudbuildV1::Build, decorator: Google::Apis::CloudbuildV1::Build::Representation
property :create_time, as: 'createTime'
property :id, as: 'id'
end
end
class BuiltImage
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :digest, as: 'digest'
property :name, as: 'name'
end
end
class HashProp
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :value, :base64 => true, as: 'value'
property :type, as: 'type'
end
end
class StorageSource
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :bucket, as: 'bucket'
property :generation, as: 'generation'
property :object, as: 'object'
end
end
class Results
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :images, as: 'images', class: Google::Apis::CloudbuildV1::BuiltImage, decorator: Google::Apis::CloudbuildV1::BuiltImage::Representation
collection :build_step_images, as: 'buildStepImages'
end
end
class Build
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :id, as: 'id'
property :source_provenance, as: 'sourceProvenance', class: Google::Apis::CloudbuildV1::SourceProvenance, decorator: Google::Apis::CloudbuildV1::SourceProvenance::Representation
property :results, as: 'results', class: Google::Apis::CloudbuildV1::Results, decorator: Google::Apis::CloudbuildV1::Results::Representation
property :status, as: 'status'
property :options, as: 'options', class: Google::Apis::CloudbuildV1::BuildOptions, decorator: Google::Apis::CloudbuildV1::BuildOptions::Representation
property :finish_time, as: 'finishTime'
property :timeout, as: 'timeout'
collection :steps, as: 'steps', class: Google::Apis::CloudbuildV1::BuildStep, decorator: Google::Apis::CloudbuildV1::BuildStep::Representation
property :source, as: 'source', class: Google::Apis::CloudbuildV1::Source, decorator: Google::Apis::CloudbuildV1::Source::Representation
property :create_time, as: 'createTime'
property :log_url, as: 'logUrl'
property :status_detail, as: 'statusDetail'
collection :images, as: 'images'
property :start_time, as: 'startTime'
property :logs_bucket, as: 'logsBucket'
property :project_id, as: 'projectId'
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 CancelBuildRequest
# @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 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 RepoSource
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :repo_name, as: 'repoName'
property :tag_name, as: 'tagName'
property :project_id, as: 'projectId'
property :branch_name, as: 'branchName'
property :commit_sha, as: 'commitSha'
end
end
class BuildStep
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :id, as: 'id'
collection :env, as: 'env'
collection :wait_for, as: 'waitFor'
collection :args, as: 'args'
property :name, as: 'name'
property :dir, as: 'dir'
end
end
class Empty
# @private
class Representation < Google::Apis::Core::JsonRepresentation
end
end
class BuildOptions
# @private
class Representation < Google::Apis::Core::JsonRepresentation
@ -334,12 +318,47 @@ module Google
end
end
class ListBuildsResponse
class StorageSource
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :next_page_token, as: 'nextPageToken'
collection :builds, as: 'builds', class: Google::Apis::CloudbuildV1::Build, decorator: Google::Apis::CloudbuildV1::Build::Representation
property :generation, as: 'generation'
property :bucket, as: 'bucket'
property :object, as: 'object'
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 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 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 CancelOperationRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation
end
end
end

View File

@ -46,6 +46,154 @@ module Google
super('https://cloudbuild.googleapis.com/', '')
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] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @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, quota_user: nil, fields: 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['quotaUser'] = quota_user unless quota_user.nil?
command.query['fields'] = fields unless fields.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] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @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, quota_user: nil, fields: 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['quotaUser'] = quota_user unless quota_user.nil?
command.query['fields'] = fields unless fields.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 [String] page_token
# Token to provide to skip to a particular spot in the list.
# @param [Fixnum] page_size
# Number of results to return in the list.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @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_token: nil, page_size: nil, quota_user: nil, fields: 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['pageToken'] = page_token unless page_token.nil?
command.query['pageSize'] = page_size unless page_size.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['fields'] = fields unless fields.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] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @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, quota_user: nil, fields: 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['quotaUser'] = quota_user unless quota_user.nil?
command.query['fields'] = fields unless fields.nil?
execute_or_queue_command(command, &block)
end
# Creates a new BuildTrigger.
# This API is experimental.
# @param [String] project_id
@ -80,6 +228,40 @@ module Google
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] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @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, quota_user: nil, fields: 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['quotaUser'] = quota_user unless quota_user.nil?
command.query['fields'] = fields unless fields.nil?
execute_or_queue_command(command, &block)
end
# Gets information about a BuildTrigger.
# This API is experimental.
# @param [String] project_id
@ -145,40 +327,6 @@ module Google
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] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @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, quota_user: nil, fields: 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['quotaUser'] = quota_user unless quota_user.nil?
command.query['fields'] = fields unless fields.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
@ -216,13 +364,19 @@ module Google
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
# 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] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
@ -232,70 +386,38 @@ module Google
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::CloudbuildV1::Operation] parsed result object
# @yieldparam result [Google::Apis::CloudbuildV1::Empty] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudbuildV1::Operation]
# @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 create_project_build(project_id, build_object = nil, quota_user: nil, fields: 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?
def cancel_operation(name, cancel_operation_request_object = nil, quota_user: nil, fields: 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['quotaUser'] = quota_user unless quota_user.nil?
command.query['fields'] = fields unless fields.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] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @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, quota_user: nil, fields: 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['quotaUser'] = quota_user unless quota_user.nil?
command.query['fields'] = fields unless fields.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 [Fixnum] page_size
# Number of results to return in the list.
# 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 below allows API services to override the binding
# to use different resource name schemes, such as `users/*/operations`.
# @param [String] name
# The name of the operation collection.
# @param [String] filter
# The standard list filter.
# @param [String] page_token
# Token to provide to skip to a particular spot in the list.
# The standard list page token.
# @param [Fixnum] page_size
# The standard list page size.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
@ -305,57 +427,22 @@ module Google
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::CloudbuildV1::ListBuildsResponse] parsed result object
# @yieldparam result [Google::Apis::CloudbuildV1::ListOperationsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudbuildV1::ListBuildsResponse]
# @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_project_builds(project_id, page_size: nil, page_token: nil, quota_user: nil, fields: 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['pageSize'] = page_size unless page_size.nil?
def list_operations(name, filter: nil, page_token: nil, page_size: nil, quota_user: nil, fields: 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['pageToken'] = page_token unless page_token.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['fields'] = fields unless fields.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] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @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, quota_user: nil, fields: 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['pageSize'] = page_size unless page_size.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['fields'] = fields unless fields.nil?
execute_or_queue_command(command, &block)
@ -392,48 +479,6 @@ module Google
command.query['fields'] = fields unless fields.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 below allows API services to override the binding
# to use different resource name schemes, such as `users/*/operations`.
# @param [String] name
# The name of the operation collection.
# @param [Fixnum] page_size
# The standard list page size.
# @param [String] filter
# The standard list filter.
# @param [String] page_token
# The standard list page token.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @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, page_size: nil, filter: nil, page_token: nil, quota_user: nil, fields: 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['pageSize'] = page_size unless page_size.nil?
command.query['filter'] = filter unless filter.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['fields'] = fields unless fields.nil?
execute_or_queue_command(command, &block)
end
protected

View File

@ -26,13 +26,13 @@ module Google
# @see http://cloud.google.com/debugger
module ClouddebuggerV2
VERSION = 'V2'
REVISION = '20160810'
# View and manage your data across Google Cloud Platform services
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'
REVISION = '20170322'
# Manage cloud debugger
AUTH_CLOUD_DEBUGGER = 'https://www.googleapis.com/auth/cloud_debugger'
# View and manage your data across Google Cloud Platform services
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'
end
end
end

File diff suppressed because it is too large Load Diff

View File

@ -22,151 +22,25 @@ module Google
module Apis
module ClouddebuggerV2
class RegisterDebuggeeRequest
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class Debuggee
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class StatusMessage
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class FormatMessage
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class SourceContext
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class CloudRepoSourceContext
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class RepoId
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class ProjectRepoId
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class AliasContext
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class CloudWorkspaceSourceContext
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class CloudWorkspaceId
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class GerritSourceContext
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class GitSourceContext
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class ExtendedSourceContext
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class RegisterDebuggeeResponse
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class ListActiveBreakpointsResponse
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class Breakpoint
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 StackFrame
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 UpdateActiveBreakpointRequest
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class UpdateActiveBreakpointResponse
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class SetBreakpointResponse
class GerritSourceContext
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class GetBreakpointResponse
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class Empty
class CloudWorkspaceId
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
@ -178,12 +52,252 @@ module Google
include Google::Apis::Core::JsonObjectSupport
end
class Breakpoint
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class UpdateActiveBreakpointRequest
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class SetBreakpointResponse
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class SourceContext
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class CloudRepoSourceContext
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class RegisterDebuggeeRequest
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class RegisterDebuggeeResponse
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class GetBreakpointResponse
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class StatusMessage
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class GitSourceContext
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 StackFrame
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class RepoId
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class FormatMessage
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class ExtendedSourceContext
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class ListDebuggeesResponse
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class AliasContext
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 SourceLocation
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class Debuggee
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class ProjectRepoId
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class ListActiveBreakpointsResponse
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class CloudWorkspaceSourceContext
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :snapshot_id, as: 'snapshotId'
property :workspace_id, as: 'workspaceId', class: Google::Apis::ClouddebuggerV2::CloudWorkspaceId, decorator: Google::Apis::ClouddebuggerV2::CloudWorkspaceId::Representation
end
end
class UpdateActiveBreakpointResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
end
end
class GerritSourceContext
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :gerrit_project, as: 'gerritProject'
property :alias_context, as: 'aliasContext', class: Google::Apis::ClouddebuggerV2::AliasContext, decorator: Google::Apis::ClouddebuggerV2::AliasContext::Representation
property :host_uri, as: 'hostUri'
property :revision_id, as: 'revisionId'
property :alias_name, as: 'aliasName'
end
end
class CloudWorkspaceId
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :name, as: 'name'
property :repo_id, as: 'repoId', class: Google::Apis::ClouddebuggerV2::RepoId, decorator: Google::Apis::ClouddebuggerV2::RepoId::Representation
end
end
class ListBreakpointsResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :breakpoints, as: 'breakpoints', class: Google::Apis::ClouddebuggerV2::Breakpoint, decorator: Google::Apis::ClouddebuggerV2::Breakpoint::Representation
property :next_wait_token, as: 'nextWaitToken'
end
end
class Breakpoint
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :expressions, as: 'expressions'
collection :evaluated_expressions, as: 'evaluatedExpressions', class: Google::Apis::ClouddebuggerV2::Variable, decorator: Google::Apis::ClouddebuggerV2::Variable::Representation
property :is_final_state, as: 'isFinalState'
collection :stack_frames, as: 'stackFrames', class: Google::Apis::ClouddebuggerV2::StackFrame, decorator: Google::Apis::ClouddebuggerV2::StackFrame::Representation
property :condition, as: 'condition'
property :status, as: 'status', class: Google::Apis::ClouddebuggerV2::StatusMessage, decorator: Google::Apis::ClouddebuggerV2::StatusMessage::Representation
property :user_email, as: 'userEmail'
property :action, as: 'action'
property :log_level, as: 'logLevel'
property :id, as: 'id'
property :location, as: 'location', class: Google::Apis::ClouddebuggerV2::SourceLocation, decorator: Google::Apis::ClouddebuggerV2::SourceLocation::Representation
property :final_time, as: 'finalTime'
collection :variable_table, as: 'variableTable', class: Google::Apis::ClouddebuggerV2::Variable, decorator: Google::Apis::ClouddebuggerV2::Variable::Representation
property :create_time, as: 'createTime'
property :log_message_format, as: 'logMessageFormat'
hash :labels, as: 'labels'
end
end
class UpdateActiveBreakpointRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :breakpoint, as: 'breakpoint', class: Google::Apis::ClouddebuggerV2::Breakpoint, decorator: Google::Apis::ClouddebuggerV2::Breakpoint::Representation
end
end
class SetBreakpointResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :breakpoint, as: 'breakpoint', class: Google::Apis::ClouddebuggerV2::Breakpoint, decorator: Google::Apis::ClouddebuggerV2::Breakpoint::Representation
end
end
class SourceContext
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :git, as: 'git', class: Google::Apis::ClouddebuggerV2::GitSourceContext, decorator: Google::Apis::ClouddebuggerV2::GitSourceContext::Representation
property :gerrit, as: 'gerrit', class: Google::Apis::ClouddebuggerV2::GerritSourceContext, decorator: Google::Apis::ClouddebuggerV2::GerritSourceContext::Representation
property :cloud_repo, as: 'cloudRepo', class: Google::Apis::ClouddebuggerV2::CloudRepoSourceContext, decorator: Google::Apis::ClouddebuggerV2::CloudRepoSourceContext::Representation
property :cloud_workspace, as: 'cloudWorkspace', class: Google::Apis::ClouddebuggerV2::CloudWorkspaceSourceContext, decorator: Google::Apis::ClouddebuggerV2::CloudWorkspaceSourceContext::Representation
end
end
class CloudRepoSourceContext
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :revision_id, as: 'revisionId'
property :alias_name, as: 'aliasName'
property :repo_id, as: 'repoId', class: Google::Apis::ClouddebuggerV2::RepoId, decorator: Google::Apis::ClouddebuggerV2::RepoId::Representation
property :alias_context, as: 'aliasContext', class: Google::Apis::ClouddebuggerV2::AliasContext, decorator: Google::Apis::ClouddebuggerV2::AliasContext::Representation
end
end
class RegisterDebuggeeRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation
@ -192,23 +306,19 @@ module Google
end
end
class Debuggee
class RegisterDebuggeeResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :id, as: 'id'
property :project, as: 'project'
property :uniquifier, as: 'uniquifier'
property :description, as: 'description'
property :is_inactive, as: 'isInactive'
property :agent_version, as: 'agentVersion'
property :is_disabled, as: 'isDisabled'
property :status, as: 'status', class: Google::Apis::ClouddebuggerV2::StatusMessage, decorator: Google::Apis::ClouddebuggerV2::StatusMessage::Representation
property :debuggee, as: 'debuggee', class: Google::Apis::ClouddebuggerV2::Debuggee, decorator: Google::Apis::ClouddebuggerV2::Debuggee::Representation
collection :source_contexts, as: 'sourceContexts', class: Google::Apis::ClouddebuggerV2::SourceContext, decorator: Google::Apis::ClouddebuggerV2::SourceContext::Representation
end
end
collection :ext_source_contexts, as: 'extSourceContexts', class: Google::Apis::ClouddebuggerV2::ExtendedSourceContext, decorator: Google::Apis::ClouddebuggerV2::ExtendedSourceContext::Representation
class GetBreakpointResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :breakpoint, as: 'breakpoint', class: Google::Apis::ClouddebuggerV2::Breakpoint, decorator: Google::Apis::ClouddebuggerV2::Breakpoint::Representation
hash :labels, as: 'labels'
end
end
@ -216,42 +326,43 @@ module Google
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :is_error, as: 'isError'
property :refers_to, as: 'refersTo'
property :description, as: 'description', class: Google::Apis::ClouddebuggerV2::FormatMessage, decorator: Google::Apis::ClouddebuggerV2::FormatMessage::Representation
property :refers_to, as: 'refersTo'
end
end
class FormatMessage
class GitSourceContext
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :format, as: 'format'
collection :parameters, as: 'parameters'
end
end
class SourceContext
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :cloud_repo, as: 'cloudRepo', class: Google::Apis::ClouddebuggerV2::CloudRepoSourceContext, decorator: Google::Apis::ClouddebuggerV2::CloudRepoSourceContext::Representation
property :cloud_workspace, as: 'cloudWorkspace', class: Google::Apis::ClouddebuggerV2::CloudWorkspaceSourceContext, decorator: Google::Apis::ClouddebuggerV2::CloudWorkspaceSourceContext::Representation
property :gerrit, as: 'gerrit', class: Google::Apis::ClouddebuggerV2::GerritSourceContext, decorator: Google::Apis::ClouddebuggerV2::GerritSourceContext::Representation
property :git, as: 'git', class: Google::Apis::ClouddebuggerV2::GitSourceContext, decorator: Google::Apis::ClouddebuggerV2::GitSourceContext::Representation
end
end
class CloudRepoSourceContext
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :repo_id, as: 'repoId', class: Google::Apis::ClouddebuggerV2::RepoId, decorator: Google::Apis::ClouddebuggerV2::RepoId::Representation
property :revision_id, as: 'revisionId'
property :alias_name, as: 'aliasName'
property :alias_context, as: 'aliasContext', class: Google::Apis::ClouddebuggerV2::AliasContext, decorator: Google::Apis::ClouddebuggerV2::AliasContext::Representation
property :url, as: 'url'
end
end
class Variable
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :var_table_index, as: 'varTableIndex'
property :value, as: 'value'
collection :members, as: 'members', class: Google::Apis::ClouddebuggerV2::Variable, decorator: Google::Apis::ClouddebuggerV2::Variable::Representation
property :status, as: 'status', class: Google::Apis::ClouddebuggerV2::StatusMessage, decorator: Google::Apis::ClouddebuggerV2::StatusMessage::Representation
property :name, as: 'name'
property :type, as: 'type'
end
end
class StackFrame
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :function, as: 'function'
collection :arguments, as: 'arguments', class: Google::Apis::ClouddebuggerV2::Variable, decorator: Google::Apis::ClouddebuggerV2::Variable::Representation
collection :locals, as: 'locals', class: Google::Apis::ClouddebuggerV2::Variable, decorator: Google::Apis::ClouddebuggerV2::Variable::Representation
property :location, as: 'location', class: Google::Apis::ClouddebuggerV2::SourceLocation, decorator: Google::Apis::ClouddebuggerV2::SourceLocation::Representation
end
end
@ -259,63 +370,17 @@ module Google
class RepoId
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :uid, as: 'uid'
property :project_repo_id, as: 'projectRepoId', class: Google::Apis::ClouddebuggerV2::ProjectRepoId, decorator: Google::Apis::ClouddebuggerV2::ProjectRepoId::Representation
property :uid, as: 'uid'
end
end
class ProjectRepoId
class FormatMessage
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :project_id, as: 'projectId'
property :repo_name, as: 'repoName'
end
end
class AliasContext
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :kind, as: 'kind'
property :name, as: 'name'
end
end
class CloudWorkspaceSourceContext
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :workspace_id, as: 'workspaceId', class: Google::Apis::ClouddebuggerV2::CloudWorkspaceId, decorator: Google::Apis::ClouddebuggerV2::CloudWorkspaceId::Representation
property :snapshot_id, as: 'snapshotId'
end
end
class CloudWorkspaceId
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :repo_id, as: 'repoId', class: Google::Apis::ClouddebuggerV2::RepoId, decorator: Google::Apis::ClouddebuggerV2::RepoId::Representation
property :name, as: 'name'
end
end
class GerritSourceContext
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :host_uri, as: 'hostUri'
property :gerrit_project, as: 'gerritProject'
property :revision_id, as: 'revisionId'
property :alias_name, as: 'aliasName'
property :alias_context, as: 'aliasContext', class: Google::Apis::ClouddebuggerV2::AliasContext, decorator: Google::Apis::ClouddebuggerV2::AliasContext::Representation
end
end
class GitSourceContext
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :url, as: 'url'
property :revision_id, as: 'revisionId'
collection :parameters, as: 'parameters'
property :format, as: 'format'
end
end
@ -328,48 +393,25 @@ module Google
end
end
class RegisterDebuggeeResponse
class ListDebuggeesResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :debuggee, as: 'debuggee', class: Google::Apis::ClouddebuggerV2::Debuggee, decorator: Google::Apis::ClouddebuggerV2::Debuggee::Representation
collection :debuggees, as: 'debuggees', class: Google::Apis::ClouddebuggerV2::Debuggee, decorator: Google::Apis::ClouddebuggerV2::Debuggee::Representation
end
end
class ListActiveBreakpointsResponse
class AliasContext
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :breakpoints, as: 'breakpoints', class: Google::Apis::ClouddebuggerV2::Breakpoint, decorator: Google::Apis::ClouddebuggerV2::Breakpoint::Representation
property :next_wait_token, as: 'nextWaitToken'
property :wait_expired, as: 'waitExpired'
property :name, as: 'name'
property :kind, as: 'kind'
end
end
class Breakpoint
class Empty
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :id, as: 'id'
property :action, as: 'action'
property :location, as: 'location', class: Google::Apis::ClouddebuggerV2::SourceLocation, decorator: Google::Apis::ClouddebuggerV2::SourceLocation::Representation
property :condition, as: 'condition'
collection :expressions, as: 'expressions'
property :log_message_format, as: 'logMessageFormat'
property :log_level, as: 'logLevel'
property :is_final_state, as: 'isFinalState'
property :create_time, as: 'createTime'
property :final_time, as: 'finalTime'
property :user_email, as: 'userEmail'
property :status, as: 'status', class: Google::Apis::ClouddebuggerV2::StatusMessage, decorator: Google::Apis::ClouddebuggerV2::StatusMessage::Representation
collection :stack_frames, as: 'stackFrames', class: Google::Apis::ClouddebuggerV2::StackFrame, decorator: Google::Apis::ClouddebuggerV2::StackFrame::Representation
collection :evaluated_expressions, as: 'evaluatedExpressions', class: Google::Apis::ClouddebuggerV2::Variable, decorator: Google::Apis::ClouddebuggerV2::Variable::Representation
collection :variable_table, as: 'variableTable', class: Google::Apis::ClouddebuggerV2::Variable, decorator: Google::Apis::ClouddebuggerV2::Variable::Representation
hash :labels, as: 'labels'
end
end
@ -381,83 +423,41 @@ module Google
end
end
class StackFrame
class Debuggee
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :function, as: 'function'
property :location, as: 'location', class: Google::Apis::ClouddebuggerV2::SourceLocation, decorator: Google::Apis::ClouddebuggerV2::SourceLocation::Representation
property :id, as: 'id'
property :agent_version, as: 'agentVersion'
property :is_disabled, as: 'isDisabled'
property :uniquifier, as: 'uniquifier'
property :description, as: 'description'
collection :source_contexts, as: 'sourceContexts', class: Google::Apis::ClouddebuggerV2::SourceContext, decorator: Google::Apis::ClouddebuggerV2::SourceContext::Representation
collection :arguments, as: 'arguments', class: Google::Apis::ClouddebuggerV2::Variable, decorator: Google::Apis::ClouddebuggerV2::Variable::Representation
collection :ext_source_contexts, as: 'extSourceContexts', class: Google::Apis::ClouddebuggerV2::ExtendedSourceContext, decorator: Google::Apis::ClouddebuggerV2::ExtendedSourceContext::Representation
collection :locals, as: 'locals', class: Google::Apis::ClouddebuggerV2::Variable, decorator: Google::Apis::ClouddebuggerV2::Variable::Representation
end
end
class Variable
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :name, as: 'name'
property :value, as: 'value'
property :type, as: 'type'
collection :members, as: 'members', class: Google::Apis::ClouddebuggerV2::Variable, decorator: Google::Apis::ClouddebuggerV2::Variable::Representation
property :var_table_index, as: 'varTableIndex'
hash :labels, as: 'labels'
property :status, as: 'status', class: Google::Apis::ClouddebuggerV2::StatusMessage, decorator: Google::Apis::ClouddebuggerV2::StatusMessage::Representation
property :is_inactive, as: 'isInactive'
property :project, as: 'project'
end
end
class UpdateActiveBreakpointRequest
class ProjectRepoId
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :breakpoint, as: 'breakpoint', class: Google::Apis::ClouddebuggerV2::Breakpoint, decorator: Google::Apis::ClouddebuggerV2::Breakpoint::Representation
property :project_id, as: 'projectId'
property :repo_name, as: 'repoName'
end
end
class UpdateActiveBreakpointResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
end
end
class SetBreakpointResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :breakpoint, as: 'breakpoint', class: Google::Apis::ClouddebuggerV2::Breakpoint, decorator: Google::Apis::ClouddebuggerV2::Breakpoint::Representation
end
end
class GetBreakpointResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :breakpoint, as: 'breakpoint', class: Google::Apis::ClouddebuggerV2::Breakpoint, decorator: Google::Apis::ClouddebuggerV2::Breakpoint::Representation
end
end
class Empty
# @private
class Representation < Google::Apis::Core::JsonRepresentation
end
end
class ListBreakpointsResponse
class ListActiveBreakpointsResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :next_wait_token, as: 'nextWaitToken'
collection :breakpoints, as: 'breakpoints', class: Google::Apis::ClouddebuggerV2::Breakpoint, decorator: Google::Apis::ClouddebuggerV2::Breakpoint::Representation
property :next_wait_token, as: 'nextWaitToken'
end
end
class ListDebuggeesResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :debuggees, as: 'debuggees', class: Google::Apis::ClouddebuggerV2::Debuggee, decorator: Google::Apis::ClouddebuggerV2::Debuggee::Representation
property :wait_expired, as: 'waitExpired'
end
end
end

View File

@ -47,13 +47,219 @@ module Google
super('https://clouddebugger.googleapis.com/', '')
end
# Registers the debuggee with the controller service. All agents attached to the
# same application should call this method with the same request content to get
# back the same stable `debuggee_id`. Agents should call this method again
# whenever `google.rpc.Code.NOT_FOUND` is returned from any controller method.
# Lists all the debuggees that the user can set breakpoints to.
# @param [String] client_version
# The client version making the call.
# Following: `domain/type/version` (e.g., `google.com/intellij/v1`).
# @param [Boolean] include_inactive
# When set to `true`, the result includes all debuggees. Otherwise, the
# result includes only debuggees that are active.
# @param [String] project
# Project number of a Google Cloud project whose debuggees to 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::ClouddebuggerV2::ListDebuggeesResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ClouddebuggerV2::ListDebuggeesResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_debugger_debuggees(client_version: nil, include_inactive: nil, project: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v2/debugger/debuggees', options)
command.response_representation = Google::Apis::ClouddebuggerV2::ListDebuggeesResponse::Representation
command.response_class = Google::Apis::ClouddebuggerV2::ListDebuggeesResponse
command.query['clientVersion'] = client_version unless client_version.nil?
command.query['includeInactive'] = include_inactive unless include_inactive.nil?
command.query['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
# Sets the breakpoint to the debuggee.
# @param [String] debuggee_id
# ID of the debuggee where the breakpoint is to be set.
# @param [Google::Apis::ClouddebuggerV2::Breakpoint] breakpoint_object
# @param [String] client_version
# The client version making the call.
# Following: `domain/type/version` (e.g., `google.com/intellij/v1`).
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ClouddebuggerV2::SetBreakpointResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ClouddebuggerV2::SetBreakpointResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def set_debugger_debuggee_breakpoint(debuggee_id, breakpoint_object = nil, client_version: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v2/debugger/debuggees/{debuggeeId}/breakpoints/set', options)
command.request_representation = Google::Apis::ClouddebuggerV2::Breakpoint::Representation
command.request_object = breakpoint_object
command.response_representation = Google::Apis::ClouddebuggerV2::SetBreakpointResponse::Representation
command.response_class = Google::Apis::ClouddebuggerV2::SetBreakpointResponse
command.params['debuggeeId'] = debuggee_id unless debuggee_id.nil?
command.query['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
# Deletes the breakpoint from the debuggee.
# @param [String] debuggee_id
# ID of the debuggee whose breakpoint to delete.
# @param [String] breakpoint_id
# ID of the breakpoint to delete.
# @param [String] client_version
# The client version making the call.
# Following: `domain/type/version` (e.g., `google.com/intellij/v1`).
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ClouddebuggerV2::Empty] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ClouddebuggerV2::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_debugger_debuggee_breakpoint(debuggee_id, breakpoint_id, client_version: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:delete, 'v2/debugger/debuggees/{debuggeeId}/breakpoints/{breakpointId}', options)
command.response_representation = Google::Apis::ClouddebuggerV2::Empty::Representation
command.response_class = Google::Apis::ClouddebuggerV2::Empty
command.params['debuggeeId'] = debuggee_id unless debuggee_id.nil?
command.params['breakpointId'] = breakpoint_id unless breakpoint_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
# Gets breakpoint information.
# @param [String] debuggee_id
# ID of the debuggee whose breakpoint to get.
# @param [String] breakpoint_id
# ID of the breakpoint to get.
# @param [String] client_version
# The client version making the call.
# Following: `domain/type/version` (e.g., `google.com/intellij/v1`).
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ClouddebuggerV2::GetBreakpointResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ClouddebuggerV2::GetBreakpointResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_debugger_debuggee_breakpoint(debuggee_id, breakpoint_id, client_version: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v2/debugger/debuggees/{debuggeeId}/breakpoints/{breakpointId}', options)
command.response_representation = Google::Apis::ClouddebuggerV2::GetBreakpointResponse::Representation
command.response_class = Google::Apis::ClouddebuggerV2::GetBreakpointResponse
command.params['debuggeeId'] = debuggee_id unless debuggee_id.nil?
command.params['breakpointId'] = breakpoint_id unless breakpoint_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
# Lists all breakpoints for the debuggee.
# @param [String] debuggee_id
# ID of the debuggee whose breakpoints to list.
# @param [String] wait_token
# A wait token that, if specified, blocks the call until the breakpoints
# list has changed, or a server selected timeout has expired. The value
# should be set from the last response. The error code
# `google.rpc.Code.ABORTED` (RPC) is returned on wait timeout, which
# should be called again with the same `wait_token`.
# @param [String] action_value
# Only breakpoints with the specified action will pass the filter.
# @param [String] client_version
# The client version making the call.
# Following: `domain/type/version` (e.g., `google.com/intellij/v1`).
# @param [Boolean] include_inactive
# When set to `true`, the response includes active and inactive
# breakpoints. Otherwise, it includes only active breakpoints.
# @param [Boolean] include_all_users
# When set to `true`, the response includes the list of breakpoints set by
# any user. Otherwise, it includes only breakpoints set by the caller.
# @param [Boolean] strip_results
# This field is deprecated. The following fields are always stripped out of
# the result: `stack_frames`, `evaluated_expressions` and `variable_table`.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ClouddebuggerV2::ListBreakpointsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ClouddebuggerV2::ListBreakpointsResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_debugger_debuggee_breakpoints(debuggee_id, wait_token: nil, action_value: nil, client_version: nil, include_inactive: nil, include_all_users: nil, strip_results: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v2/debugger/debuggees/{debuggeeId}/breakpoints', options)
command.response_representation = Google::Apis::ClouddebuggerV2::ListBreakpointsResponse::Representation
command.response_class = Google::Apis::ClouddebuggerV2::ListBreakpointsResponse
command.params['debuggeeId'] = debuggee_id unless debuggee_id.nil?
command.query['waitToken'] = wait_token unless wait_token.nil?
command.query['action.value'] = action_value unless action_value.nil?
command.query['clientVersion'] = client_version unless client_version.nil?
command.query['includeInactive'] = include_inactive unless include_inactive.nil?
command.query['includeAllUsers'] = include_all_users unless include_all_users.nil?
command.query['stripResults'] = strip_results unless strip_results.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 the debuggee with the controller service.
# All agents attached to the same application should call this method with
# the same request content to get back the same stable `debuggee_id`. Agents
# should call this method again whenever `google.rpc.Code.NOT_FOUND` is
# returned from any controller method.
# This allows the controller service to disable the agent or recover from any
# data loss. If the debuggee is disabled by the server, the response will have `
# is_disabled` set to `true`.
# data loss. If the debuggee is disabled by the server, the response will
# have `is_disabled` set to `true`.
# @param [Google::Apis::ClouddebuggerV2::RegisterDebuggeeRequest] register_debuggee_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
@ -83,61 +289,14 @@ module Google
execute_or_queue_command(command, &block)
end
# Returns the list of all active breakpoints for the debuggee. The breakpoint
# specification (location, condition, and expression fields) is semantically
# immutable, although the field values may change. For example, an agent may
# update the location line number to reflect the actual line where the
# breakpoint was set, but this doesn't change the breakpoint semantics. This
# means that an agent does not need to check if a breakpoint has changed when it
# encounters the same breakpoint on a successive call. Moreover, an agent should
# remember the breakpoints that are completed until the controller removes them
# from the active list to avoid setting those breakpoints again.
# @param [String] debuggee_id
# Identifies the debuggee.
# @param [String] wait_token
# A wait token that, if specified, blocks the method call until the list of
# active breakpoints has changed, or a server selected timeout has expired. The
# value should be set from the last returned response.
# @param [Boolean] success_on_timeout
# If set to `true`, returns `google.rpc.Code.OK` status and sets the `
# wait_expired` response field to `true` when the server-selected timeout has
# expired (recommended). If set to `false`, returns `google.rpc.Code.ABORTED`
# status when the server-selected timeout has expired (deprecated).
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ClouddebuggerV2::ListActiveBreakpointsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ClouddebuggerV2::ListActiveBreakpointsResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_controller_debuggee_breakpoints(debuggee_id, wait_token: nil, success_on_timeout: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v2/controller/debuggees/{debuggeeId}/breakpoints', options)
command.response_representation = Google::Apis::ClouddebuggerV2::ListActiveBreakpointsResponse::Representation
command.response_class = Google::Apis::ClouddebuggerV2::ListActiveBreakpointsResponse
command.params['debuggeeId'] = debuggee_id unless debuggee_id.nil?
command.query['waitToken'] = wait_token unless wait_token.nil?
command.query['successOnTimeout'] = success_on_timeout unless success_on_timeout.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Updates the breakpoint state or mutable fields. The entire Breakpoint message
# must be sent back to the controller service. Updates to active breakpoint
# fields are only allowed if the new value does not change the breakpoint
# specification. Updates to the `location`, `condition` and `expression` fields
# should not alter the breakpoint semantics. These may only make changes such as
# canonicalizing a value or snapping the location to the correct line of code.
# Updates the breakpoint state or mutable fields.
# The entire Breakpoint message must be sent back to the controller
# service.
# Updates to active breakpoint fields are only allowed if the new value
# does not change the breakpoint specification. Updates to the `location`,
# `condition` and `expression` fields should not alter the breakpoint
# semantics. These may only make changes such as canonicalizing a value
# or snapping the location to the correct line of code.
# @param [String] debuggee_id
# Identifies the debuggee being debugged.
# @param [String] id
@ -173,178 +332,29 @@ module Google
execute_or_queue_command(command, &block)
end
# Lists all the debuggees that the user can set breakpoints to.
# @param [String] project
# Project number of a Google Cloud project whose debuggees to list.
# @param [Boolean] include_inactive
# When set to `true`, the result includes all debuggees. Otherwise, the result
# includes only debuggees that are active.
# @param [String] client_version
# The client version making the call. Following: `domain/type/version` (e.g., `
# google.com/intellij/v1`).
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ClouddebuggerV2::ListDebuggeesResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ClouddebuggerV2::ListDebuggeesResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_debugger_debuggees(project: nil, include_inactive: nil, client_version: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v2/debugger/debuggees', options)
command.response_representation = Google::Apis::ClouddebuggerV2::ListDebuggeesResponse::Representation
command.response_class = Google::Apis::ClouddebuggerV2::ListDebuggeesResponse
command.query['project'] = project unless project.nil?
command.query['includeInactive'] = include_inactive unless include_inactive.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
# Sets the breakpoint to the debuggee.
# Returns the list of all active breakpoints for the debuggee.
# The breakpoint specification (location, condition, and expression
# fields) is semantically immutable, although the field values may
# change. For example, an agent may update the location line number
# to reflect the actual line where the breakpoint was set, but this
# doesn't change the breakpoint semantics.
# This means that an agent does not need to check if a breakpoint has changed
# when it encounters the same breakpoint on a successive call.
# Moreover, an agent should remember the breakpoints that are completed
# until the controller removes them from the active list to avoid
# setting those breakpoints again.
# @param [String] debuggee_id
# ID of the debuggee where the breakpoint is to be set.
# @param [Google::Apis::ClouddebuggerV2::Breakpoint] breakpoint_object
# @param [String] client_version
# The client version making the call. Following: `domain/type/version` (e.g., `
# google.com/intellij/v1`).
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ClouddebuggerV2::SetBreakpointResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ClouddebuggerV2::SetBreakpointResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def set_debugger_debuggee_breakpoint(debuggee_id, breakpoint_object = nil, client_version: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v2/debugger/debuggees/{debuggeeId}/breakpoints/set', options)
command.request_representation = Google::Apis::ClouddebuggerV2::Breakpoint::Representation
command.request_object = breakpoint_object
command.response_representation = Google::Apis::ClouddebuggerV2::SetBreakpointResponse::Representation
command.response_class = Google::Apis::ClouddebuggerV2::SetBreakpointResponse
command.params['debuggeeId'] = debuggee_id unless debuggee_id.nil?
command.query['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
# Gets breakpoint information.
# @param [String] debuggee_id
# ID of the debuggee whose breakpoint to get.
# @param [String] breakpoint_id
# ID of the breakpoint to get.
# @param [String] client_version
# The client version making the call. Following: `domain/type/version` (e.g., `
# google.com/intellij/v1`).
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ClouddebuggerV2::GetBreakpointResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ClouddebuggerV2::GetBreakpointResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_debugger_debuggee_breakpoint(debuggee_id, breakpoint_id, client_version: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v2/debugger/debuggees/{debuggeeId}/breakpoints/{breakpointId}', options)
command.response_representation = Google::Apis::ClouddebuggerV2::GetBreakpointResponse::Representation
command.response_class = Google::Apis::ClouddebuggerV2::GetBreakpointResponse
command.params['debuggeeId'] = debuggee_id unless debuggee_id.nil?
command.params['breakpointId'] = breakpoint_id unless breakpoint_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
# Deletes the breakpoint from the debuggee.
# @param [String] debuggee_id
# ID of the debuggee whose breakpoint to delete.
# @param [String] breakpoint_id
# ID of the breakpoint to delete.
# @param [String] client_version
# The client version making the call. Following: `domain/type/version` (e.g., `
# google.com/intellij/v1`).
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ClouddebuggerV2::Empty] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ClouddebuggerV2::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_debugger_debuggee_breakpoint(debuggee_id, breakpoint_id, client_version: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:delete, 'v2/debugger/debuggees/{debuggeeId}/breakpoints/{breakpointId}', options)
command.response_representation = Google::Apis::ClouddebuggerV2::Empty::Representation
command.response_class = Google::Apis::ClouddebuggerV2::Empty
command.params['debuggeeId'] = debuggee_id unless debuggee_id.nil?
command.params['breakpointId'] = breakpoint_id unless breakpoint_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
# Lists all breakpoints for the debuggee.
# @param [String] debuggee_id
# ID of the debuggee whose breakpoints to list.
# @param [Boolean] include_all_users
# When set to `true`, the response includes the list of breakpoints set by any
# user. Otherwise, it includes only breakpoints set by the caller.
# @param [Boolean] include_inactive
# When set to `true`, the response includes active and inactive breakpoints.
# Otherwise, it includes only active breakpoints.
# @param [String] action_value
# Only breakpoints with the specified action will pass the filter.
# @param [Boolean] strip_results
# When set to `true`, the response breakpoints are stripped of the results
# fields: `stack_frames`, `evaluated_expressions` and `variable_table`.
# Identifies the debuggee.
# @param [String] wait_token
# A wait token that, if specified, blocks the call until the breakpoints list
# has changed, or a server selected timeout has expired. The value should be set
# from the last response. The error code `google.rpc.Code.ABORTED` (RPC) is
# returned on wait timeout, which should be called again with the same `
# wait_token`.
# @param [String] client_version
# The client version making the call. Following: `domain/type/version` (e.g., `
# google.com/intellij/v1`).
# A wait token that, if specified, blocks the method call until the list
# of active breakpoints has changed, or a server selected timeout has
# expired. The value should be set from the last returned response.
# @param [Boolean] success_on_timeout
# If set to `true`, returns `google.rpc.Code.OK` status and sets the
# `wait_expired` response field to `true` when the server-selected timeout
# has expired (recommended).
# If set to `false`, returns `google.rpc.Code.ABORTED` status when the
# server-selected timeout has expired (deprecated).
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@ -354,25 +364,21 @@ module Google
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::ClouddebuggerV2::ListBreakpointsResponse] parsed result object
# @yieldparam result [Google::Apis::ClouddebuggerV2::ListActiveBreakpointsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ClouddebuggerV2::ListBreakpointsResponse]
# @return [Google::Apis::ClouddebuggerV2::ListActiveBreakpointsResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_debugger_debuggee_breakpoints(debuggee_id, include_all_users: nil, include_inactive: nil, action_value: nil, strip_results: nil, wait_token: nil, client_version: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v2/debugger/debuggees/{debuggeeId}/breakpoints', options)
command.response_representation = Google::Apis::ClouddebuggerV2::ListBreakpointsResponse::Representation
command.response_class = Google::Apis::ClouddebuggerV2::ListBreakpointsResponse
def list_controller_debuggee_breakpoints(debuggee_id, wait_token: nil, success_on_timeout: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v2/controller/debuggees/{debuggeeId}/breakpoints', options)
command.response_representation = Google::Apis::ClouddebuggerV2::ListActiveBreakpointsResponse::Representation
command.response_class = Google::Apis::ClouddebuggerV2::ListActiveBreakpointsResponse
command.params['debuggeeId'] = debuggee_id unless debuggee_id.nil?
command.query['includeAllUsers'] = include_all_users unless include_all_users.nil?
command.query['includeInactive'] = include_inactive unless include_inactive.nil?
command.query['action.value'] = action_value unless action_value.nil?
command.query['stripResults'] = strip_results unless strip_results.nil?
command.query['waitToken'] = wait_token unless wait_token.nil?
command.query['clientVersion'] = client_version unless client_version.nil?
command.query['successOnTimeout'] = success_on_timeout unless success_on_timeout.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)

View File

@ -0,0 +1,35 @@
# Copyright 2015 Google Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES 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/cloudkms_v1/service.rb'
require 'google/apis/cloudkms_v1/classes.rb'
require 'google/apis/cloudkms_v1/representations.rb'
module Google
module Apis
# Google Cloud Key Management Service (KMS) API
#
# Manages encryption for your cloud services the same way you do on-premise. You
# can generate, use, rotate, and destroy AES256 encryption keys.
#
# @see https://cloud.google.com/kms/
module CloudkmsV1
VERSION = 'V1'
REVISION = '20170320'
# View and manage your data across Google Cloud Platform services
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'
end
end
end

File diff suppressed because it is too large Load Diff

View File

@ -0,0 +1,448 @@
# Copyright 2015 Google Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES 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 CloudkmsV1
class Location
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class ListCryptoKeysResponse
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 CounterOptions
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 DecryptResponse
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 Policy
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 KeyRing
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class EncryptResponse
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class RestoreCryptoKeyVersionRequest
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class UpdateCryptoKeyPrimaryVersionRequest
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class ListKeyRingsResponse
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class DataAccessOptions
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 CryptoKeyVersion
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class CloudAuditOptions
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 EncryptRequest
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class ListCryptoKeyVersionsResponse
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 DestroyCryptoKeyVersionRequest
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class CryptoKey
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 LogConfig
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 DecryptRequest
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class Location
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :name, as: 'name'
property :location_id, as: 'locationId'
hash :metadata, as: 'metadata'
hash :labels, as: 'labels'
end
end
class ListCryptoKeysResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :next_page_token, as: 'nextPageToken'
collection :crypto_keys, as: 'cryptoKeys', class: Google::Apis::CloudkmsV1::CryptoKey, decorator: Google::Apis::CloudkmsV1::CryptoKey::Representation
property :total_size, as: 'totalSize'
end
end
class Condition
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :op, as: 'op'
property :svc, as: 'svc'
property :value, as: 'value'
property :sys, as: 'sys'
property :iam, as: 'iam'
collection :values, as: 'values'
end
end
class CounterOptions
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :metric, as: 'metric'
property :field, as: 'field'
end
end
class AuditLogConfig
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :exempted_members, as: 'exemptedMembers'
property :log_type, as: 'logType'
end
end
class DecryptResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :plaintext, :base64 => true, as: 'plaintext'
end
end
class TestIamPermissionsRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :permissions, as: 'permissions'
end
end
class Policy
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :etag, :base64 => true, as: 'etag'
property :iam_owned, as: 'iamOwned'
collection :rules, as: 'rules', class: Google::Apis::CloudkmsV1::Rule, decorator: Google::Apis::CloudkmsV1::Rule::Representation
property :version, as: 'version'
collection :audit_configs, as: 'auditConfigs', class: Google::Apis::CloudkmsV1::AuditConfig, decorator: Google::Apis::CloudkmsV1::AuditConfig::Representation
collection :bindings, as: 'bindings', class: Google::Apis::CloudkmsV1::Binding, decorator: Google::Apis::CloudkmsV1::Binding::Representation
end
end
class ListLocationsResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :locations, as: 'locations', class: Google::Apis::CloudkmsV1::Location, decorator: Google::Apis::CloudkmsV1::Location::Representation
property :next_page_token, as: 'nextPageToken'
end
end
class KeyRing
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :name, as: 'name'
property :create_time, as: 'createTime'
end
end
class EncryptResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :name, as: 'name'
property :ciphertext, :base64 => true, as: 'ciphertext'
end
end
class RestoreCryptoKeyVersionRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation
end
end
class UpdateCryptoKeyPrimaryVersionRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :crypto_key_version_id, as: 'cryptoKeyVersionId'
end
end
class ListKeyRingsResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :next_page_token, as: 'nextPageToken'
property :total_size, as: 'totalSize'
collection :key_rings, as: 'keyRings', class: Google::Apis::CloudkmsV1::KeyRing, decorator: Google::Apis::CloudkmsV1::KeyRing::Representation
end
end
class DataAccessOptions
# @private
class Representation < Google::Apis::Core::JsonRepresentation
end
end
class AuditConfig
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :service, as: 'service'
collection :audit_log_configs, as: 'auditLogConfigs', class: Google::Apis::CloudkmsV1::AuditLogConfig, decorator: Google::Apis::CloudkmsV1::AuditLogConfig::Representation
collection :exempted_members, as: 'exemptedMembers'
end
end
class CryptoKeyVersion
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :destroy_time, as: 'destroyTime'
property :create_time, as: 'createTime'
property :state, as: 'state'
property :name, as: 'name'
property :destroy_event_time, as: 'destroyEventTime'
end
end
class CloudAuditOptions
# @private
class Representation < Google::Apis::Core::JsonRepresentation
end
end
class Binding
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :members, as: 'members'
property :role, as: 'role'
end
end
class EncryptRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :additional_authenticated_data, :base64 => true, as: 'additionalAuthenticatedData'
property :plaintext, :base64 => true, as: 'plaintext'
end
end
class ListCryptoKeyVersionsResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :next_page_token, as: 'nextPageToken'
property :total_size, as: 'totalSize'
collection :crypto_key_versions, as: 'cryptoKeyVersions', class: Google::Apis::CloudkmsV1::CryptoKeyVersion, decorator: Google::Apis::CloudkmsV1::CryptoKeyVersion::Representation
end
end
class TestIamPermissionsResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :permissions, as: 'permissions'
end
end
class DestroyCryptoKeyVersionRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation
end
end
class CryptoKey
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :purpose, as: 'purpose'
property :next_rotation_time, as: 'nextRotationTime'
property :create_time, as: 'createTime'
property :rotation_period, as: 'rotationPeriod'
property :primary, as: 'primary', class: Google::Apis::CloudkmsV1::CryptoKeyVersion, decorator: Google::Apis::CloudkmsV1::CryptoKeyVersion::Representation
property :name, as: 'name'
end
end
class Rule
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :log_config, as: 'logConfig', class: Google::Apis::CloudkmsV1::LogConfig, decorator: Google::Apis::CloudkmsV1::LogConfig::Representation
collection :in, as: 'in'
collection :permissions, as: 'permissions'
property :action, as: 'action'
collection :not_in, as: 'notIn'
property :description, as: 'description'
collection :conditions, as: 'conditions', class: Google::Apis::CloudkmsV1::Condition, decorator: Google::Apis::CloudkmsV1::Condition::Representation
end
end
class LogConfig
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :cloud_audit, as: 'cloudAudit', class: Google::Apis::CloudkmsV1::CloudAuditOptions, decorator: Google::Apis::CloudkmsV1::CloudAuditOptions::Representation
property :counter, as: 'counter', class: Google::Apis::CloudkmsV1::CounterOptions, decorator: Google::Apis::CloudkmsV1::CounterOptions::Representation
property :data_access, as: 'dataAccess', class: Google::Apis::CloudkmsV1::DataAccessOptions, decorator: Google::Apis::CloudkmsV1::DataAccessOptions::Representation
end
end
class SetIamPolicyRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :update_mask, as: 'updateMask'
property :policy, as: 'policy', class: Google::Apis::CloudkmsV1::Policy, decorator: Google::Apis::CloudkmsV1::Policy::Representation
end
end
class DecryptRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :ciphertext, :base64 => true, as: 'ciphertext'
property :additional_authenticated_data, :base64 => true, as: 'additionalAuthenticatedData'
end
end
end
end
end

View File

@ -0,0 +1,933 @@
# Copyright 2015 Google Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES 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 CloudkmsV1
# Google Cloud Key Management Service (KMS) API
#
# Manages encryption for your cloud services the same way you do on-premise. You
# can generate, use, rotate, and destroy AES256 encryption keys.
#
# @example
# require 'google/apis/cloudkms_v1'
#
# Cloudkms = Google::Apis::CloudkmsV1 # Alias the module
# service = Cloudkms::CloudKMSService.new
#
# @see https://cloud.google.com/kms/
class CloudKMSService < 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://cloudkms.googleapis.com/', '')
end
# Lists information about the supported locations for this service.
# @param [String] name
# The resource that owns the locations collection, if applicable.
# @param [String] page_token
# The standard list page token.
# @param [Fixnum] page_size
# The standard list page size.
# @param [String] filter
# The standard list filter.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::CloudkmsV1::ListLocationsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudkmsV1::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, page_token: nil, page_size: nil, filter: nil, quota_user: nil, fields: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+name}/locations', options)
command.response_representation = Google::Apis::CloudkmsV1::ListLocationsResponse::Representation
command.response_class = Google::Apis::CloudkmsV1::ListLocationsResponse
command.params['name'] = name unless name.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['pageSize'] = page_size unless page_size.nil?
command.query['filter'] = filter unless filter.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['fields'] = fields unless fields.nil?
execute_or_queue_command(command, &block)
end
# Get information about a location.
# @param [String] name
# Resource name for the location.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::CloudkmsV1::Location] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudkmsV1::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, quota_user: nil, fields: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+name}', options)
command.response_representation = Google::Apis::CloudkmsV1::Location::Representation
command.response_class = Google::Apis::CloudkmsV1::Location
command.params['name'] = name unless name.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['fields'] = fields unless fields.nil?
execute_or_queue_command(command, &block)
end
# Create a new KeyRing in a given Project and Location.
# @param [String] parent
# Required. The resource name of the location associated with the
# KeyRings, in the format `projects/*/locations/*`.
# @param [Google::Apis::CloudkmsV1::KeyRing] key_ring_object
# @param [String] key_ring_id
# Required. It must be unique within a location and match the regular
# expression `[a-zA-Z0-9_-]`1,63``
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::CloudkmsV1::KeyRing] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudkmsV1::KeyRing]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_key_ring(parent, key_ring_object = nil, key_ring_id: nil, quota_user: nil, fields: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+parent}/keyRings', options)
command.request_representation = Google::Apis::CloudkmsV1::KeyRing::Representation
command.request_object = key_ring_object
command.response_representation = Google::Apis::CloudkmsV1::KeyRing::Representation
command.response_class = Google::Apis::CloudkmsV1::KeyRing
command.params['parent'] = parent unless parent.nil?
command.query['keyRingId'] = key_ring_id unless key_ring_id.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['fields'] = fields unless fields.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::CloudkmsV1::SetIamPolicyRequest] set_iam_policy_request_object
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::CloudkmsV1::Policy] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudkmsV1::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_key_ring_iam_policy(resource, set_iam_policy_request_object = nil, quota_user: nil, fields: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+resource}:setIamPolicy', options)
command.request_representation = Google::Apis::CloudkmsV1::SetIamPolicyRequest::Representation
command.request_object = set_iam_policy_request_object
command.response_representation = Google::Apis::CloudkmsV1::Policy::Representation
command.response_class = Google::Apis::CloudkmsV1::Policy
command.params['resource'] = resource unless resource.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['fields'] = fields unless fields.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] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::CloudkmsV1::Policy] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudkmsV1::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_location_key_ring_iam_policy(resource, quota_user: nil, fields: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+resource}:getIamPolicy', options)
command.response_representation = Google::Apis::CloudkmsV1::Policy::Representation
command.response_class = Google::Apis::CloudkmsV1::Policy
command.params['resource'] = resource unless resource.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['fields'] = fields unless fields.nil?
execute_or_queue_command(command, &block)
end
# Returns metadata for a given KeyRing.
# @param [String] name
# The name of the KeyRing to get.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::CloudkmsV1::KeyRing] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudkmsV1::KeyRing]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @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_key_ring(name, quota_user: nil, fields: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+name}', options)
command.response_representation = Google::Apis::CloudkmsV1::KeyRing::Representation
command.response_class = Google::Apis::CloudkmsV1::KeyRing
command.params['name'] = name unless name.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['fields'] = fields unless fields.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::CloudkmsV1::TestIamPermissionsRequest] test_iam_permissions_request_object
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::CloudkmsV1::TestIamPermissionsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudkmsV1::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_key_ring_iam_permissions(resource, test_iam_permissions_request_object = nil, quota_user: nil, fields: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+resource}:testIamPermissions', options)
command.request_representation = Google::Apis::CloudkmsV1::TestIamPermissionsRequest::Representation
command.request_object = test_iam_permissions_request_object
command.response_representation = Google::Apis::CloudkmsV1::TestIamPermissionsResponse::Representation
command.response_class = Google::Apis::CloudkmsV1::TestIamPermissionsResponse
command.params['resource'] = resource unless resource.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['fields'] = fields unless fields.nil?
execute_or_queue_command(command, &block)
end
# Lists KeyRings.
# @param [String] parent
# Required. The resource name of the location associated with the
# KeyRings, in the format `projects/*/locations/*`.
# @param [String] page_token
# Optional pagination token, returned earlier via
# ListKeyRingsResponse.next_page_token.
# @param [Fixnum] page_size
# Optional limit on the number of KeyRings to include in the
# response. Further KeyRings can subsequently be obtained by
# including the ListKeyRingsResponse.next_page_token in a subsequent
# request. If unspecified, the server will pick an appropriate default.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::CloudkmsV1::ListKeyRingsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudkmsV1::ListKeyRingsResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @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_key_rings(parent, page_token: nil, page_size: nil, quota_user: nil, fields: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+parent}/keyRings', options)
command.response_representation = Google::Apis::CloudkmsV1::ListKeyRingsResponse::Representation
command.response_class = Google::Apis::CloudkmsV1::ListKeyRingsResponse
command.params['parent'] = parent unless parent.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['pageSize'] = page_size unless page_size.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['fields'] = fields unless fields.nil?
execute_or_queue_command(command, &block)
end
# Encrypt data, so that it can only be recovered by a call to Decrypt.
# @param [String] name
# Required. The resource name of the CryptoKey or CryptoKeyVersion
# to use for encryption.
# If a CryptoKey is specified, the server will use its
# primary version.
# @param [Google::Apis::CloudkmsV1::EncryptRequest] encrypt_request_object
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::CloudkmsV1::EncryptResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudkmsV1::EncryptResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def encrypt_crypto_key(name, encrypt_request_object = nil, quota_user: nil, fields: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+name}:encrypt', options)
command.request_representation = Google::Apis::CloudkmsV1::EncryptRequest::Representation
command.request_object = encrypt_request_object
command.response_representation = Google::Apis::CloudkmsV1::EncryptResponse::Representation
command.response_class = Google::Apis::CloudkmsV1::EncryptResponse
command.params['name'] = name unless name.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['fields'] = fields unless fields.nil?
execute_or_queue_command(command, &block)
end
# Create a new CryptoKey within a KeyRing.
# CryptoKey.purpose is required.
# @param [String] parent
# Required. The name of the KeyRing associated with the
# CryptoKeys.
# @param [Google::Apis::CloudkmsV1::CryptoKey] crypto_key_object
# @param [String] crypto_key_id
# Required. It must be unique within a KeyRing and match the regular
# expression `[a-zA-Z0-9_-]`1,63``
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::CloudkmsV1::CryptoKey] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudkmsV1::CryptoKey]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_key_ring_crypto_key(parent, crypto_key_object = nil, crypto_key_id: nil, quota_user: nil, fields: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+parent}/cryptoKeys', options)
command.request_representation = Google::Apis::CloudkmsV1::CryptoKey::Representation
command.request_object = crypto_key_object
command.response_representation = Google::Apis::CloudkmsV1::CryptoKey::Representation
command.response_class = Google::Apis::CloudkmsV1::CryptoKey
command.params['parent'] = parent unless parent.nil?
command.query['cryptoKeyId'] = crypto_key_id unless crypto_key_id.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['fields'] = fields unless fields.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::CloudkmsV1::SetIamPolicyRequest] set_iam_policy_request_object
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::CloudkmsV1::Policy] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudkmsV1::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_crypto_key_iam_policy(resource, set_iam_policy_request_object = nil, quota_user: nil, fields: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+resource}:setIamPolicy', options)
command.request_representation = Google::Apis::CloudkmsV1::SetIamPolicyRequest::Representation
command.request_object = set_iam_policy_request_object
command.response_representation = Google::Apis::CloudkmsV1::Policy::Representation
command.response_class = Google::Apis::CloudkmsV1::Policy
command.params['resource'] = resource unless resource.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['fields'] = fields unless fields.nil?
execute_or_queue_command(command, &block)
end
# Update the version of a CryptoKey that will be used in Encrypt
# @param [String] name
# The resource name of the CryptoKey to update.
# @param [Google::Apis::CloudkmsV1::UpdateCryptoKeyPrimaryVersionRequest] update_crypto_key_primary_version_request_object
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::CloudkmsV1::CryptoKey] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudkmsV1::CryptoKey]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_key_ring_crypto_key_primary_version(name, update_crypto_key_primary_version_request_object = nil, quota_user: nil, fields: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+name}:updatePrimaryVersion', options)
command.request_representation = Google::Apis::CloudkmsV1::UpdateCryptoKeyPrimaryVersionRequest::Representation
command.request_object = update_crypto_key_primary_version_request_object
command.response_representation = Google::Apis::CloudkmsV1::CryptoKey::Representation
command.response_class = Google::Apis::CloudkmsV1::CryptoKey
command.params['name'] = name unless name.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['fields'] = fields unless fields.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] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::CloudkmsV1::Policy] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudkmsV1::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_location_key_ring_crypto_key_iam_policy(resource, quota_user: nil, fields: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+resource}:getIamPolicy', options)
command.response_representation = Google::Apis::CloudkmsV1::Policy::Representation
command.response_class = Google::Apis::CloudkmsV1::Policy
command.params['resource'] = resource unless resource.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['fields'] = fields unless fields.nil?
execute_or_queue_command(command, &block)
end
# Update a CryptoKey.
# @param [String] name
# Output only. The resource name for this CryptoKey in the format
# `projects/*/locations/*/keyRings/*/cryptoKeys/*`.
# @param [Google::Apis::CloudkmsV1::CryptoKey] crypto_key_object
# @param [String] update_mask
# Required list of fields to be updated in this request.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::CloudkmsV1::CryptoKey] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudkmsV1::CryptoKey]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_key_ring_crypto_key(name, crypto_key_object = nil, update_mask: nil, quota_user: nil, fields: nil, options: nil, &block)
command = make_simple_command(:patch, 'v1/{+name}', options)
command.request_representation = Google::Apis::CloudkmsV1::CryptoKey::Representation
command.request_object = crypto_key_object
command.response_representation = Google::Apis::CloudkmsV1::CryptoKey::Representation
command.response_class = Google::Apis::CloudkmsV1::CryptoKey
command.params['name'] = name unless name.nil?
command.query['updateMask'] = update_mask unless update_mask.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['fields'] = fields unless fields.nil?
execute_or_queue_command(command, &block)
end
# Returns metadata for a given CryptoKey, as well as its
# primary CryptoKeyVersion.
# @param [String] name
# The name of the CryptoKey to get.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::CloudkmsV1::CryptoKey] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudkmsV1::CryptoKey]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @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_key_ring_crypto_key(name, quota_user: nil, fields: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+name}', options)
command.response_representation = Google::Apis::CloudkmsV1::CryptoKey::Representation
command.response_class = Google::Apis::CloudkmsV1::CryptoKey
command.params['name'] = name unless name.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['fields'] = fields unless fields.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::CloudkmsV1::TestIamPermissionsRequest] test_iam_permissions_request_object
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::CloudkmsV1::TestIamPermissionsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudkmsV1::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_crypto_key_iam_permissions(resource, test_iam_permissions_request_object = nil, quota_user: nil, fields: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+resource}:testIamPermissions', options)
command.request_representation = Google::Apis::CloudkmsV1::TestIamPermissionsRequest::Representation
command.request_object = test_iam_permissions_request_object
command.response_representation = Google::Apis::CloudkmsV1::TestIamPermissionsResponse::Representation
command.response_class = Google::Apis::CloudkmsV1::TestIamPermissionsResponse
command.params['resource'] = resource unless resource.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['fields'] = fields unless fields.nil?
execute_or_queue_command(command, &block)
end
# Decrypt data that was protected by Encrypt.
# @param [String] name
# Required. The resource name of the CryptoKey to use for decryption.
# The server will choose the appropriate version.
# @param [Google::Apis::CloudkmsV1::DecryptRequest] decrypt_request_object
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::CloudkmsV1::DecryptResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudkmsV1::DecryptResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def decrypt_crypto_key(name, decrypt_request_object = nil, quota_user: nil, fields: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+name}:decrypt', options)
command.request_representation = Google::Apis::CloudkmsV1::DecryptRequest::Representation
command.request_object = decrypt_request_object
command.response_representation = Google::Apis::CloudkmsV1::DecryptResponse::Representation
command.response_class = Google::Apis::CloudkmsV1::DecryptResponse
command.params['name'] = name unless name.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['fields'] = fields unless fields.nil?
execute_or_queue_command(command, &block)
end
# Lists CryptoKeys.
# @param [String] parent
# Required. The resource name of the KeyRing to list, in the format
# `projects/*/locations/*/keyRings/*`.
# @param [String] page_token
# Optional pagination token, returned earlier via
# ListCryptoKeysResponse.next_page_token.
# @param [Fixnum] page_size
# Optional limit on the number of CryptoKeys to include in the
# response. Further CryptoKeys can subsequently be obtained by
# including the ListCryptoKeysResponse.next_page_token in a subsequent
# request. If unspecified, the server will pick an appropriate default.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::CloudkmsV1::ListCryptoKeysResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudkmsV1::ListCryptoKeysResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @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_key_ring_crypto_keys(parent, page_token: nil, page_size: nil, quota_user: nil, fields: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+parent}/cryptoKeys', options)
command.response_representation = Google::Apis::CloudkmsV1::ListCryptoKeysResponse::Representation
command.response_class = Google::Apis::CloudkmsV1::ListCryptoKeysResponse
command.params['parent'] = parent unless parent.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['pageSize'] = page_size unless page_size.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['fields'] = fields unless fields.nil?
execute_or_queue_command(command, &block)
end
# Lists CryptoKeyVersions.
# @param [String] parent
# Required. The resource name of the CryptoKey to list, in the format
# `projects/*/locations/*/keyRings/*/cryptoKeys/*`.
# @param [String] page_token
# Optional pagination token, returned earlier via
# ListCryptoKeyVersionsResponse.next_page_token.
# @param [Fixnum] page_size
# Optional limit on the number of CryptoKeyVersions to
# include in the response. Further CryptoKeyVersions can
# subsequently be obtained by including the
# ListCryptoKeyVersionsResponse.next_page_token in a subsequent request.
# If unspecified, the server will pick an appropriate default.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::CloudkmsV1::ListCryptoKeyVersionsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudkmsV1::ListCryptoKeyVersionsResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @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_key_ring_crypto_key_crypto_key_versions(parent, page_token: nil, page_size: nil, quota_user: nil, fields: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+parent}/cryptoKeyVersions', options)
command.response_representation = Google::Apis::CloudkmsV1::ListCryptoKeyVersionsResponse::Representation
command.response_class = Google::Apis::CloudkmsV1::ListCryptoKeyVersionsResponse
command.params['parent'] = parent unless parent.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['pageSize'] = page_size unless page_size.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['fields'] = fields unless fields.nil?
execute_or_queue_command(command, &block)
end
# Create a new CryptoKeyVersion in a CryptoKey.
# The server will assign the next sequential id. If unset,
# state will be set to
# ENABLED.
# @param [String] parent
# Required. The name of the CryptoKey associated with
# the CryptoKeyVersions.
# @param [Google::Apis::CloudkmsV1::CryptoKeyVersion] crypto_key_version_object
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::CloudkmsV1::CryptoKeyVersion] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudkmsV1::CryptoKeyVersion]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_key_ring_crypto_key_crypto_key_version(parent, crypto_key_version_object = nil, quota_user: nil, fields: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+parent}/cryptoKeyVersions', options)
command.request_representation = Google::Apis::CloudkmsV1::CryptoKeyVersion::Representation
command.request_object = crypto_key_version_object
command.response_representation = Google::Apis::CloudkmsV1::CryptoKeyVersion::Representation
command.response_class = Google::Apis::CloudkmsV1::CryptoKeyVersion
command.params['parent'] = parent unless parent.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['fields'] = fields unless fields.nil?
execute_or_queue_command(command, &block)
end
# Schedule a CryptoKeyVersion for destruction.
# Upon calling this method, CryptoKeyVersion.state will be set to
# DESTROY_SCHEDULED
# and destroy_time will be set to a time 24
# hours in the future, at which point the state
# will be changed to
# DESTROYED, and the key
# material will be irrevocably destroyed.
# Before the destroy_time is reached,
# RestoreCryptoKeyVersion may be called to reverse the process.
# @param [String] name
# The resource name of the CryptoKeyVersion to destroy.
# @param [Google::Apis::CloudkmsV1::DestroyCryptoKeyVersionRequest] destroy_crypto_key_version_request_object
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::CloudkmsV1::CryptoKeyVersion] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudkmsV1::CryptoKeyVersion]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def destroy_crypto_key_version(name, destroy_crypto_key_version_request_object = nil, quota_user: nil, fields: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+name}:destroy', options)
command.request_representation = Google::Apis::CloudkmsV1::DestroyCryptoKeyVersionRequest::Representation
command.request_object = destroy_crypto_key_version_request_object
command.response_representation = Google::Apis::CloudkmsV1::CryptoKeyVersion::Representation
command.response_class = Google::Apis::CloudkmsV1::CryptoKeyVersion
command.params['name'] = name unless name.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['fields'] = fields unless fields.nil?
execute_or_queue_command(command, &block)
end
# Restore a CryptoKeyVersion in the
# DESTROY_SCHEDULED,
# state.
# Upon restoration of the CryptoKeyVersion, state
# will be set to DISABLED,
# and destroy_time will be cleared.
# @param [String] name
# The resource name of the CryptoKeyVersion to restore.
# @param [Google::Apis::CloudkmsV1::RestoreCryptoKeyVersionRequest] restore_crypto_key_version_request_object
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::CloudkmsV1::CryptoKeyVersion] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudkmsV1::CryptoKeyVersion]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_crypto_key_version(name, restore_crypto_key_version_request_object = nil, quota_user: nil, fields: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+name}:restore', options)
command.request_representation = Google::Apis::CloudkmsV1::RestoreCryptoKeyVersionRequest::Representation
command.request_object = restore_crypto_key_version_request_object
command.response_representation = Google::Apis::CloudkmsV1::CryptoKeyVersion::Representation
command.response_class = Google::Apis::CloudkmsV1::CryptoKeyVersion
command.params['name'] = name unless name.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['fields'] = fields unless fields.nil?
execute_or_queue_command(command, &block)
end
# Update a CryptoKeyVersion's metadata.
# state may be changed between
# ENABLED and
# DISABLED using this
# method. See DestroyCryptoKeyVersion and RestoreCryptoKeyVersion to
# move between other states.
# @param [String] name
# Output only. The resource name for this CryptoKeyVersion in the format
# `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.
# @param [Google::Apis::CloudkmsV1::CryptoKeyVersion] crypto_key_version_object
# @param [String] update_mask
# Required list of fields to be updated in this request.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::CloudkmsV1::CryptoKeyVersion] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudkmsV1::CryptoKeyVersion]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_key_ring_crypto_key_crypto_key_version(name, crypto_key_version_object = nil, update_mask: nil, quota_user: nil, fields: nil, options: nil, &block)
command = make_simple_command(:patch, 'v1/{+name}', options)
command.request_representation = Google::Apis::CloudkmsV1::CryptoKeyVersion::Representation
command.request_object = crypto_key_version_object
command.response_representation = Google::Apis::CloudkmsV1::CryptoKeyVersion::Representation
command.response_class = Google::Apis::CloudkmsV1::CryptoKeyVersion
command.params['name'] = name unless name.nil?
command.query['updateMask'] = update_mask unless update_mask.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['fields'] = fields unless fields.nil?
execute_or_queue_command(command, &block)
end
# Returns metadata for a given CryptoKeyVersion.
# @param [String] name
# The name of the CryptoKeyVersion to get.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::CloudkmsV1::CryptoKeyVersion] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudkmsV1::CryptoKeyVersion]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @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_key_ring_crypto_key_crypto_key_version(name, quota_user: nil, fields: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+name}', options)
command.response_representation = Google::Apis::CloudkmsV1::CryptoKeyVersion::Representation
command.response_class = Google::Apis::CloudkmsV1::CryptoKeyVersion
command.params['name'] = name unless name.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['fields'] = fields unless fields.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

View File

@ -0,0 +1,35 @@
# Copyright 2015 Google Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES 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/cloudkms_v1beta1/service.rb'
require 'google/apis/cloudkms_v1beta1/classes.rb'
require 'google/apis/cloudkms_v1beta1/representations.rb'
module Google
module Apis
# Google Cloud Key Management Service (KMS) API
#
# Manages encryption for your cloud services the same way you do on-premise. You
# can generate, use, rotate, and destroy AES256 encryption keys.
#
# @see https://cloud.google.com/kms/
module CloudkmsV1beta1
VERSION = 'V1beta1'
REVISION = '20170301'
# View and manage your data across Google Cloud Platform services
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'
end
end
end

File diff suppressed because it is too large Load Diff

View File

@ -0,0 +1,448 @@
# Copyright 2015 Google Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES 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 CloudkmsV1beta1
class CloudAuditOptions
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 EncryptRequest
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class ListCryptoKeyVersionsResponse
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 DestroyCryptoKeyVersionRequest
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class CryptoKey
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 LogConfig
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 DecryptRequest
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 ListCryptoKeysResponse
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 CounterOptions
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 DecryptResponse
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 KeyRing
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class EncryptResponse
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 Policy
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class UpdateCryptoKeyPrimaryVersionRequest
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class RestoreCryptoKeyVersionRequest
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class DataAccessOptions
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class ListKeyRingsResponse
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 CryptoKeyVersion
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class CloudAuditOptions
# @private
class Representation < Google::Apis::Core::JsonRepresentation
end
end
class Binding
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :members, as: 'members'
property :role, as: 'role'
end
end
class EncryptRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :additional_authenticated_data, :base64 => true, as: 'additionalAuthenticatedData'
property :plaintext, :base64 => true, as: 'plaintext'
end
end
class ListCryptoKeyVersionsResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :next_page_token, as: 'nextPageToken'
property :total_size, as: 'totalSize'
collection :crypto_key_versions, as: 'cryptoKeyVersions', class: Google::Apis::CloudkmsV1beta1::CryptoKeyVersion, decorator: Google::Apis::CloudkmsV1beta1::CryptoKeyVersion::Representation
end
end
class TestIamPermissionsResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :permissions, as: 'permissions'
end
end
class DestroyCryptoKeyVersionRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation
end
end
class CryptoKey
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :create_time, as: 'createTime'
property :rotation_period, as: 'rotationPeriod'
property :primary, as: 'primary', class: Google::Apis::CloudkmsV1beta1::CryptoKeyVersion, decorator: Google::Apis::CloudkmsV1beta1::CryptoKeyVersion::Representation
property :name, as: 'name'
property :purpose, as: 'purpose'
property :next_rotation_time, as: 'nextRotationTime'
end
end
class Rule
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :permissions, as: 'permissions'
property :action, as: 'action'
collection :not_in, as: 'notIn'
property :description, as: 'description'
collection :conditions, as: 'conditions', class: Google::Apis::CloudkmsV1beta1::Condition, decorator: Google::Apis::CloudkmsV1beta1::Condition::Representation
collection :log_config, as: 'logConfig', class: Google::Apis::CloudkmsV1beta1::LogConfig, decorator: Google::Apis::CloudkmsV1beta1::LogConfig::Representation
collection :in, as: 'in'
end
end
class LogConfig
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :data_access, as: 'dataAccess', class: Google::Apis::CloudkmsV1beta1::DataAccessOptions, decorator: Google::Apis::CloudkmsV1beta1::DataAccessOptions::Representation
property :cloud_audit, as: 'cloudAudit', class: Google::Apis::CloudkmsV1beta1::CloudAuditOptions, decorator: Google::Apis::CloudkmsV1beta1::CloudAuditOptions::Representation
property :counter, as: 'counter', class: Google::Apis::CloudkmsV1beta1::CounterOptions, decorator: Google::Apis::CloudkmsV1beta1::CounterOptions::Representation
end
end
class SetIamPolicyRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :policy, as: 'policy', class: Google::Apis::CloudkmsV1beta1::Policy, decorator: Google::Apis::CloudkmsV1beta1::Policy::Representation
property :update_mask, as: 'updateMask'
end
end
class DecryptRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :ciphertext, :base64 => true, as: 'ciphertext'
property :additional_authenticated_data, :base64 => true, as: 'additionalAuthenticatedData'
end
end
class Location
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :name, as: 'name'
property :location_id, as: 'locationId'
hash :metadata, as: 'metadata'
hash :labels, as: 'labels'
end
end
class ListCryptoKeysResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :next_page_token, as: 'nextPageToken'
collection :crypto_keys, as: 'cryptoKeys', class: Google::Apis::CloudkmsV1beta1::CryptoKey, decorator: Google::Apis::CloudkmsV1beta1::CryptoKey::Representation
property :total_size, as: 'totalSize'
end
end
class Condition
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :sys, as: 'sys'
property :value, as: 'value'
collection :values, as: 'values'
property :iam, as: 'iam'
property :op, as: 'op'
property :svc, as: 'svc'
end
end
class CounterOptions
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :metric, as: 'metric'
property :field, as: 'field'
end
end
class AuditLogConfig
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :exempted_members, as: 'exemptedMembers'
property :log_type, as: 'logType'
end
end
class DecryptResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :plaintext, :base64 => true, as: 'plaintext'
end
end
class TestIamPermissionsRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :permissions, as: 'permissions'
end
end
class KeyRing
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :create_time, as: 'createTime'
property :name, as: 'name'
end
end
class EncryptResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :name, as: 'name'
property :ciphertext, :base64 => true, as: 'ciphertext'
end
end
class ListLocationsResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :locations, as: 'locations', class: Google::Apis::CloudkmsV1beta1::Location, decorator: Google::Apis::CloudkmsV1beta1::Location::Representation
property :next_page_token, as: 'nextPageToken'
end
end
class Policy
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :audit_configs, as: 'auditConfigs', class: Google::Apis::CloudkmsV1beta1::AuditConfig, decorator: Google::Apis::CloudkmsV1beta1::AuditConfig::Representation
collection :bindings, as: 'bindings', class: Google::Apis::CloudkmsV1beta1::Binding, decorator: Google::Apis::CloudkmsV1beta1::Binding::Representation
property :etag, :base64 => true, as: 'etag'
property :iam_owned, as: 'iamOwned'
collection :rules, as: 'rules', class: Google::Apis::CloudkmsV1beta1::Rule, decorator: Google::Apis::CloudkmsV1beta1::Rule::Representation
property :version, as: 'version'
end
end
class UpdateCryptoKeyPrimaryVersionRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :crypto_key_version_id, as: 'cryptoKeyVersionId'
end
end
class RestoreCryptoKeyVersionRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation
end
end
class DataAccessOptions
# @private
class Representation < Google::Apis::Core::JsonRepresentation
end
end
class ListKeyRingsResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :next_page_token, as: 'nextPageToken'
property :total_size, as: 'totalSize'
collection :key_rings, as: 'keyRings', class: Google::Apis::CloudkmsV1beta1::KeyRing, decorator: Google::Apis::CloudkmsV1beta1::KeyRing::Representation
end
end
class AuditConfig
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :audit_log_configs, as: 'auditLogConfigs', class: Google::Apis::CloudkmsV1beta1::AuditLogConfig, decorator: Google::Apis::CloudkmsV1beta1::AuditLogConfig::Representation
collection :exempted_members, as: 'exemptedMembers'
property :service, as: 'service'
end
end
class CryptoKeyVersion
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :state, as: 'state'
property :name, as: 'name'
property :destroy_event_time, as: 'destroyEventTime'
property :destroy_time, as: 'destroyTime'
property :create_time, as: 'createTime'
end
end
end
end
end

View File

@ -0,0 +1,933 @@
# Copyright 2015 Google Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES 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 CloudkmsV1beta1
# Google Cloud Key Management Service (KMS) API
#
# Manages encryption for your cloud services the same way you do on-premise. You
# can generate, use, rotate, and destroy AES256 encryption keys.
#
# @example
# require 'google/apis/cloudkms_v1beta1'
#
# Cloudkms = Google::Apis::CloudkmsV1beta1 # Alias the module
# service = Cloudkms::CloudKMSService.new
#
# @see https://cloud.google.com/kms/
class CloudKMSService < 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://cloudkms.googleapis.com/', '')
end
# Lists information about the supported locations for this service.
# @param [String] name
# The resource that owns the locations collection, if applicable.
# @param [String] page_token
# The standard list page token.
# @param [Fixnum] page_size
# The standard list page size.
# @param [String] filter
# The standard list 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::CloudkmsV1beta1::ListLocationsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudkmsV1beta1::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, page_token: nil, page_size: nil, filter: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1beta1/{+name}/locations', options)
command.response_representation = Google::Apis::CloudkmsV1beta1::ListLocationsResponse::Representation
command.response_class = Google::Apis::CloudkmsV1beta1::ListLocationsResponse
command.params['name'] = name unless name.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['pageSize'] = page_size unless page_size.nil?
command.query['filter'] = filter unless filter.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::CloudkmsV1beta1::Location] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudkmsV1beta1::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, 'v1beta1/{+name}', options)
command.response_representation = Google::Apis::CloudkmsV1beta1::Location::Representation
command.response_class = Google::Apis::CloudkmsV1beta1::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 KeyRings.
# @param [String] parent
# Required. The resource name of the location associated with the
# KeyRings, in the format `projects/*/locations/*`.
# @param [String] page_token
# Optional pagination token, returned earlier via
# ListKeyRingsResponse.next_page_token.
# @param [Fixnum] page_size
# Optional limit on the number of KeyRings to include in the
# response. Further KeyRings can subsequently be obtained by
# including the ListKeyRingsResponse.next_page_token in a subsequent
# request. If unspecified, the server will pick an appropriate 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.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::CloudkmsV1beta1::ListKeyRingsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudkmsV1beta1::ListKeyRingsResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @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_key_rings(parent, page_token: nil, page_size: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1beta1/{+parent}/keyRings', options)
command.response_representation = Google::Apis::CloudkmsV1beta1::ListKeyRingsResponse::Representation
command.response_class = Google::Apis::CloudkmsV1beta1::ListKeyRingsResponse
command.params['parent'] = parent unless parent.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['pageSize'] = page_size unless page_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
# Create a new KeyRing in a given Project and Location.
# @param [String] parent
# Required. The resource name of the location associated with the
# KeyRings, in the format `projects/*/locations/*`.
# @param [Google::Apis::CloudkmsV1beta1::KeyRing] key_ring_object
# @param [String] key_ring_id
# Required. It must be unique within a location and match the regular
# expression `[a-zA-Z0-9_-]`1,63``
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::CloudkmsV1beta1::KeyRing] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudkmsV1beta1::KeyRing]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_key_ring(parent, key_ring_object = nil, key_ring_id: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1beta1/{+parent}/keyRings', options)
command.request_representation = Google::Apis::CloudkmsV1beta1::KeyRing::Representation
command.request_object = key_ring_object
command.response_representation = Google::Apis::CloudkmsV1beta1::KeyRing::Representation
command.response_class = Google::Apis::CloudkmsV1beta1::KeyRing
command.params['parent'] = parent unless parent.nil?
command.query['keyRingId'] = key_ring_id unless key_ring_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 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::CloudkmsV1beta1::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::CloudkmsV1beta1::Policy] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudkmsV1beta1::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_key_ring_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1beta1/{+resource}:setIamPolicy', options)
command.request_representation = Google::Apis::CloudkmsV1beta1::SetIamPolicyRequest::Representation
command.request_object = set_iam_policy_request_object
command.response_representation = Google::Apis::CloudkmsV1beta1::Policy::Representation
command.response_class = Google::Apis::CloudkmsV1beta1::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 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::CloudkmsV1beta1::Policy] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudkmsV1beta1::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_location_key_ring_iam_policy(resource, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1beta1/{+resource}:getIamPolicy', options)
command.response_representation = Google::Apis::CloudkmsV1beta1::Policy::Representation
command.response_class = Google::Apis::CloudkmsV1beta1::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 metadata for a given KeyRing.
# @param [String] name
# The name of the KeyRing 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::CloudkmsV1beta1::KeyRing] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudkmsV1beta1::KeyRing]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @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_key_ring(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1beta1/{+name}', options)
command.response_representation = Google::Apis::CloudkmsV1beta1::KeyRing::Representation
command.response_class = Google::Apis::CloudkmsV1beta1::KeyRing
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 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::CloudkmsV1beta1::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::CloudkmsV1beta1::TestIamPermissionsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudkmsV1beta1::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_key_ring_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1beta1/{+resource}:testIamPermissions', options)
command.request_representation = Google::Apis::CloudkmsV1beta1::TestIamPermissionsRequest::Representation
command.request_object = test_iam_permissions_request_object
command.response_representation = Google::Apis::CloudkmsV1beta1::TestIamPermissionsResponse::Representation
command.response_class = Google::Apis::CloudkmsV1beta1::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
# Update the version of a CryptoKey that will be used in Encrypt
# @param [String] name
# The resource name of the CryptoKey to update.
# @param [Google::Apis::CloudkmsV1beta1::UpdateCryptoKeyPrimaryVersionRequest] update_crypto_key_primary_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::CloudkmsV1beta1::CryptoKey] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudkmsV1beta1::CryptoKey]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_key_ring_crypto_key_primary_version(name, update_crypto_key_primary_version_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1beta1/{+name}:updatePrimaryVersion', options)
command.request_representation = Google::Apis::CloudkmsV1beta1::UpdateCryptoKeyPrimaryVersionRequest::Representation
command.request_object = update_crypto_key_primary_version_request_object
command.response_representation = Google::Apis::CloudkmsV1beta1::CryptoKey::Representation
command.response_class = Google::Apis::CloudkmsV1beta1::CryptoKey
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::CloudkmsV1beta1::Policy] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudkmsV1beta1::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_location_key_ring_crypto_key_iam_policy(resource, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1beta1/{+resource}:getIamPolicy', options)
command.response_representation = Google::Apis::CloudkmsV1beta1::Policy::Representation
command.response_class = Google::Apis::CloudkmsV1beta1::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 metadata for a given CryptoKey, as well as its
# primary CryptoKeyVersion.
# @param [String] name
# The name of the CryptoKey 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::CloudkmsV1beta1::CryptoKey] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudkmsV1beta1::CryptoKey]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @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_key_ring_crypto_key(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1beta1/{+name}', options)
command.response_representation = Google::Apis::CloudkmsV1beta1::CryptoKey::Representation
command.response_class = Google::Apis::CloudkmsV1beta1::CryptoKey
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
# Update a CryptoKey.
# @param [String] name
# Output only. The resource name for this CryptoKey in the format
# `projects/*/locations/*/keyRings/*/cryptoKeys/*`.
# @param [Google::Apis::CloudkmsV1beta1::CryptoKey] crypto_key_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::CloudkmsV1beta1::CryptoKey] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudkmsV1beta1::CryptoKey]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_key_ring_crypto_key(name, crypto_key_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:patch, 'v1beta1/{+name}', options)
command.request_representation = Google::Apis::CloudkmsV1beta1::CryptoKey::Representation
command.request_object = crypto_key_object
command.response_representation = Google::Apis::CloudkmsV1beta1::CryptoKey::Representation
command.response_class = Google::Apis::CloudkmsV1beta1::CryptoKey
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
# 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::CloudkmsV1beta1::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::CloudkmsV1beta1::TestIamPermissionsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudkmsV1beta1::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_crypto_key_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1beta1/{+resource}:testIamPermissions', options)
command.request_representation = Google::Apis::CloudkmsV1beta1::TestIamPermissionsRequest::Representation
command.request_object = test_iam_permissions_request_object
command.response_representation = Google::Apis::CloudkmsV1beta1::TestIamPermissionsResponse::Representation
command.response_class = Google::Apis::CloudkmsV1beta1::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
# Decrypt data that was protected by Encrypt.
# @param [String] name
# Required. The resource name of the CryptoKey to use for decryption.
# The server will choose the appropriate version.
# @param [Google::Apis::CloudkmsV1beta1::DecryptRequest] decrypt_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::CloudkmsV1beta1::DecryptResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudkmsV1beta1::DecryptResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def decrypt_crypto_key(name, decrypt_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1beta1/{+name}:decrypt', options)
command.request_representation = Google::Apis::CloudkmsV1beta1::DecryptRequest::Representation
command.request_object = decrypt_request_object
command.response_representation = Google::Apis::CloudkmsV1beta1::DecryptResponse::Representation
command.response_class = Google::Apis::CloudkmsV1beta1::DecryptResponse
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 CryptoKeys.
# @param [String] parent
# Required. The resource name of the KeyRing to list, in the format
# `projects/*/locations/*/keyRings/*`.
# @param [String] page_token
# Optional pagination token, returned earlier via
# ListCryptoKeysResponse.next_page_token.
# @param [Fixnum] page_size
# Optional limit on the number of CryptoKeys to include in the
# response. Further CryptoKeys can subsequently be obtained by
# including the ListCryptoKeysResponse.next_page_token in a subsequent
# request. If unspecified, the server will pick an appropriate 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.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::CloudkmsV1beta1::ListCryptoKeysResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudkmsV1beta1::ListCryptoKeysResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @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_key_ring_crypto_keys(parent, page_token: nil, page_size: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1beta1/{+parent}/cryptoKeys', options)
command.response_representation = Google::Apis::CloudkmsV1beta1::ListCryptoKeysResponse::Representation
command.response_class = Google::Apis::CloudkmsV1beta1::ListCryptoKeysResponse
command.params['parent'] = parent unless parent.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['pageSize'] = page_size unless page_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
# Encrypt data, so that it can only be recovered by a call to Decrypt.
# @param [String] name
# Required. The resource name of the CryptoKey or CryptoKeyVersion
# to use for encryption.
# If a CryptoKey is specified, the server will use its
# primary version.
# @param [Google::Apis::CloudkmsV1beta1::EncryptRequest] encrypt_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::CloudkmsV1beta1::EncryptResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudkmsV1beta1::EncryptResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def encrypt_crypto_key(name, encrypt_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1beta1/{+name}:encrypt', options)
command.request_representation = Google::Apis::CloudkmsV1beta1::EncryptRequest::Representation
command.request_object = encrypt_request_object
command.response_representation = Google::Apis::CloudkmsV1beta1::EncryptResponse::Representation
command.response_class = Google::Apis::CloudkmsV1beta1::EncryptResponse
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
# Create a new CryptoKey within a KeyRing.
# CryptoKey.purpose is required.
# @param [String] parent
# Required. The name of the KeyRing associated with the
# CryptoKeys.
# @param [Google::Apis::CloudkmsV1beta1::CryptoKey] crypto_key_object
# @param [String] crypto_key_id
# Required. It must be unique within a KeyRing and match the regular
# expression `[a-zA-Z0-9_-]`1,63``
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::CloudkmsV1beta1::CryptoKey] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudkmsV1beta1::CryptoKey]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_key_ring_crypto_key(parent, crypto_key_object = nil, crypto_key_id: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1beta1/{+parent}/cryptoKeys', options)
command.request_representation = Google::Apis::CloudkmsV1beta1::CryptoKey::Representation
command.request_object = crypto_key_object
command.response_representation = Google::Apis::CloudkmsV1beta1::CryptoKey::Representation
command.response_class = Google::Apis::CloudkmsV1beta1::CryptoKey
command.params['parent'] = parent unless parent.nil?
command.query['cryptoKeyId'] = crypto_key_id unless crypto_key_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 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::CloudkmsV1beta1::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::CloudkmsV1beta1::Policy] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudkmsV1beta1::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_crypto_key_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1beta1/{+resource}:setIamPolicy', options)
command.request_representation = Google::Apis::CloudkmsV1beta1::SetIamPolicyRequest::Representation
command.request_object = set_iam_policy_request_object
command.response_representation = Google::Apis::CloudkmsV1beta1::Policy::Representation
command.response_class = Google::Apis::CloudkmsV1beta1::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
# Update a CryptoKeyVersion's metadata.
# state may be changed between
# ENABLED and
# DISABLED using this
# method. See DestroyCryptoKeyVersion and RestoreCryptoKeyVersion to
# move between other states.
# @param [String] name
# Output only. The resource name for this CryptoKeyVersion in the format
# `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.
# @param [Google::Apis::CloudkmsV1beta1::CryptoKeyVersion] crypto_key_version_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::CloudkmsV1beta1::CryptoKeyVersion] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudkmsV1beta1::CryptoKeyVersion]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_key_ring_crypto_key_crypto_key_version(name, crypto_key_version_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:patch, 'v1beta1/{+name}', options)
command.request_representation = Google::Apis::CloudkmsV1beta1::CryptoKeyVersion::Representation
command.request_object = crypto_key_version_object
command.response_representation = Google::Apis::CloudkmsV1beta1::CryptoKeyVersion::Representation
command.response_class = Google::Apis::CloudkmsV1beta1::CryptoKeyVersion
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
# Returns metadata for a given CryptoKeyVersion.
# @param [String] name
# The name of the CryptoKeyVersion 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::CloudkmsV1beta1::CryptoKeyVersion] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudkmsV1beta1::CryptoKeyVersion]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @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_key_ring_crypto_key_crypto_key_version(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1beta1/{+name}', options)
command.response_representation = Google::Apis::CloudkmsV1beta1::CryptoKeyVersion::Representation
command.response_class = Google::Apis::CloudkmsV1beta1::CryptoKeyVersion
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 CryptoKeyVersions.
# @param [String] parent
# Required. The resource name of the CryptoKey to list, in the format
# `projects/*/locations/*/keyRings/*/cryptoKeys/*`.
# @param [Fixnum] page_size
# Optional limit on the number of CryptoKeyVersions to
# include in the response. Further CryptoKeyVersions can
# subsequently be obtained by including the
# ListCryptoKeyVersionsResponse.next_page_token in a subsequent request.
# If unspecified, the server will pick an appropriate default.
# @param [String] page_token
# Optional pagination token, returned earlier via
# ListCryptoKeyVersionsResponse.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::CloudkmsV1beta1::ListCryptoKeyVersionsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudkmsV1beta1::ListCryptoKeyVersionsResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @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_key_ring_crypto_key_crypto_key_versions(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1beta1/{+parent}/cryptoKeyVersions', options)
command.response_representation = Google::Apis::CloudkmsV1beta1::ListCryptoKeyVersionsResponse::Representation
command.response_class = Google::Apis::CloudkmsV1beta1::ListCryptoKeyVersionsResponse
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
# Create a new CryptoKeyVersion in a CryptoKey.
# The server will assign the next sequential id. If unset,
# state will be set to
# ENABLED.
# @param [String] parent
# Required. The name of the CryptoKey associated with
# the CryptoKeyVersions.
# @param [Google::Apis::CloudkmsV1beta1::CryptoKeyVersion] crypto_key_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::CloudkmsV1beta1::CryptoKeyVersion] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudkmsV1beta1::CryptoKeyVersion]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_key_ring_crypto_key_crypto_key_version(parent, crypto_key_version_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1beta1/{+parent}/cryptoKeyVersions', options)
command.request_representation = Google::Apis::CloudkmsV1beta1::CryptoKeyVersion::Representation
command.request_object = crypto_key_version_object
command.response_representation = Google::Apis::CloudkmsV1beta1::CryptoKeyVersion::Representation
command.response_class = Google::Apis::CloudkmsV1beta1::CryptoKeyVersion
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
# Schedule a CryptoKeyVersion for destruction.
# Upon calling this method, CryptoKeyVersion.state will be set to
# DESTROY_SCHEDULED
# and destroy_time will be set to a time 24
# hours in the future, at which point the state
# will be changed to
# DESTROYED, and the key
# material will be irrevocably destroyed.
# Before the destroy_time is reached,
# RestoreCryptoKeyVersion may be called to reverse the process.
# @param [String] name
# The resource name of the CryptoKeyVersion to destroy.
# @param [Google::Apis::CloudkmsV1beta1::DestroyCryptoKeyVersionRequest] destroy_crypto_key_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::CloudkmsV1beta1::CryptoKeyVersion] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudkmsV1beta1::CryptoKeyVersion]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def destroy_crypto_key_version(name, destroy_crypto_key_version_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1beta1/{+name}:destroy', options)
command.request_representation = Google::Apis::CloudkmsV1beta1::DestroyCryptoKeyVersionRequest::Representation
command.request_object = destroy_crypto_key_version_request_object
command.response_representation = Google::Apis::CloudkmsV1beta1::CryptoKeyVersion::Representation
command.response_class = Google::Apis::CloudkmsV1beta1::CryptoKeyVersion
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
# Restore a CryptoKeyVersion in the
# DESTROY_SCHEDULED,
# state.
# Upon restoration of the CryptoKeyVersion, state
# will be set to DISABLED,
# and destroy_time will be cleared.
# @param [String] name
# The resource name of the CryptoKeyVersion to restore.
# @param [Google::Apis::CloudkmsV1beta1::RestoreCryptoKeyVersionRequest] restore_crypto_key_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::CloudkmsV1beta1::CryptoKeyVersion] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudkmsV1beta1::CryptoKeyVersion]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_crypto_key_version(name, restore_crypto_key_version_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1beta1/{+name}:restore', options)
command.request_representation = Google::Apis::CloudkmsV1beta1::RestoreCryptoKeyVersionRequest::Representation
command.request_object = restore_crypto_key_version_request_object
command.response_representation = Google::Apis::CloudkmsV1beta1::CryptoKeyVersion::Representation
command.response_class = Google::Apis::CloudkmsV1beta1::CryptoKeyVersion
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

View File

@ -25,7 +25,7 @@ module Google
# @see https://cloud.google.com/monitoring/v2beta2/
module CloudmonitoringV2beta2
VERSION = 'V2beta2'
REVISION = '20160718'
REVISION = '20170323'
# View and manage your data across Google Cloud Platform services
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'

View File

@ -26,13 +26,13 @@ module Google
# @see https://cloud.google.com/resource-manager
module CloudresourcemanagerV1
VERSION = 'V1'
REVISION = '20160617'
# View and manage your data across Google Cloud Platform services
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'
REVISION = '20170324'
# 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 data across Google Cloud Platform services
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'
end
end
end

File diff suppressed because it is too large Load Diff

View File

@ -22,49 +22,19 @@ module Google
module Apis
module CloudresourcemanagerV1
class Project
class Ancestor
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class ResourceId
class ListConstraint
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 Empty
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 GetIamPolicyRequest
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 Binding
class SetOrgPolicyRequest
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
@ -76,13 +46,97 @@ module Google
include Google::Apis::Core::JsonObjectSupport
end
class Empty
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 ListAvailableOrgPolicyConstraintsResponse
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 GetAncestryResponse
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 SearchOrganizationsRequest
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 TestIamPermissionsRequest
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class TestIamPermissionsResponse
class FolderOperation
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 ListAvailableOrgPolicyConstraintsRequest
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 GetEffectiveOrgPolicyRequest
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 AuditConfig
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
@ -100,17 +154,261 @@ module Google
include Google::Apis::Core::JsonObjectSupport
end
class ListLiensResponse
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 Binding
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 GetOrgPolicyRequest
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 UndeleteProjectRequest
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 BooleanConstraint
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 GetIamPolicyRequest
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 ListProjectsResponse
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 SearchOrganizationsResponse
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 FolderOperationError
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 BooleanPolicy
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 Ancestor
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :project_number, as: 'projectNumber'
property :project_id, as: 'projectId'
property :resource_id, as: 'resourceId', class: Google::Apis::CloudresourcemanagerV1::ResourceId, decorator: Google::Apis::CloudresourcemanagerV1::ResourceId::Representation
end
end
class ListConstraint
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :suggested_value, as: 'suggestedValue'
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 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 Empty
# @private
class Representation < Google::Apis::Core::JsonRepresentation
end
end
class Organization
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :creation_time, as: 'creationTime'
property :owner, as: 'owner', class: Google::Apis::CloudresourcemanagerV1::OrganizationOwner, decorator: Google::Apis::CloudresourcemanagerV1::OrganizationOwner::Representation
property :lifecycle_state, as: 'lifecycleState'
property :name, as: 'name'
property :create_time, as: 'createTime'
hash :labels, as: 'labels'
property :parent, as: 'parent', class: Google::Apis::CloudresourcemanagerV1::ResourceId, decorator: Google::Apis::CloudresourcemanagerV1::ResourceId::Representation
property :display_name, as: 'displayName'
end
end
class ListAvailableOrgPolicyConstraintsResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :next_page_token, as: 'nextPageToken'
collection :constraints, as: 'constraints', class: Google::Apis::CloudresourcemanagerV1::Constraint, decorator: Google::Apis::CloudresourcemanagerV1::Constraint::Representation
end
end
class ListPolicy
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :allowed_values, as: 'allowedValues'
property :suggested_value, as: 'suggestedValue'
property :inherit_from_parent, as: 'inheritFromParent'
collection :denied_values, as: 'deniedValues'
property :all_values, as: 'allValues'
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 AuditLogConfig
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :exempted_members, as: 'exemptedMembers'
property :log_type, as: 'logType'
end
end
class SearchOrganizationsRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :page_token, as: 'pageToken'
property :page_size, as: 'pageSize'
property :filter, as: 'filter'
end
end
class GetAncestryRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation
end
end
class TestIamPermissionsRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :permissions, as: 'permissions'
end
end
class FolderOperation
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :operation_type, as: 'operationType'
property :display_name, as: 'displayName'
property :source_parent, as: 'sourceParent'
property :destination_parent, as: 'destinationParent'
end
end
class Policy
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :etag, :base64 => true, as: 'etag'
property :version, as: 'version'
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
end
end
class ListAvailableOrgPolicyConstraintsRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :page_token, as: 'pageToken'
property :page_size, as: 'pageSize'
end
end
@ -122,18 +420,101 @@ module Google
end
end
class ListProjectsResponse
class GetEffectiveOrgPolicyRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :projects, as: 'projects', class: Google::Apis::CloudresourcemanagerV1::Project, decorator: Google::Apis::CloudresourcemanagerV1::Project::Representation
property :next_page_token, as: 'nextPageToken'
property :constraint, as: 'constraint'
end
end
class Empty
class ListOrgPoliciesRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :page_token, as: 'pageToken'
property :page_size, as: 'pageSize'
end
end
class AuditConfig
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :service, as: 'service'
collection :audit_log_configs, as: 'auditLogConfigs', class: Google::Apis::CloudresourcemanagerV1::AuditLogConfig, decorator: Google::Apis::CloudresourcemanagerV1::AuditLogConfig::Representation
end
end
class Operation
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :done, as: 'done'
hash :response, as: 'response'
property :name, as: 'name'
property :error, as: 'error', class: Google::Apis::CloudresourcemanagerV1::Status, decorator: Google::Apis::CloudresourcemanagerV1::Status::Representation
hash :metadata, as: 'metadata'
end
end
class Status
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :details, as: 'details'
property :code, as: 'code'
property :message, as: 'message'
end
end
class ListLiensResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :next_page_token, as: 'nextPageToken'
collection :liens, as: 'liens', class: Google::Apis::CloudresourcemanagerV1::Lien, decorator: Google::Apis::CloudresourcemanagerV1::Lien::Representation
end
end
class Constraint
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :version, as: 'version'
property :list_constraint, as: 'listConstraint', class: Google::Apis::CloudresourcemanagerV1::ListConstraint, decorator: Google::Apis::CloudresourcemanagerV1::ListConstraint::Representation
property :display_name, as: 'displayName'
property :description, as: 'description'
property :boolean_constraint, as: 'booleanConstraint', class: Google::Apis::CloudresourcemanagerV1::BooleanConstraint, decorator: Google::Apis::CloudresourcemanagerV1::BooleanConstraint::Representation
property :constraint_default, as: 'constraintDefault'
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 RestoreDefault
# @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 ClearOrgPolicyRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :etag, :base64 => true, as: 'etag'
property :constraint, as: 'constraint'
end
end
@ -143,42 +524,18 @@ module Google
end
end
class GetIamPolicyRequest
class ProjectCreationStatus
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :ready, as: 'ready'
property :create_time, as: 'createTime'
property :gettable, as: 'gettable'
end
end
class Policy
class BooleanConstraint
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :version, as: 'version'
collection :bindings, as: 'bindings', class: Google::Apis::CloudresourcemanagerV1::Binding, decorator: Google::Apis::CloudresourcemanagerV1::Binding::Representation
property :etag, :base64 => true, as: 'etag'
end
end
class Binding
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :role, as: 'role'
collection :members, as: 'members'
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
end
end
class TestIamPermissionsRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :permissions, as: 'permissions'
end
end
@ -189,24 +546,99 @@ module Google
end
end
class Operation
class GetIamPolicyRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :name, as: 'name'
hash :metadata, as: 'metadata'
property :done, as: 'done'
property :error, as: 'error', class: Google::Apis::CloudresourcemanagerV1::Status, decorator: Google::Apis::CloudresourcemanagerV1::Status::Representation
hash :response, as: 'response'
end
end
class Status
class OrganizationOwner
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :code, as: 'code'
property :message, as: 'message'
collection :details, as: 'details'
property :directory_customer_id, as: 'directoryCustomerId'
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 Project
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :lifecycle_state, as: 'lifecycleState'
property :project_number, as: 'projectNumber'
property :parent, as: 'parent', class: Google::Apis::CloudresourcemanagerV1::ResourceId, decorator: Google::Apis::CloudresourcemanagerV1::ResourceId::Representation
hash :labels, as: 'labels'
property :create_time, as: 'createTime'
property :name, as: 'name'
property :project_id, as: 'projectId'
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 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 FolderOperationError
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :error_message_id, as: 'errorMessageId'
end
end
class OrgPolicy
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :etag, :base64 => true, as: 'etag'
property :boolean_policy, as: 'booleanPolicy', class: Google::Apis::CloudresourcemanagerV1::BooleanPolicy, decorator: Google::Apis::CloudresourcemanagerV1::BooleanPolicy::Representation
property :constraint, as: 'constraint'
property :update_time, as: 'updateTime'
property :version, as: 'version'
property :restore_default, as: 'restoreDefault', class: Google::Apis::CloudresourcemanagerV1::RestoreDefault, decorator: Google::Apis::CloudresourcemanagerV1::RestoreDefault::Representation
property :list_policy, as: 'listPolicy', class: Google::Apis::CloudresourcemanagerV1::ListPolicy, decorator: Google::Apis::CloudresourcemanagerV1::ListPolicy::Representation
end
end
class BooleanPolicy
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :enforced, as: 'enforced'
end
end
class Lien
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :parent, as: 'parent'
property :create_time, as: 'createTime'
property :name, as: 'name'
property :reason, as: 'reason'
property :origin, as: 'origin'
collection :restrictions, as: 'restrictions'
end
end
end

File diff suppressed because it is too large Load Diff

View File

@ -26,7 +26,7 @@ module Google
# @see https://cloud.google.com/resource-manager
module CloudresourcemanagerV1beta1
VERSION = 'V1beta1'
REVISION = '20160617'
REVISION = '20170324'
# View and manage your data across Google Cloud Platform services
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'

File diff suppressed because it is too large Load Diff

View File

@ -22,79 +22,25 @@ module Google
module Apis
module CloudresourcemanagerV1beta1
class Project
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 ListProjectsResponse
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 UndeleteProjectRequest
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class GetAncestryRequest
class ClearOrgPolicyRequest
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class GetAncestryResponse
class ProjectCreationStatus
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class Ancestor
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 Policy
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 SetIamPolicyRequest
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class TestIamPermissionsRequest
class BooleanConstraint
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
@ -106,13 +52,7 @@ module Google
include Google::Apis::Core::JsonObjectSupport
end
class ListOrganizationsResponse
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class Organization
class GetIamPolicyRequest
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
@ -124,41 +64,184 @@ module Google
include Google::Apis::Core::JsonObjectSupport
end
class Project
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :project_number, as: 'projectNumber'
property :project_id, as: 'projectId'
property :lifecycle_state, as: 'lifecycleState'
property :name, as: 'name'
property :create_time, as: 'createTime'
hash :labels, as: 'labels'
property :parent, as: 'parent', class: Google::Apis::CloudresourcemanagerV1beta1::ResourceId, decorator: Google::Apis::CloudresourcemanagerV1beta1::ResourceId::Representation
end
end
class ResourceId
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :type, as: 'type'
property :id, as: 'id'
end
end
class ListProjectsResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :projects, as: 'projects', class: Google::Apis::CloudresourcemanagerV1beta1::Project, decorator: Google::Apis::CloudresourcemanagerV1beta1::Project::Representation
class Representation < Google::Apis::Core::JsonRepresentation; end
property :next_page_token, as: 'nextPageToken'
end
include Google::Apis::Core::JsonObjectSupport
end
class Project
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 FolderOperationError
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 BooleanPolicy
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class Ancestor
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 SetOrgPolicyRequest
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 Empty
# @private
class Representation < Google::Apis::Core::JsonRepresentation
end
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 ListAvailableOrgPolicyConstraintsResponse
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 GetAncestryResponse
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 GetAncestryRequest
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 ListAvailableOrgPolicyConstraintsRequest
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 FolderOperation
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 GetEffectiveOrgPolicyRequest
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 AuditConfig
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class ListOrganizationsResponse
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 Binding
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 GetOrgPolicyRequest
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class UndeleteProjectRequest
@ -167,17 +250,108 @@ module Google
end
end
class GetAncestryRequest
class ClearOrgPolicyRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :etag, :base64 => true, as: 'etag'
property :constraint, as: 'constraint'
end
end
class ProjectCreationStatus
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :ready, as: 'ready'
property :create_time, as: 'createTime'
property :gettable, as: 'gettable'
end
end
class BooleanConstraint
# @private
class Representation < Google::Apis::Core::JsonRepresentation
end
end
class GetAncestryResponse
class TestIamPermissionsResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :ancestor, as: 'ancestor', class: Google::Apis::CloudresourcemanagerV1beta1::Ancestor, decorator: Google::Apis::CloudresourcemanagerV1beta1::Ancestor::Representation
collection :permissions, as: 'permissions'
end
end
class GetIamPolicyRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation
end
end
class OrganizationOwner
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :directory_customer_id, as: 'directoryCustomerId'
end
end
class ListProjectsResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :next_page_token, as: 'nextPageToken'
collection :projects, as: 'projects', class: Google::Apis::CloudresourcemanagerV1beta1::Project, decorator: Google::Apis::CloudresourcemanagerV1beta1::Project::Representation
end
end
class Project
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :project_number, as: 'projectNumber'
property :parent, as: 'parent', class: Google::Apis::CloudresourcemanagerV1beta1::ResourceId, decorator: Google::Apis::CloudresourcemanagerV1beta1::ResourceId::Representation
property :create_time, as: 'createTime'
hash :labels, as: 'labels'
property :name, as: 'name'
property :project_id, as: 'projectId'
property :lifecycle_state, as: 'lifecycleState'
end
end
class ListOrgPoliciesResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :policies, as: 'policies', class: Google::Apis::CloudresourcemanagerV1beta1::OrgPolicy, decorator: Google::Apis::CloudresourcemanagerV1beta1::OrgPolicy::Representation
property :next_page_token, as: 'nextPageToken'
end
end
class FolderOperationError
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :error_message_id, as: 'errorMessageId'
end
end
class OrgPolicy
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :version, as: 'version'
property :restore_default, as: 'restoreDefault', class: Google::Apis::CloudresourcemanagerV1beta1::RestoreDefault, decorator: Google::Apis::CloudresourcemanagerV1beta1::RestoreDefault::Representation
property :list_policy, as: 'listPolicy', class: Google::Apis::CloudresourcemanagerV1beta1::ListPolicy, decorator: Google::Apis::CloudresourcemanagerV1beta1::ListPolicy::Representation
property :etag, :base64 => true, as: 'etag'
property :constraint, as: 'constraint'
property :boolean_policy, as: 'booleanPolicy', class: Google::Apis::CloudresourcemanagerV1beta1::BooleanPolicy, decorator: Google::Apis::CloudresourcemanagerV1beta1::BooleanPolicy::Representation
property :update_time, as: 'updateTime'
end
end
class BooleanPolicy
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :enforced, as: 'enforced'
end
end
@ -189,27 +363,18 @@ module Google
end
end
class GetIamPolicyRequest
class ListConstraint
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :suggested_value, as: 'suggestedValue'
end
end
class Policy
class SetOrgPolicyRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :version, as: 'version'
collection :bindings, as: 'bindings', class: Google::Apis::CloudresourcemanagerV1beta1::Binding, decorator: Google::Apis::CloudresourcemanagerV1beta1::Binding::Representation
property :policy, as: 'policy', class: Google::Apis::CloudresourcemanagerV1beta1::OrgPolicy, decorator: Google::Apis::CloudresourcemanagerV1beta1::OrgPolicy::Representation
property :etag, :base64 => true, as: 'etag'
end
end
class Binding
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :role, as: 'role'
collection :members, as: 'members'
end
end
@ -218,6 +383,68 @@ module Google
class Representation < Google::Apis::Core::JsonRepresentation
property :policy, as: 'policy', class: Google::Apis::CloudresourcemanagerV1beta1::Policy, decorator: Google::Apis::CloudresourcemanagerV1beta1::Policy::Representation
property :update_mask, as: 'updateMask'
end
end
class Empty
# @private
class Representation < Google::Apis::Core::JsonRepresentation
end
end
class Organization
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :lifecycle_state, as: 'lifecycleState'
property :display_name, as: 'displayName'
property :creation_time, as: 'creationTime'
property :owner, as: 'owner', class: Google::Apis::CloudresourcemanagerV1beta1::OrganizationOwner, decorator: Google::Apis::CloudresourcemanagerV1beta1::OrganizationOwner::Representation
property :name, as: 'name'
property :organization_id, as: 'organizationId'
end
end
class ListAvailableOrgPolicyConstraintsResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :next_page_token, as: 'nextPageToken'
collection :constraints, as: 'constraints', class: Google::Apis::CloudresourcemanagerV1beta1::Constraint, decorator: Google::Apis::CloudresourcemanagerV1beta1::Constraint::Representation
end
end
class ListPolicy
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :all_values, as: 'allValues'
collection :allowed_values, as: 'allowedValues'
property :suggested_value, as: 'suggestedValue'
property :inherit_from_parent, as: 'inheritFromParent'
collection :denied_values, as: 'deniedValues'
end
end
class GetAncestryResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :ancestor, as: 'ancestor', class: Google::Apis::CloudresourcemanagerV1beta1::Ancestor, decorator: Google::Apis::CloudresourcemanagerV1beta1::Ancestor::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 GetAncestryRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation
end
end
@ -228,39 +455,110 @@ module Google
end
end
class TestIamPermissionsResponse
class ListAvailableOrgPolicyConstraintsRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :permissions, as: 'permissions'
property :page_token, as: 'pageToken'
property :page_size, as: 'pageSize'
end
end
class Policy
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :etag, :base64 => true, as: 'etag'
property :version, as: 'version'
collection :audit_configs, as: 'auditConfigs', class: Google::Apis::CloudresourcemanagerV1beta1::AuditConfig, decorator: Google::Apis::CloudresourcemanagerV1beta1::AuditConfig::Representation
collection :bindings, as: 'bindings', class: Google::Apis::CloudresourcemanagerV1beta1::Binding, decorator: Google::Apis::CloudresourcemanagerV1beta1::Binding::Representation
end
end
class FolderOperation
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :operation_type, as: 'operationType'
property :display_name, as: 'displayName'
property :source_parent, as: 'sourceParent'
property :destination_parent, as: 'destinationParent'
end
end
class ResourceId
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :type, as: 'type'
property :id, as: 'id'
end
end
class GetEffectiveOrgPolicyRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :constraint, as: 'constraint'
end
end
class ListOrgPoliciesRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :page_token, as: 'pageToken'
property :page_size, as: 'pageSize'
end
end
class AuditConfig
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :service, as: 'service'
collection :audit_log_configs, as: 'auditLogConfigs', class: Google::Apis::CloudresourcemanagerV1beta1::AuditLogConfig, decorator: Google::Apis::CloudresourcemanagerV1beta1::AuditLogConfig::Representation
end
end
class ListOrganizationsResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :next_page_token, as: 'nextPageToken'
collection :organizations, as: 'organizations', class: Google::Apis::CloudresourcemanagerV1beta1::Organization, decorator: Google::Apis::CloudresourcemanagerV1beta1::Organization::Representation
property :next_page_token, as: 'nextPageToken'
end
end
class Organization
class Constraint
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :name, as: 'name'
property :organization_id, as: 'organizationId'
property :description, as: 'description'
property :display_name, as: 'displayName'
property :owner, as: 'owner', class: Google::Apis::CloudresourcemanagerV1beta1::OrganizationOwner, decorator: Google::Apis::CloudresourcemanagerV1beta1::OrganizationOwner::Representation
property :boolean_constraint, as: 'booleanConstraint', class: Google::Apis::CloudresourcemanagerV1beta1::BooleanConstraint, decorator: Google::Apis::CloudresourcemanagerV1beta1::BooleanConstraint::Representation
property :creation_time, as: 'creationTime'
property :lifecycle_state, as: 'lifecycleState'
property :constraint_default, as: 'constraintDefault'
property :name, as: 'name'
property :list_constraint, as: 'listConstraint', class: Google::Apis::CloudresourcemanagerV1beta1::ListConstraint, decorator: Google::Apis::CloudresourcemanagerV1beta1::ListConstraint::Representation
property :version, as: 'version'
end
end
class OrganizationOwner
class Binding
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :directory_customer_id, as: 'directoryCustomerId'
collection :members, as: 'members'
property :role, as: 'role'
end
end
class RestoreDefault
# @private
class Representation < Google::Apis::Core::JsonRepresentation
end
end
class GetOrgPolicyRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :constraint, as: 'constraint'
end
end
end

File diff suppressed because it is too large Load Diff

View File

@ -18,26 +18,26 @@ require 'google/apis/cloudtrace_v1/representations.rb'
module Google
module Apis
# Google Cloud Trace API
# Stackdriver Trace API
#
# Send and retrieve trace data from Google Cloud Trace. Data is generated and
# Send and retrieve trace data from Stackdriver Trace. Data is generated and
# available by default for all App Engine applications. Data from other
# applications can be written to Cloud Trace for display, reporting, and
# applications can be written to Stackdriver Trace for display, reporting, and
# analysis.
#
# @see https://cloud.google.com/tools/cloud-trace
# @see https://cloud.google.com/trace
module CloudtraceV1
VERSION = 'V1'
REVISION = '20160518'
REVISION = '20170320'
# View and manage your data across Google Cloud Platform services
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'
# Read Trace data for a project or application
AUTH_TRACE_READONLY = 'https://www.googleapis.com/auth/trace.readonly'
# 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'
# View and manage your data across Google Cloud Platform services
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'
end
end
end

View File

@ -22,6 +22,75 @@ module Google
module Apis
module CloudtraceV1
# A span represents a single timed event within a trace. Spans can be nested
# and form a trace tree. Often, a trace contains a root span that describes the
# end-to-end latency of an operation and, optionally, one or more subspans for
# its suboperations. Spans do not need to be contiguous. There may be gaps
# between spans in a trace.
class TraceSpan
include Google::Apis::Core::Hashable
# Identifier for the span. Must be a 64-bit integer other than 0 and
# unique within a trace.
# Corresponds to the JSON property `spanId`
# @return [String]
attr_accessor :span_id
# ID of the parent span, if any. Optional.
# Corresponds to the JSON property `parentSpanId`
# @return [String]
attr_accessor :parent_span_id
# End time of the span in nanoseconds from the UNIX epoch.
# Corresponds to the JSON property `endTime`
# @return [String]
attr_accessor :end_time
# Start time of the span in nanoseconds from the UNIX epoch.
# Corresponds to the JSON property `startTime`
# @return [String]
attr_accessor :start_time
# Distinguishes between spans generated in a particular context. For example,
# two spans with the same name may be distinguished using `RPC_CLIENT`
# and `RPC_SERVER` to identify queueing latency associated with the span.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# Collection of labels associated with the span. Label keys must be less than
# 128 bytes. Label values must be less than 16 kilobytes.
# Corresponds to the JSON property `labels`
# @return [Hash<String,String>]
attr_accessor :labels
# Name of the span. Must be less than 128 bytes. The span name is sanitized
# and displayed in the Stackdriver Trace tool in the
# `% dynamic print site_values.console_name %`.
# The name may be a method name or some other per-call site name.
# For the same executable and the same call point, a best practice is
# to use a consistent name, which makes it easier to correlate
# cross-trace spans.
# 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)
@span_id = args[:span_id] if args.key?(:span_id)
@parent_span_id = args[:parent_span_id] if args.key?(:parent_span_id)
@end_time = args[:end_time] if args.key?(:end_time)
@start_time = args[:start_time] if args.key?(:start_time)
@kind = args[:kind] if args.key?(:kind)
@labels = args[:labels] if args.key?(:labels)
@name = args[:name] if args.key?(:name)
end
end
# The response message for the `ListTraces` method.
class ListTracesResponse
include Google::Apis::Core::Hashable
@ -31,9 +100,9 @@ module Google
# @return [Array<Google::Apis::CloudtraceV1::Trace>]
attr_accessor :traces
# If defined, indicates that there are more traces that match the request and
# that this value should be passed to the next request to continue retrieving
# additional traces.
# If defined, indicates that there are more traces that match the request
# and that this value should be passed to the next request to continue
# retrieving additional traces.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
@ -49,9 +118,28 @@ module Google
end
end
# A trace describes how long it takes for an application to perform an operation.
# It consists of a set of spans, each of which represent a single timed event
# within the operation.
# 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 trace describes how long it takes for an application to perform an
# operation. It consists of a set of spans, each of which represent a single
# timed event within the operation.
class Trace
include Google::Apis::Core::Hashable
@ -60,17 +148,17 @@ module Google
# @return [String]
attr_accessor :project_id
# Globally unique identifier for the trace. This identifier is a 128-bit numeric
# value formatted as a 32-byte hex string.
# Corresponds to the JSON property `traceId`
# @return [String]
attr_accessor :trace_id
# Collection of spans in the trace.
# Corresponds to the JSON property `spans`
# @return [Array<Google::Apis::CloudtraceV1::TraceSpan>]
attr_accessor :spans
# Globally unique identifier for the trace. This identifier is a 128-bit
# numeric value formatted as a 32-byte hex string.
# Corresponds to the JSON property `traceId`
# @return [String]
attr_accessor :trace_id
def initialize(**args)
update!(**args)
end
@ -78,73 +166,8 @@ module Google
# Update properties of this object
def update!(**args)
@project_id = args[:project_id] if args.key?(:project_id)
@trace_id = args[:trace_id] if args.key?(:trace_id)
@spans = args[:spans] if args.key?(:spans)
end
end
# A span represents a single timed event within a trace. Spans can be nested and
# form a trace tree. Often, a trace contains a root span that describes the end-
# to-end latency of an operation and, optionally, one or more subspans for its
# suboperations. Spans do not need to be contiguous. There may be gaps between
# spans in a trace.
class TraceSpan
include Google::Apis::Core::Hashable
# Identifier for the span. This identifier must be unique within a trace.
# Corresponds to the JSON property `spanId`
# @return [String]
attr_accessor :span_id
# Distinguishes between spans generated in a particular context. For example,
# two spans with the same name may be distinguished using `RPC_CLIENT` and `
# RPC_SERVER` to identify queueing latency associated with the span.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# Name of the trace. The trace name is sanitized and displayed in the
# Stackdriver Trace tool in the `% dynamic print site_values.console_name %`.
# The name may be a method name or some other per-call site name. For the same
# executable and the same call point, a best practice is to use a consistent
# name, which makes it easier to correlate cross-trace spans.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# Start time of the span in nanoseconds from the UNIX epoch.
# Corresponds to the JSON property `startTime`
# @return [String]
attr_accessor :start_time
# End time of the span in nanoseconds from the UNIX epoch.
# Corresponds to the JSON property `endTime`
# @return [String]
attr_accessor :end_time
# ID of the parent span, if any. Optional.
# Corresponds to the JSON property `parentSpanId`
# @return [String]
attr_accessor :parent_span_id
# Collection of labels associated with the span.
# Corresponds to the JSON property `labels`
# @return [Hash<String,String>]
attr_accessor :labels
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@span_id = args[:span_id] if args.key?(:span_id)
@kind = args[:kind] if args.key?(:kind)
@name = args[:name] if args.key?(:name)
@start_time = args[:start_time] if args.key?(:start_time)
@end_time = args[:end_time] if args.key?(:end_time)
@parent_span_id = args[:parent_span_id] if args.key?(:parent_span_id)
@labels = args[:labels] if args.key?(:labels)
@trace_id = args[:trace_id] if args.key?(:trace_id)
end
end
@ -166,23 +189,6 @@ module Google
@traces = args[:traces] if args.key?(:traces)
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
end
end
end

View File

@ -22,34 +22,47 @@ module Google
module Apis
module CloudtraceV1
class TraceSpan
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class ListTracesResponse
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 Trace
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class TraceSpan
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class Traces
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
class TraceSpan
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :span_id, as: 'spanId'
property :parent_span_id, as: 'parentSpanId'
property :end_time, as: 'endTime'
property :start_time, as: 'startTime'
property :kind, as: 'kind'
hash :labels, as: 'labels'
property :name, as: 'name'
end
end
class ListTracesResponse
@ -61,26 +74,19 @@ module Google
end
end
class Empty
# @private
class Representation < Google::Apis::Core::JsonRepresentation
end
end
class Trace
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :project_id, as: 'projectId'
property :trace_id, as: 'traceId'
collection :spans, as: 'spans', class: Google::Apis::CloudtraceV1::TraceSpan, decorator: Google::Apis::CloudtraceV1::TraceSpan::Representation
end
end
class TraceSpan
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :span_id, as: 'spanId'
property :kind, as: 'kind'
property :name, as: 'name'
property :start_time, as: 'startTime'
property :end_time, as: 'endTime'
property :parent_span_id, as: 'parentSpanId'
hash :labels, as: 'labels'
property :trace_id, as: 'traceId'
end
end
@ -91,12 +97,6 @@ module Google
end
end
class Empty
# @private
class Representation < Google::Apis::Core::JsonRepresentation
end
end
end
end
end

Some files were not shown because too many files have changed in this diff Show More