chiu
/
google-api-ruby-client
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #528 from tcoffee-google/master 

Allow abnormal page token cases for paging methods
This commit is contained in:
Thomas Coffee 2017-02-10 15:29:37 -08:00 committed by GitHub
parent 90d90d00b2 7a93c07a98
commit 27f13663bf
120 changed files with 102770 additions and 101146 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
CHANGELOG.md
View File

@ -1,3 +1,10 @@
# 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

72539
api_names.yaml
View File

File diff suppressed because it is too large Load Diff

72539
api_names_out.yaml
View File

File diff suppressed because it is too large Load Diff

2
generated/google/apis/adexchangebuyer2_v2beta1.rb
View File

@ -26,7 +26,7 @@ module Google
# @see https://developers.google.com/ad-exchange/buyer-rest/guides/client-access/
module Adexchangebuyer2V2beta1
VERSION = 'V2beta1'
REVISION = '20170126'
REVISION = '20170130'
# Manage your Ad Exchange buyer account configuration
AUTH_ADEXCHANGE_BUYER = 'https://www.googleapis.com/auth/adexchange.buyer'

310
generated/google/apis/adexchangebuyer2_v2beta1/classes.rb
View File

@ -22,18 +22,154 @@ module Google
module Apis
module Adexchangebuyer2V2beta1
# A client resource represents a client buyer—an agency,
# a brand, or an advertiser customer of the sponsor buyer.
# Users associated with the client buyer have restricted access to
# the Ad Exchange Marketplace and certain other sections
# of the Ad Exchange Buyer UI based on the role
# granted to the client buyer.
# All fields are required unless otherwise specified.
class Client
include Google::Apis::Core::Hashable
# The type of the client entity: `ADVERTISER`, `BRAND`, or `AGENCY`.
# Corresponds to the JSON property `entityType`
# @return [String]
attr_accessor :entity_type
# Name used to represent this client to publishers.
# You may have multiple clients that map to the same entity,
# but for each client the combination of `clientName` and entity
# must be unique.
# You can specify this field as empty.
# Corresponds to the JSON property `clientName`
# @return [String]
attr_accessor :client_name
# The role which is assigned to the client buyer. Each role implies a set of
# permissions granted to the client. Must be one of `CLIENT_DEAL_VIEWER`,
# `CLIENT_DEAL_NEGOTIATOR` or `CLIENT_DEAL_APPROVER`.
# Corresponds to the JSON property `role`
# @return [String]
attr_accessor :role
# Whether the client buyer will be visible to sellers.
# Corresponds to the JSON property `visibleToSeller`
# @return [Boolean]
attr_accessor :visible_to_seller
alias_method :visible_to_seller?, :visible_to_seller
# Numerical identifier of the client entity.
# The entity can be an advertiser, a brand, or an agency.
# This identifier is unique among all the entities with the same type.
# A list of all known advertisers with their identifiers is available in the
# [advertisers.txt](https://storage.googleapis.com/adx-rtb-dictionaries/
# advertisers.txt)
# file.
# A list of all known brands with their identifiers is available in the
# [brands.txt](https://storage.googleapis.com/adx-rtb-dictionaries/brands.txt)
# file.
# A list of all known agencies with their identifiers is available in the
# [agencies.txt](https://storage.googleapis.com/adx-rtb-dictionaries/agencies.
# txt)
# file.
# Corresponds to the JSON property `entityId`
# @return [String]
attr_accessor :entity_id
# The globally-unique numerical ID of the client.
# The value of this field is ignored in create and update operations.
# Corresponds to the JSON property `clientAccountId`
# @return [String]
attr_accessor :client_account_id
# The name of the entity. This field is automatically fetched based on
# the type and ID.
# The value of this field is ignored in create and update operations.
# Corresponds to the JSON property `entityName`
# @return [String]
attr_accessor :entity_name
# The status of the client buyer.
# Corresponds to the JSON property `status`
# @return [String]
attr_accessor :status
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@entity_type = args[:entity_type] if args.key?(:entity_type)
@client_name = args[:client_name] if args.key?(:client_name)
@role = args[:role] if args.key?(:role)
@visible_to_seller = args[:visible_to_seller] if args.key?(:visible_to_seller)
@entity_id = args[:entity_id] if args.key?(:entity_id)
@client_account_id = args[:client_account_id] if args.key?(:client_account_id)
@entity_name = args[:entity_name] if args.key?(:entity_name)
@status = args[:status] if args.key?(:status)
end
end
# A client user is created under a client buyer and has restricted access to
# the Ad Exchange Marketplace and certain other sections
# of the Ad Exchange Buyer UI based on the role
# granted to the associated client buyer.
# The only way a new client user can be created is via accepting an
# email invitation
# (see the
# accounts.clients.invitations.create
# method).
# All fields are required unless otherwise specified.
class ClientUser
include Google::Apis::Core::Hashable
# The unique numerical ID of the client user
# that has accepted an invitation.
# The value of this field is ignored in an update operation.
# Corresponds to the JSON property `userId`
# @return [String]
attr_accessor :user_id
# User's email address. The value of this field
# is ignored in an update operation.
# Corresponds to the JSON property `email`
# @return [String]
attr_accessor :email
# Numerical account ID of the client buyer
# with which the user is associated; the
# buyer must be a client of the current sponsor buyer.
# The value of this field is ignored in an update operation.
# Corresponds to the JSON property `clientAccountId`
# @return [String]
attr_accessor :client_account_id
# The status of the client user.
# Corresponds to the JSON property `status`
# @return [String]
attr_accessor :status
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@user_id = args[:user_id] if args.key?(:user_id)
@email = args[:email] if args.key?(:email)
@client_account_id = args[:client_account_id] if args.key?(:client_account_id)
@status = args[:status] if args.key?(:status)
end
end
# An invitation for a new client user to get access to the Ad Exchange
# Buyer UI.
# All fields are required unless otherwise specified.
class ClientUserInvitation
include Google::Apis::Core::Hashable
# The unique numerical ID of the invitation that is sent to the user.
# The value of this field is ignored in create operations.
# Corresponds to the JSON property `invitationId`
# @return [String]
attr_accessor :invitation_id
# The email address to which the invitation is sent. Email
# addresses should be unique among all client users under each sponsor
# buyer.
@ -48,15 +184,21 @@ module Google
# @return [String]
attr_accessor :client_account_id
# The unique numerical ID of the invitation that is sent to the user.
# The value of this field is ignored in create operations.
# Corresponds to the JSON property `invitationId`
# @return [String]
attr_accessor :invitation_id
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@invitation_id = args[:invitation_id] if args.key?(:invitation_id)
@email = args[:email] if args.key?(:email)
@client_account_id = args[:client_account_id] if args.key?(:client_account_id)
@invitation_id = args[:invitation_id] if args.key?(:invitation_id)
end
end
@ -64,11 +206,6 @@ module Google
class ListClientsResponse
include Google::Apis::Core::Hashable
# The returned list of clients.
# Corresponds to the JSON property `clients`
# @return [Array<Google::Apis::Adexchangebuyer2V2beta1::Client>]
attr_accessor :clients
# A token to retrieve the next page of results.
# Pass this value in the
# ListClientsRequest.pageToken
@ -79,14 +216,19 @@ module Google
# @return [String]
attr_accessor :next_page_token
# The returned list of clients.
# Corresponds to the JSON property `clients`
# @return [Array<Google::Apis::Adexchangebuyer2V2beta1::Client>]
attr_accessor :clients
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@clients = args[:clients] if args.key?(:clients)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
@clients = args[:clients] if args.key?(:clients)
end
end
@ -151,148 +293,6 @@ module Google
@invitations = args[:invitations] if args.key?(:invitations)
end
end
# A client resource represents a client buyer&mdash;an agency,
# a brand, or an advertiser customer of the sponsor buyer.
# Users associated with the client buyer have restricted access to
# the Ad Exchange Marketplace and certain other sections
# of the Ad Exchange Buyer UI based on the role
# granted to the client buyer.
# All fields are required unless otherwise specified.
class Client
include Google::Apis::Core::Hashable
# The globally-unique numerical ID of the client.
# The value of this field is ignored in create and update operations.
# Corresponds to the JSON property `clientAccountId`
# @return [String]
attr_accessor :client_account_id
# The name of the entity. This field is automatically fetched based on
# the type and ID.
# The value of this field is ignored in create and update operations.
# Corresponds to the JSON property `entityName`
# @return [String]
attr_accessor :entity_name
# The status of the client buyer.
# Corresponds to the JSON property `status`
# @return [String]
attr_accessor :status
# The type of the client entity: `ADVERTISER`, `BRAND`, or `AGENCY`.
# Corresponds to the JSON property `entityType`
# @return [String]
attr_accessor :entity_type
# Name used to represent this client to publishers.
# You may have multiple clients that map to the same entity,
# but for each client the combination of `clientName` and entity
# must be unique.
# You can specify this field as empty.
# Corresponds to the JSON property `clientName`
# @return [String]
attr_accessor :client_name
# The role which is assigned to the client buyer. Each role implies a set of
# permissions granted to the client. Must be one of `CLIENT_DEAL_VIEWER`,
# `CLIENT_DEAL_NEGOTIATOR` or `CLIENT_DEAL_APPROVER`.
# Corresponds to the JSON property `role`
# @return [String]
attr_accessor :role
# Whether the client buyer will be visible to sellers.
# Corresponds to the JSON property `visibleToSeller`
# @return [Boolean]
attr_accessor :visible_to_seller
alias_method :visible_to_seller?, :visible_to_seller
# Numerical identifier of the client entity.
# The entity can be an advertiser, a brand, or an agency.
# This identifier is unique among all the entities with the same type.
# A list of all known advertisers with their identifiers is available in the
# [advertisers.txt](https://storage.googleapis.com/adx-rtb-dictionaries/
# advertisers.txt)
# file.
# A list of all known brands with their identifiers is available in the
# [brands.txt](https://storage.googleapis.com/adx-rtb-dictionaries/brands.txt)
# file.
# A list of all known agencies with their identifiers is available in the
# [agencies.txt](https://storage.googleapis.com/adx-rtb-dictionaries/agencies.
# txt)
# file.
# Corresponds to the JSON property `entityId`
# @return [String]
attr_accessor :entity_id
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@client_account_id = args[:client_account_id] if args.key?(:client_account_id)
@entity_name = args[:entity_name] if args.key?(:entity_name)
@status = args[:status] if args.key?(:status)
@entity_type = args[:entity_type] if args.key?(:entity_type)
@client_name = args[:client_name] if args.key?(:client_name)
@role = args[:role] if args.key?(:role)
@visible_to_seller = args[:visible_to_seller] if args.key?(:visible_to_seller)
@entity_id = args[:entity_id] if args.key?(:entity_id)
end
end
# A client user is created under a client buyer and has restricted access to
# the Ad Exchange Marketplace and certain other sections
# of the Ad Exchange Buyer UI based on the role
# granted to the associated client buyer.
# The only way a new client user can be created is via accepting an
# email invitation
# (see the
# accounts.clients.invitations.create
# method).
# All fields are required unless otherwise specified.
class ClientUser
include Google::Apis::Core::Hashable
# Numerical account ID of the client buyer
# with which the user is associated; the
# buyer must be a client of the current sponsor buyer.
# The value of this field is ignored in an update operation.
# Corresponds to the JSON property `clientAccountId`
# @return [String]
attr_accessor :client_account_id
# The status of the client user.
# Corresponds to the JSON property `status`
# @return [String]
attr_accessor :status
# The unique numerical ID of the client user
# that has accepted an invitation.
# The value of this field is ignored in an update operation.
# Corresponds to the JSON property `userId`
# @return [String]
attr_accessor :user_id
# User's email address. The value of this field
# is ignored in an update operation.
# Corresponds to the JSON property `email`
# @return [String]
attr_accessor :email
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@client_account_id = args[:client_account_id] if args.key?(:client_account_id)
@status = args[:status] if args.key?(:status)
@user_id = args[:user_id] if args.key?(:user_id)
@email = args[:email] if args.key?(:email)
end
end
end
end
end

64
generated/google/apis/adexchangebuyer2_v2beta1/representations.rb
View File

@ -22,6 +22,18 @@ module Google
module Apis
module Adexchangebuyer2V2beta1
class Client
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class ClientUser
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class ClientUserInvitation
class Representation < Google::Apis::Core::JsonRepresentation; end
@ -47,32 +59,44 @@ module Google
end
class Client
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
# @private
class Representation < Google::Apis::Core::JsonRepresentation
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'
property :entity_name, as: 'entityName'
property :status, as: 'status'
end
end
class ClientUser
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :user_id, as: 'userId'
property :email, as: 'email'
property :client_account_id, as: 'clientAccountId'
property :status, as: 'status'
end
end
class ClientUserInvitation
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :invitation_id, as: 'invitationId'
property :email, as: 'email'
property :client_account_id, as: 'clientAccountId'
property :invitation_id, as: 'invitationId'
end
end
class ListClientsResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :next_page_token, as: 'nextPageToken'
collection :clients, as: 'clients', class: Google::Apis::Adexchangebuyer2V2beta1::Client, decorator: Google::Apis::Adexchangebuyer2V2beta1::Client::Representation
property :next_page_token, as: 'nextPageToken'
end
end
@ -93,30 +117,6 @@ module Google
end
end
class Client
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :client_account_id, as: 'clientAccountId'
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'
end
end
class ClientUser
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :client_account_id, as: 'clientAccountId'
property :status, as: 'status'
property :user_id, as: 'userId'
property :email, as: 'email'
end
end
end
end
end

344
generated/google/apis/adexchangebuyer2_v2beta1/service.rb
View File

@ -83,15 +83,15 @@ module Google
# 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 [Fixnum] page_size
# Requested page size. The server may return fewer clients than requested.
# If unspecified, the server will pick an appropriate default.
# @param [String] page_token
# A token identifying a page of results the server should return.
# Typically, this is the value of
# ListClientsResponse.nextPageToken
# returned from the previous call to the
# accounts.clients.list method.
# @param [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
@ -109,13 +109,13 @@ 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_account_clients(account_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
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['pageSize'] = page_size unless page_size.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)
@ -192,6 +192,173 @@ module Google
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
# 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
# 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
@ -278,173 +445,6 @@ module Google
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
# 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 [Fixnum] page_size
# Requested page size. Server may return fewer clients than requested.
# If unspecified, server will pick an appropriate default.
# @param [String] page_token
# A token identifying a page of results the server should return.
# Typically, this is the value of
# ListClientUserInvitationsResponse.nextPageToken
# returned from the previous call to the
# clients.invitations.list
# method.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::Adexchangebuyer2V2beta1::ListClientUserInvitationsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::Adexchangebuyer2V2beta1::ListClientUserInvitationsResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_account_client_invitations(account_id, client_account_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v2beta1/accounts/{accountId}/clients/{clientAccountId}/invitations', options)
command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::ListClientUserInvitationsResponse::Representation
command.response_class = Google::Apis::Adexchangebuyer2V2beta1::ListClientUserInvitationsResponse
command.params['accountId'] = account_id unless account_id.nil?
command.params['clientAccountId'] = client_account_id unless client_account_id.nil?
command.query['pageSize'] = page_size unless page_size.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# 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
protected

2
generated/google/apis/adsense_v1_4.rb
View File

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

2
generated/google/apis/adsensehost_v4_1.rb
View File

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

2
generated/google/apis/androidenterprise_v1.rb
View File

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

2
generated/google/apis/appstate_v1.rb
View File

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

2
generated/google/apis/calendar_v3.rb
View File

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

2
generated/google/apis/cloudbuild_v1.rb
View File

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

518
generated/google/apis/cloudbuild_v1/classes.rb
View File

@ -22,6 +22,78 @@ module Google
module Apis
module CloudbuildV1
# The `Status` type defines a logical error model that is suitable for different
# programming environments, including REST APIs and RPC APIs. It is used by
# [gRPC](https://github.com/grpc). The error model is designed to be:
# - Simple to use and understand for most users
# - Flexible enough to meet unexpected needs
# # Overview
# The `Status` message contains three pieces of data: error code, error message,
# and error details. The error code should be an enum value of
# google.rpc.Code, but it may accept additional error codes if needed. The
# error message should be a developer-facing English message that helps
# developers *understand* and *resolve* the error. If a localized user-facing
# error message is needed, put the localized message in the error details or
# localize it in the client. The optional error details may contain arbitrary
# information about the error. There is a predefined set of error detail types
# in the package `google.rpc` which can be used for common error conditions.
# # Language mapping
# The `Status` message is the logical representation of the error model, but it
# is not necessarily the actual wire format. When the `Status` message is
# exposed in different client libraries and different wire protocols, it can be
# mapped differently. For example, it will likely be mapped to some exceptions
# in Java, but more likely mapped to some error codes in C.
# # Other uses
# The error model and the `Status` message can be used in a variety of
# environments, either with or without APIs, to provide a
# consistent developer experience across different environments.
# Example uses of this error model include:
# - Partial errors. If a service needs to return partial errors to the client,
# it may embed the `Status` in the normal response to indicate the partial
# errors.
# - Workflow errors. A typical workflow has multiple steps. Each step may
# have a `Status` message for error reporting purpose.
# - Batch operations. If a client uses batch request and batch response, the
# `Status` message should be used directly inside batch response, one for
# each error sub-response.
# - Asynchronous operations. If an API call embeds asynchronous operation
# results in its response, the status of those operations should be
# represented directly using the `Status` message.
# - Logging. If some API errors are stored in logs, the message `Status` could
# be used directly after any stripping needed for security/privacy reasons.
class Status
include Google::Apis::Core::Hashable
# A developer-facing error message, which should be in English. Any
# user-facing error message should be localized and sent in the
# google.rpc.Status.details field, or localized by the client.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
# A list of messages that carry the error details. There will be a
# common set of message types for APIs to use.
# Corresponds to the JSON property `details`
# @return [Array<Hash<String,Object>>]
attr_accessor :details
# The status code, which should be an enum value of google.rpc.Code.
# Corresponds to the JSON property `code`
# @return [Fixnum]
attr_accessor :code
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@message = args[:message] if args.key?(:message)
@details = args[:details] if args.key?(:details)
@code = args[:code] if args.key?(:code)
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:
@ -69,23 +141,28 @@ module Google
# @return [Google::Apis::CloudbuildV1::Build]
attr_accessor :build
# Substitutions data for Build resource.
# Corresponds to the JSON property `substitutions`
# @return [Hash<String,String>]
attr_accessor :substitutions
# Human-readable description of this trigger.
# Corresponds to the JSON property `description`
# @return [String]
attr_accessor :description
# If true, the trigger will never result in a build.
# Corresponds to the JSON property `disabled`
# @return [Boolean]
attr_accessor :disabled
alias_method :disabled?, :disabled
# Time when the trigger was created.
# @OutputOnly
# Corresponds to the JSON property `createTime`
# @return [String]
attr_accessor :create_time
# If true, the trigger will never result in a build.
# Corresponds to the JSON property `disabled`
# @return [Boolean]
attr_accessor :disabled
alias_method :disabled?, :disabled
# Path, from the source root, to a file whose contents is used for the
# template.
# Corresponds to the JSON property `filename`
@ -106,9 +183,10 @@ module Google
def update!(**args)
@id = args[:id] if args.key?(:id)
@build = args[:build] if args.key?(:build)
@substitutions = args[:substitutions] if args.key?(:substitutions)
@description = args[:description] if args.key?(:description)
@disabled = args[:disabled] if args.key?(:disabled)
@create_time = args[:create_time] if args.key?(:create_time)
@disabled = args[:disabled] if args.key?(:disabled)
@filename = args[:filename] if args.key?(:filename)
@trigger_template = args[:trigger_template] if args.key?(:trigger_template)
end
@ -130,24 +208,42 @@ module Google
class Build
include Google::Apis::Core::Hashable
# The ID of the BuildTrigger that triggered this build, if it was
# triggered automatically.
# @OutputOnly
# Corresponds to the JSON property `buildTriggerId`
# @return [String]
attr_accessor :build_trigger_id
# Unique identifier of the build.
# @OutputOnly
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# Substitutions data for Build resource.
# Corresponds to the JSON property `substitutions`
# @return [Hash<String,String>]
attr_accessor :substitutions
# Time at which execution of the build was started.
# @OutputOnly
# Corresponds to the JSON property `startTime`
# @return [String]
attr_accessor :start_time
# Provenance of the source. Ways to find the original source, or verify that
# some source was used for this build.
# Corresponds to the JSON property `sourceProvenance`
# @return [Google::Apis::CloudbuildV1::SourceProvenance]
attr_accessor :source_provenance
# Time at which the request to create the build was received.
# @OutputOnly
# Corresponds to the JSON property `createTime`
# @return [String]
attr_accessor :create_time
# Provenance of the source. Ways to find the original source, or verify that
# some source was used for this build.
# Corresponds to the JSON property `sourceProvenance`
# @return [Google::Apis::CloudbuildV1::SourceProvenance]
attr_accessor :source_provenance
# A list of images to be pushed upon the successful completion of all build
# steps.
# The images will be pushed using the builder service account's credentials.
@ -178,17 +274,17 @@ module Google
# @return [String]
attr_accessor :finish_time
# Optional arguments to enable specific features of builds.
# Corresponds to the JSON property `options`
# @return [Google::Apis::CloudbuildV1::BuildOptions]
attr_accessor :options
# Source describes the location of the source in a supported storage
# service.
# Corresponds to the JSON property `source`
# @return [Google::Apis::CloudbuildV1::Source]
attr_accessor :source
# Optional arguments to enable specific features of builds.
# Corresponds to the JSON property `options`
# @return [Google::Apis::CloudbuildV1::BuildOptions]
attr_accessor :options
# Customer-readable message about the current status.
# @OutputOnly
# Corresponds to the JSON property `statusDetail`
@ -228,42 +324,30 @@ module Google
# @return [Array<Google::Apis::CloudbuildV1::BuildStep>]
attr_accessor :steps
# The ID of the BuildTrigger that triggered this build, if it was
# triggered automatically.
# @OutputOnly
# Corresponds to the JSON property `buildTriggerId`
# @return [String]
attr_accessor :build_trigger_id
# Unique identifier of the build.
# @OutputOnly
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@build_trigger_id = args[:build_trigger_id] if args.key?(:build_trigger_id)
@id = args[:id] if args.key?(:id)
@substitutions = args[:substitutions] if args.key?(:substitutions)
@start_time = args[:start_time] if args.key?(:start_time)
@source_provenance = args[:source_provenance] if args.key?(:source_provenance)
@create_time = args[:create_time] if args.key?(:create_time)
@source_provenance = args[:source_provenance] if args.key?(:source_provenance)
@images = args[:images] if args.key?(:images)
@project_id = args[:project_id] if args.key?(:project_id)
@log_url = args[:log_url] if args.key?(:log_url)
@finish_time = args[:finish_time] if args.key?(:finish_time)
@source = args[:source] if args.key?(:source)
@options = args[:options] if args.key?(:options)
@source = args[:source] if args.key?(:source)
@status_detail = args[:status_detail] if args.key?(:status_detail)
@status = args[:status] if args.key?(:status)
@timeout = args[:timeout] if args.key?(:timeout)
@logs_bucket = args[:logs_bucket] if args.key?(:logs_bucket)
@results = args[:results] if args.key?(:results)
@steps = args[:steps] if args.key?(:steps)
@build_trigger_id = args[:build_trigger_id] if args.key?(:build_trigger_id)
@id = args[:id] if args.key?(:id)
end
end
@ -388,6 +472,12 @@ module Google
class StorageSource
include Google::Apis::Core::Hashable
# Google Cloud Storage generation for the object. If the generation is
# omitted, the latest generation will be used.
# Corresponds to the JSON property `generation`
# @return [String]
attr_accessor :generation
# Google Cloud Storage bucket containing source (see
# [Bucket Name
# Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)
@ -403,21 +493,15 @@ module Google
# @return [String]
attr_accessor :object
# Google Cloud Storage generation for the object. If the generation is
# omitted, the latest generation will be used.
# Corresponds to the JSON property `generation`
# @return [String]
attr_accessor :generation
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@generation = args[:generation] if args.key?(:generation)
@bucket = args[:bucket] if args.key?(:bucket)
@object = args[:object] if args.key?(:object)
@generation = args[:generation] if args.key?(:generation)
end
end
@ -425,24 +509,24 @@ module Google
class Results
include Google::Apis::Core::Hashable
# List of build step digests, in order corresponding to build step indices.
# Corresponds to the JSON property `buildStepImages`
# @return [Array<String>]
attr_accessor :build_step_images
# Images that were built as a part of the build.
# Corresponds to the JSON property `images`
# @return [Array<Google::Apis::CloudbuildV1::BuiltImage>]
attr_accessor :images
# List of build step digests, in order corresponding to build step indices.
# Corresponds to the JSON property `buildStepImages`
# @return [Array<String>]
attr_accessor :build_step_images
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@build_step_images = args[:build_step_images] if args.key?(:build_step_images)
@images = args[:images] if args.key?(:images)
@build_step_images = args[:build_step_images] if args.key?(:build_step_images)
end
end
@ -531,11 +615,50 @@ module Google
end
end
# Response containing existing BuildTriggers.
class ListBuildTriggersResponse
include Google::Apis::Core::Hashable
# BuildTriggers for the project, sorted by create_time descending.
# Corresponds to the JSON property `triggers`
# @return [Array<Google::Apis::CloudbuildV1::BuildTrigger>]
attr_accessor :triggers
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@triggers = args[:triggers] if args.key?(:triggers)
end
end
# This resource represents a long-running operation that is the result of a
# network API call.
class Operation
include Google::Apis::Core::Hashable
# If the value is `false`, it means the operation is still in progress.
# If true, the operation is completed, and either `error` or `response` is
# available.
# Corresponds to the JSON property `done`
# @return [Boolean]
attr_accessor :done
alias_method :done?, :done
# The normal response of the operation in case of success. If the original
# method returns no data on success, such as `Delete`, the response is
# `google.protobuf.Empty`. If the original method is standard
# `Get`/`Create`/`Update`, the response should be the resource. For other
# methods, the response should have the type `XxxResponse`, where `Xxx`
# is the original method name. For example, if the original method name
# is `TakeSnapshot()`, the inferred response type is
# `TakeSnapshotResponse`.
# Corresponds to the JSON property `response`
# @return [Hash<String,Object>]
attr_accessor :response
# The server-assigned name, which is only unique within the same service that
# originally returns it. If you use the default HTTP mapping, the
# `name` should have the format of `operations/some/unique/name`.
@ -594,56 +717,17 @@ module Google
# @return [Hash<String,Object>]
attr_accessor :metadata
# If the value is `false`, it means the operation is still in progress.
# If true, the operation is completed, and either `error` or `response` is
# available.
# Corresponds to the JSON property `done`
# @return [Boolean]
attr_accessor :done
alias_method :done?, :done
# The normal response of the operation in case of success. If the original
# method returns no data on success, such as `Delete`, the response is
# `google.protobuf.Empty`. If the original method is standard
# `Get`/`Create`/`Update`, the response should be the resource. For other
# methods, the response should have the type `XxxResponse`, where `Xxx`
# is the original method name. For example, if the original method name
# is `TakeSnapshot()`, the inferred response type is
# `TakeSnapshotResponse`.
# Corresponds to the JSON property `response`
# @return [Hash<String,Object>]
attr_accessor :response
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@done = args[:done] if args.key?(:done)
@response = args[:response] if args.key?(:response)
@name = args[:name] if args.key?(:name)
@error = args[:error] if args.key?(:error)
@metadata = args[:metadata] if args.key?(:metadata)
@done = args[:done] if args.key?(:done)
@response = args[:response] if args.key?(:response)
end
end
# Response containing existing BuildTriggers.
class ListBuildTriggersResponse
include Google::Apis::Core::Hashable
# BuildTriggers for the project, sorted by create_time descending.
# Corresponds to the JSON property `triggers`
# @return [Array<Google::Apis::CloudbuildV1::BuildTrigger>]
attr_accessor :triggers
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@triggers = args[:triggers] if args.key?(:triggers)
end
end
@ -673,29 +757,80 @@ module Google
end
end
# Container message for hash values.
class HashProp
include Google::Apis::Core::Hashable
# The type of hash that was performed.
# Corresponds to the JSON property `type`
# @return [String]
attr_accessor :type
# The hash value.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@type = args[:type] if args.key?(:type)
@value = args[:value] if args.key?(:value)
end
end
# RepoSource describes the location of the source in a Google Cloud Source
# Repository.
class RepoSource
include Google::Apis::Core::Hashable
# Name of the tag to build.
# Corresponds to the JSON property `tagName`
# @return [String]
attr_accessor :tag_name
# Explicit commit SHA to build.
# Corresponds to the JSON property `commitSha`
# @return [String]
attr_accessor :commit_sha
# ID of the project that owns the repo. If omitted, the project ID requesting
# the build is assumed.
# Corresponds to the JSON property `projectId`
# @return [String]
attr_accessor :project_id
# Name of the repo. If omitted, the name "default" is assumed.
# Corresponds to the JSON property `repoName`
# @return [String]
attr_accessor :repo_name
# Name of the branch to build.
# Corresponds to the JSON property `branchName`
# @return [String]
attr_accessor :branch_name
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@tag_name = args[:tag_name] if args.key?(:tag_name)
@commit_sha = args[:commit_sha] if args.key?(:commit_sha)
@project_id = args[:project_id] if args.key?(:project_id)
@repo_name = args[:repo_name] if args.key?(:repo_name)
@branch_name = args[:branch_name] if args.key?(:branch_name)
end
end
# BuildStep describes a step to perform in the build pipeline.
class BuildStep
include Google::Apis::Core::Hashable
# Optional unique identifier for this build step, used in wait_for to
# reference this build step as a dependency.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# Working directory (relative to project source root) to use when running
# this operation's container.
# Corresponds to the JSON property `dir`
# @return [String]
attr_accessor :dir
# A list of environment variable definitions to be used when running a step.
# The elements are of the form "KEY=VALUE" for the environment variable "KEY"
# being given the value "VALUE".
# Corresponds to the JSON property `env`
# @return [Array<String>]
attr_accessor :env
# The ID(s) of the step(s) that this build step depends on.
# This build step will not start until all the build steps in wait_for
# have completed successfully. If wait_for is empty, this build step will
@ -705,6 +840,13 @@ module Google
# @return [Array<String>]
attr_accessor :wait_for
# A list of environment variable definitions to be used when running a step.
# The elements are of the form "KEY=VALUE" for the environment variable "KEY"
# being given the value "VALUE".
# Corresponds to the JSON property `env`
# @return [Array<String>]
attr_accessor :env
# A list of arguments that will be presented to the step when it is started.
# If the image used to run the step's container has an entrypoint, these args
# will be used as arguments to that entrypoint. If the image does not define
@ -737,89 +879,31 @@ module Google
# @return [String]
attr_accessor :entrypoint
# Optional unique identifier for this build step, used in wait_for to
# reference this build step as a dependency.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# Working directory (relative to project source root) to use when running
# this operation's container.
# Corresponds to the JSON property `dir`
# @return [String]
attr_accessor :dir
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@id = args[:id] if args.key?(:id)
@dir = args[:dir] if args.key?(:dir)
@env = args[:env] if args.key?(:env)
@wait_for = args[:wait_for] if args.key?(:wait_for)
@env = args[:env] if args.key?(:env)
@args = args[:args] if args.key?(:args)
@name = args[:name] if args.key?(:name)
@entrypoint = args[:entrypoint] if args.key?(:entrypoint)
end
end
# RepoSource describes the location of the source in a Google Cloud Source
# Repository.
class RepoSource
include Google::Apis::Core::Hashable
# ID of the project that owns the repo. If omitted, the project ID requesting
# the build is assumed.
# Corresponds to the JSON property `projectId`
# @return [String]
attr_accessor :project_id
# Name of the repo. If omitted, the name "default" is assumed.
# Corresponds to the JSON property `repoName`
# @return [String]
attr_accessor :repo_name
# Name of the branch to build.
# Corresponds to the JSON property `branchName`
# @return [String]
attr_accessor :branch_name
# Name of the tag to build.
# Corresponds to the JSON property `tagName`
# @return [String]
attr_accessor :tag_name
# Explicit commit SHA to build.
# Corresponds to the JSON property `commitSha`
# @return [String]
attr_accessor :commit_sha
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@project_id = args[:project_id] if args.key?(:project_id)
@repo_name = args[:repo_name] if args.key?(:repo_name)
@branch_name = args[:branch_name] if args.key?(:branch_name)
@tag_name = args[:tag_name] if args.key?(:tag_name)
@commit_sha = args[:commit_sha] if args.key?(:commit_sha)
end
end
# Container message for hash values.
class HashProp
include Google::Apis::Core::Hashable
# The type of hash that was performed.
# Corresponds to the JSON property `type`
# @return [String]
attr_accessor :type
# The hash value.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@type = args[:type] if args.key?(:type)
@value = args[:value] if args.key?(:value)
@id = args[:id] if args.key?(:id)
@dir = args[:dir] if args.key?(:dir)
end
end
@ -842,78 +926,6 @@ module Google
@file_hash = args[:file_hash] if args.key?(:file_hash)
end
end
# The `Status` type defines a logical error model that is suitable for different
# programming environments, including REST APIs and RPC APIs. It is used by
# [gRPC](https://github.com/grpc). The error model is designed to be:
# - Simple to use and understand for most users
# - Flexible enough to meet unexpected needs
# # Overview
# The `Status` message contains three pieces of data: error code, error message,
# and error details. The error code should be an enum value of
# google.rpc.Code, but it may accept additional error codes if needed. The
# error message should be a developer-facing English message that helps
# developers *understand* and *resolve* the error. If a localized user-facing
# error message is needed, put the localized message in the error details or
# localize it in the client. The optional error details may contain arbitrary
# information about the error. There is a predefined set of error detail types
# in the package `google.rpc` which can be used for common error conditions.
# # Language mapping
# The `Status` message is the logical representation of the error model, but it
# is not necessarily the actual wire format. When the `Status` message is
# exposed in different client libraries and different wire protocols, it can be
# mapped differently. For example, it will likely be mapped to some exceptions
# in Java, but more likely mapped to some error codes in C.
# # Other uses
# The error model and the `Status` message can be used in a variety of
# environments, either with or without APIs, to provide a
# consistent developer experience across different environments.
# Example uses of this error model include:
# - Partial errors. If a service needs to return partial errors to the client,
# it may embed the `Status` in the normal response to indicate the partial
# errors.
# - Workflow errors. A typical workflow has multiple steps. Each step may
# have a `Status` message for error reporting purpose.
# - Batch operations. If a client uses batch request and batch response, the
# `Status` message should be used directly inside batch response, one for
# each error sub-response.
# - Asynchronous operations. If an API call embeds asynchronous operation
# results in its response, the status of those operations should be
# represented directly using the `Status` message.
# - Logging. If some API errors are stored in logs, the message `Status` could
# be used directly after any stripping needed for security/privacy reasons.
class Status
include Google::Apis::Core::Hashable
# A developer-facing error message, which should be in English. Any
# user-facing error message should be localized and sent in the
# google.rpc.Status.details field, or localized by the client.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
# A list of messages that carry the error details. There will be a
# common set of message types for APIs to use.
# Corresponds to the JSON property `details`
# @return [Array<Hash<String,Object>>]
attr_accessor :details
# The status code, which should be an enum value of google.rpc.Code.
# Corresponds to the JSON property `code`
# @return [Fixnum]
attr_accessor :code
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@message = args[:message] if args.key?(:message)
@details = args[:details] if args.key?(:details)
@code = args[:code] if args.key?(:code)
end
end
end
end
end

100
generated/google/apis/cloudbuild_v1/representations.rb
View File

@ -22,6 +22,12 @@ module Google
module Apis
module CloudbuildV1
class Status
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class Empty
class Representation < Google::Apis::Core::JsonRepresentation; end
@ -100,13 +106,13 @@ module Google
include Google::Apis::Core::JsonObjectSupport
end
class Operation
class ListBuildTriggersResponse
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class ListBuildTriggersResponse
class Operation
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
@ -118,7 +124,7 @@ module Google
include Google::Apis::Core::JsonObjectSupport
end
class BuildStep
class HashProp
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
@ -130,7 +136,7 @@ module Google
include Google::Apis::Core::JsonObjectSupport
end
class HashProp
class BuildStep
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
@ -143,9 +149,12 @@ module Google
end
class Status
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :message, as: 'message'
collection :details, as: 'details'
property :code, as: 'code'
end
end
class Empty
@ -160,9 +169,10 @@ module Google
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'
property :disabled, as: 'disabled'
property :create_time, as: 'createTime'
property :disabled, as: 'disabled'
property :filename, as: 'filename'
property :trigger_template, as: 'triggerTemplate', class: Google::Apis::CloudbuildV1::RepoSource, decorator: Google::Apis::CloudbuildV1::RepoSource::Representation
@ -172,18 +182,21 @@ module Google
class Build
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :build_trigger_id, as: 'buildTriggerId'
property :id, as: 'id'
hash :substitutions, as: 'substitutions'
property :start_time, as: 'startTime'
property :create_time, as: 'createTime'
property :source_provenance, as: 'sourceProvenance', class: Google::Apis::CloudbuildV1::SourceProvenance, decorator: Google::Apis::CloudbuildV1::SourceProvenance::Representation
property :create_time, as: 'createTime'
collection :images, as: 'images'
property :project_id, as: 'projectId'
property :log_url, as: 'logUrl'
property :finish_time, as: 'finishTime'
property :source, as: 'source', class: Google::Apis::CloudbuildV1::Source, decorator: Google::Apis::CloudbuildV1::Source::Representation
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 :status_detail, as: 'statusDetail'
property :status, as: 'status'
property :timeout, as: 'timeout'
@ -192,8 +205,6 @@ module Google
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'
end
end
@ -242,18 +253,18 @@ module Google
class StorageSource
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :generation, as: 'generation'
property :bucket, as: 'bucket'
property :object, as: 'object'
property :generation, as: 'generation'
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
collection :build_step_images, as: 'buildStepImages'
end
end
@ -283,18 +294,6 @@ module Google
end
end
class Operation
# @private
class Representation < Google::Apis::Core::JsonRepresentation
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'
hash :response, as: 'response'
end
end
class ListBuildTriggersResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
@ -303,6 +302,18 @@ module Google
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::CloudbuildV1::Status, decorator: Google::Apis::CloudbuildV1::Status::Representation
hash :metadata, as: 'metadata'
end
end
class BuiltImage
# @private
class Representation < Google::Apis::Core::JsonRepresentation
@ -311,35 +322,35 @@ module Google
end
end
class BuildStep
class HashProp
# @private
class Representation < Google::Apis::Core::JsonRepresentation
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'
property :entrypoint, as: 'entrypoint'
property :type, as: 'type'
property :value, :base64 => true, as: 'value'
end
end
class RepoSource
# @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'
property :tag_name, as: 'tagName'
property :commit_sha, as: 'commitSha'
end
end
class HashProp
class BuildStep
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :type, as: 'type'
property :value, :base64 => true, as: 'value'
collection :wait_for, as: 'waitFor'
collection :env, as: 'env'
collection :args, as: 'args'
property :name, as: 'name'
property :entrypoint, as: 'entrypoint'
property :id, as: 'id'
property :dir, as: 'dir'
end
end
@ -350,15 +361,6 @@ module Google
end
end
class Status
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :message, as: 'message'
collection :details, as: 'details'
property :code, as: 'code'
end
end
end
end
end

454
generated/google/apis/cloudbuild_v1/service.rb
View File

@ -46,13 +46,95 @@ module Google
super('https://cloudbuild.googleapis.com/', '')
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] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::CloudbuildV1::Empty] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudbuildV1::Empty]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def cancel_operation(name, cancel_operation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+name}:cancel', options)
command.request_representation = Google::Apis::CloudbuildV1::CancelOperationRequest::Representation
command.request_object = cancel_operation_request_object
command.response_representation = Google::Apis::CloudbuildV1::Empty::Representation
command.response_class = Google::Apis::CloudbuildV1::Empty
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# 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] 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::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_token: nil, page_size: nil, filter: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+name}', options)
command.response_representation = Google::Apis::CloudbuildV1::ListOperationsResponse::Representation
command.response_class = Google::Apis::CloudbuildV1::ListOperationsResponse
command.params['name'] = name unless name.nil?
command.query['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
# Gets the latest state of a long-running operation. Clients can use this
# method to poll the operation result at intervals as recommended by the API
# service.
# @param [String] name
# The name of the operation resource.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@ -70,159 +152,11 @@ module Google
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def create_project_build(project_id, build_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/projects/{projectId}/builds', options)
command.request_representation = Google::Apis::CloudbuildV1::Build::Representation
command.request_object = build_object
def get_operation(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+name}', options)
command.response_representation = Google::Apis::CloudbuildV1::Operation::Representation
command.response_class = Google::Apis::CloudbuildV1::Operation
command.params['projectId'] = project_id unless project_id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Cancels a requested build in progress.
# @param [String] project_id
# ID of the project.
# @param [String] id
# ID of the build.
# @param [Google::Apis::CloudbuildV1::CancelBuildRequest] cancel_build_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::CloudbuildV1::Build] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudbuildV1::Build]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def cancel_build(project_id, id, cancel_build_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/projects/{projectId}/builds/{id}:cancel', options)
command.request_representation = Google::Apis::CloudbuildV1::CancelBuildRequest::Representation
command.request_object = cancel_build_request_object
command.response_representation = Google::Apis::CloudbuildV1::Build::Representation
command.response_class = Google::Apis::CloudbuildV1::Build
command.params['projectId'] = project_id unless project_id.nil?
command.params['id'] = id unless id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Returns information about a previously requested build.
# The Build that is returned includes its status (e.g., success or failure,
# or in-progress), and timing information.
# @param [String] project_id
# ID of the project.
# @param [String] id
# ID of the build.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::CloudbuildV1::Build] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudbuildV1::Build]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_project_build(project_id, id, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/projects/{projectId}/builds/{id}', options)
command.response_representation = Google::Apis::CloudbuildV1::Build::Representation
command.response_class = Google::Apis::CloudbuildV1::Build
command.params['projectId'] = project_id unless project_id.nil?
command.params['id'] = id unless id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Lists previously requested builds.
# Previously requested builds may still be in-progress, or may have finished
# successfully or unsuccessfully.
# @param [String] project_id
# ID of the project.
# @param [String] filter
# The raw filter text to constrain the results.
# @param [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] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::CloudbuildV1::ListBuildsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudbuildV1::ListBuildsResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_project_builds(project_id, filter: nil, page_token: nil, page_size: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/projects/{projectId}/builds', options)
command.response_representation = Google::Apis::CloudbuildV1::ListBuildsResponse::Representation
command.response_class = Google::Apis::CloudbuildV1::ListBuildsResponse
command.params['projectId'] = project_id unless project_id.nil?
command.query['filter'] = filter unless filter.nil?
command.query['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
# Creates a new BuildTrigger.
# This API is experimental.
# @param [String] project_id
# ID of the project for which to configure automatic builds.
# @param [Google::Apis::CloudbuildV1::BuildTrigger] build_trigger_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::CloudbuildV1::BuildTrigger] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudbuildV1::BuildTrigger]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def create_project_trigger(project_id, build_trigger_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/projects/{projectId}/triggers', options)
command.request_representation = Google::Apis::CloudbuildV1::BuildTrigger::Representation
command.request_object = build_trigger_object
command.response_representation = Google::Apis::CloudbuildV1::BuildTrigger::Representation
command.response_class = Google::Apis::CloudbuildV1::BuildTrigger
command.params['projectId'] = project_id unless project_id.nil?
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
@ -364,18 +298,11 @@ 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] name
# The name of the operation collection.
# @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.
# Creates a new BuildTrigger.
# This API is experimental.
# @param [String] project_id
# ID of the project for which to configure automatic builds.
# @param [Google::Apis::CloudbuildV1::BuildTrigger] build_trigger_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@ -385,19 +312,130 @@ module Google
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::CloudbuildV1::ListOperationsResponse] parsed result object
# @yieldparam result [Google::Apis::CloudbuildV1::BuildTrigger] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudbuildV1::ListOperationsResponse]
# @return [Google::Apis::CloudbuildV1::BuildTrigger]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_operations(name, page_token: nil, page_size: nil, filter: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+name}', options)
command.response_representation = Google::Apis::CloudbuildV1::ListOperationsResponse::Representation
command.response_class = Google::Apis::CloudbuildV1::ListOperationsResponse
command.params['name'] = name unless name.nil?
def create_project_trigger(project_id, build_trigger_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/projects/{projectId}/triggers', options)
command.request_representation = Google::Apis::CloudbuildV1::BuildTrigger::Representation
command.request_object = build_trigger_object
command.response_representation = Google::Apis::CloudbuildV1::BuildTrigger::Representation
command.response_class = Google::Apis::CloudbuildV1::BuildTrigger
command.params['projectId'] = project_id unless project_id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Cancels a requested build in progress.
# @param [String] project_id
# ID of the project.
# @param [String] id
# ID of the build.
# @param [Google::Apis::CloudbuildV1::CancelBuildRequest] cancel_build_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::CloudbuildV1::Build] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudbuildV1::Build]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def cancel_build(project_id, id, cancel_build_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/projects/{projectId}/builds/{id}:cancel', options)
command.request_representation = Google::Apis::CloudbuildV1::CancelBuildRequest::Representation
command.request_object = cancel_build_request_object
command.response_representation = Google::Apis::CloudbuildV1::Build::Representation
command.response_class = Google::Apis::CloudbuildV1::Build
command.params['projectId'] = project_id unless project_id.nil?
command.params['id'] = id unless id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Returns information about a previously requested build.
# The Build that is returned includes its status (e.g., success or failure,
# or in-progress), and timing information.
# @param [String] project_id
# ID of the project.
# @param [String] id
# ID of the build.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::CloudbuildV1::Build] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudbuildV1::Build]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_project_build(project_id, id, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/projects/{projectId}/builds/{id}', options)
command.response_representation = Google::Apis::CloudbuildV1::Build::Representation
command.response_class = Google::Apis::CloudbuildV1::Build
command.params['projectId'] = project_id unless project_id.nil?
command.params['id'] = id unless id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Lists previously requested builds.
# Previously requested builds may still be in-progress, or may have finished
# successfully or unsuccessfully.
# @param [String] project_id
# ID of the project.
# @param [String] 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] filter
# The raw filter text to constrain the results.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::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, page_token: nil, page_size: nil, filter: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/projects/{projectId}/builds', options)
command.response_representation = Google::Apis::CloudbuildV1::ListBuildsResponse::Representation
command.response_class = Google::Apis::CloudbuildV1::ListBuildsResponse
command.params['projectId'] = project_id unless project_id.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['pageSize'] = page_size unless page_size.nil?
command.query['filter'] = filter unless filter.nil?
@ -406,11 +444,13 @@ module Google
execute_or_queue_command(command, &block)
end
# Gets the latest state of a long-running operation. Clients can use this
# method to poll the operation result at intervals as recommended by the API
# service.
# @param [String] name
# The name of the operation resource.
# Starts a build with the specified configuration.
# The long-running Operation returned by this method will include the ID of
# the build, which can be passed to GetBuild to determine its status (e.g.,
# success or failure).
# @param [String] project_id
# ID of the project.
# @param [Google::Apis::CloudbuildV1::Build] build_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@ -428,53 +468,13 @@ 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_operation(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+name}', options)
def create_project_build(project_id, build_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/projects/{projectId}/builds', options)
command.request_representation = Google::Apis::CloudbuildV1::Build::Representation
command.request_object = build_object
command.response_representation = Google::Apis::CloudbuildV1::Operation::Representation
command.response_class = Google::Apis::CloudbuildV1::Operation
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Starts asynchronous cancellation on a long-running operation. The server
# makes a best effort to cancel the operation, but success is not
# guaranteed. If the server doesn't support this method, it returns
# `google.rpc.Code.UNIMPLEMENTED`. Clients can use
# Operations.GetOperation or
# other methods to check whether the cancellation succeeded or whether the
# operation completed despite cancellation. On successful cancellation,
# the operation is not deleted; instead, it becomes an operation with
# an Operation.error value with a google.rpc.Status.code of 1,
# corresponding to `Code.CANCELLED`.
# @param [String] name
# The name of the operation resource to be cancelled.
# @param [Google::Apis::CloudbuildV1::CancelOperationRequest] cancel_operation_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::CloudbuildV1::Empty] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudbuildV1::Empty]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def cancel_operation(name, cancel_operation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+name}:cancel', options)
command.request_representation = Google::Apis::CloudbuildV1::CancelOperationRequest::Representation
command.request_object = cancel_operation_request_object
command.response_representation = Google::Apis::CloudbuildV1::Empty::Representation
command.response_class = Google::Apis::CloudbuildV1::Empty
command.params['name'] = name unless name.nil?
command.params['projectId'] = project_id unless project_id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)

6
generated/google/apis/clouddebugger_v2.rb
View File

@ -28,11 +28,11 @@ module Google
VERSION = 'V2'
REVISION = '20170117'
# View and manage your data across Google Cloud Platform services
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'
# 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

1290
generated/google/apis/clouddebugger_v2/classes.rb
View File

File diff suppressed because it is too large Load Diff

690
generated/google/apis/clouddebugger_v2/representations.rb
View File

@ -22,43 +22,13 @@ module Google
module Apis
module ClouddebuggerV2
class Debuggee
class CloudRepoSourceContext
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 ListBreakpointsResponse
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 SourceLocation
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 FormatMessage
class RegisterDebuggeeRequest
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
@ -76,195 +46,161 @@ module Google
include Google::Apis::Core::JsonObjectSupport
end
class AliasContext
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 Breakpoint
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 ListActiveBreakpointsResponse
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 RegisterDebuggeeRequest
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 CloudWorkspaceSourceContext
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 CloudRepoSourceContext
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 SourceContext
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 GitSourceContext
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 UpdateActiveBreakpointResponse
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 AliasContext
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 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
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :id, as: 'id'
property :project, as: 'project'
collection :ext_source_contexts, as: 'extSourceContexts', class: Google::Apis::ClouddebuggerV2::ExtendedSourceContext, decorator: Google::Apis::ClouddebuggerV2::ExtendedSourceContext::Representation
class Representation < Google::Apis::Core::JsonRepresentation; end
property :description, as: 'description'
property :is_disabled, as: 'isDisabled'
property :status, as: 'status', class: Google::Apis::ClouddebuggerV2::StatusMessage, decorator: Google::Apis::ClouddebuggerV2::StatusMessage::Representation
property :is_inactive, as: 'isInactive'
property :agent_version, as: 'agentVersion'
hash :labels, as: 'labels'
property :uniquifier, as: 'uniquifier'
collection :source_contexts, as: 'sourceContexts', class: Google::Apis::ClouddebuggerV2::SourceContext, decorator: Google::Apis::ClouddebuggerV2::SourceContext::Representation
end
include Google::Apis::Core::JsonObjectSupport
end
class StackFrame
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :locals, as: 'locals', class: Google::Apis::ClouddebuggerV2::Variable, decorator: Google::Apis::ClouddebuggerV2::Variable::Representation
class ProjectRepoId
class Representation < Google::Apis::Core::JsonRepresentation; end
property :function, as: 'function'
property :location, as: 'location', class: Google::Apis::ClouddebuggerV2::SourceLocation, decorator: Google::Apis::ClouddebuggerV2::SourceLocation::Representation
collection :arguments, as: 'arguments', class: Google::Apis::ClouddebuggerV2::Variable, decorator: Google::Apis::ClouddebuggerV2::Variable::Representation
end
include Google::Apis::Core::JsonObjectSupport
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
class ListActiveBreakpointsResponse
class Representation < Google::Apis::Core::JsonRepresentation; end
property :next_wait_token, as: 'nextWaitToken'
end
include Google::Apis::Core::JsonObjectSupport
end
class Variable
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :var_table_index, as: 'varTableIndex'
property :status, as: 'status', class: Google::Apis::ClouddebuggerV2::StatusMessage, decorator: Google::Apis::ClouddebuggerV2::StatusMessage::Representation
class CloudWorkspaceSourceContext
class Representation < Google::Apis::Core::JsonRepresentation; end
collection :members, as: 'members', class: Google::Apis::ClouddebuggerV2::Variable, decorator: Google::Apis::ClouddebuggerV2::Variable::Representation
property :name, as: 'name'
property :value, as: 'value'
property :type, as: 'type'
end
include Google::Apis::Core::JsonObjectSupport
end
class SourceLocation
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :path, as: 'path'
property :line, as: 'line'
end
class UpdateActiveBreakpointResponse
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 CloudWorkspaceId
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class ListBreakpointsResponse
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 SetBreakpointResponse
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 SourceContext
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class CloudRepoSourceContext
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :host_uri, as: 'hostUri'
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
property :gerrit_project, as: 'gerritProject'
property :revision_id, as: 'revisionId'
end
end
class FormatMessage
class RegisterDebuggeeRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :parameters, as: 'parameters'
property :format, as: 'format'
property :debuggee, as: 'debuggee', class: Google::Apis::ClouddebuggerV2::Debuggee, decorator: Google::Apis::ClouddebuggerV2::Debuggee::Representation
end
end
@ -284,167 +220,6 @@ module Google
end
end
class AliasContext
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :kind, as: 'kind'
property :name, as: 'name'
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 Breakpoint
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :id, as: 'id'
collection :stack_frames, as: 'stackFrames', class: Google::Apis::ClouddebuggerV2::StackFrame, decorator: Google::Apis::ClouddebuggerV2::StackFrame::Representation
property :location, as: 'location', class: Google::Apis::ClouddebuggerV2::SourceLocation, decorator: Google::Apis::ClouddebuggerV2::SourceLocation::Representation
property :status, as: 'status', class: Google::Apis::ClouddebuggerV2::StatusMessage, decorator: Google::Apis::ClouddebuggerV2::StatusMessage::Representation
property :user_email, as: 'userEmail'
property :condition, as: 'condition'
property :final_time, as: 'finalTime'
property :action, as: 'action'
hash :labels, as: 'labels'
property :log_message_format, as: 'logMessageFormat'
property :create_time, as: 'createTime'
property :log_level, as: 'logLevel'
collection :evaluated_expressions, as: 'evaluatedExpressions', class: Google::Apis::ClouddebuggerV2::Variable, decorator: Google::Apis::ClouddebuggerV2::Variable::Representation
property :is_final_state, as: 'isFinalState'
collection :expressions, as: 'expressions'
collection :variable_table, as: 'variableTable', class: Google::Apis::ClouddebuggerV2::Variable, decorator: Google::Apis::ClouddebuggerV2::Variable::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 ListActiveBreakpointsResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :wait_expired, as: 'waitExpired'
collection :breakpoints, as: 'breakpoints', class: Google::Apis::ClouddebuggerV2::Breakpoint, decorator: Google::Apis::ClouddebuggerV2::Breakpoint::Representation
property :next_wait_token, as: 'nextWaitToken'
end
end
class ExtendedSourceContext
# @private
class Representation < Google::Apis::Core::JsonRepresentation
hash :labels, as: 'labels'
property :context, as: 'context', class: Google::Apis::ClouddebuggerV2::SourceContext, decorator: Google::Apis::ClouddebuggerV2::SourceContext::Representation
end
end
class RegisterDebuggeeRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :debuggee, as: 'debuggee', class: Google::Apis::ClouddebuggerV2::Debuggee, decorator: Google::Apis::ClouddebuggerV2::Debuggee::Representation
end
end
class RepoId
# @private
class Representation < Google::Apis::Core::JsonRepresentation
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
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :repo_name, as: 'repoName'
property :project_id, as: 'projectId'
end
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 ListDebuggeesResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :debuggees, as: 'debuggees', class: Google::Apis::ClouddebuggerV2::Debuggee, decorator: Google::Apis::ClouddebuggerV2::Debuggee::Representation
end
end
class CloudRepoSourceContext
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :alias_name, as: 'aliasName'
property :alias_context, as: 'aliasContext', class: Google::Apis::ClouddebuggerV2::AliasContext, decorator: Google::Apis::ClouddebuggerV2::AliasContext::Representation
property :repo_id, as: 'repoId', class: Google::Apis::ClouddebuggerV2::RepoId, decorator: Google::Apis::ClouddebuggerV2::RepoId::Representation
property :revision_id, as: 'revisionId'
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 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 :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
end
end
class Empty
# @private
class Representation < Google::Apis::Core::JsonRepresentation
end
end
class GitSourceContext
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :url, as: 'url'
property :revision_id, as: 'revisionId'
end
end
class StatusMessage
# @private
class Representation < Google::Apis::Core::JsonRepresentation
@ -455,11 +230,236 @@ module Google
end
end
class GitSourceContext
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :revision_id, as: 'revisionId'
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
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
property :function, as: 'function'
end
end
class RepoId
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :project_repo_id, as: 'projectRepoId', class: Google::Apis::ClouddebuggerV2::ProjectRepoId, decorator: Google::Apis::ClouddebuggerV2::ProjectRepoId::Representation
property :uid, as: 'uid'
end
end
class FormatMessage
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :parameters, as: 'parameters'
property :format, as: 'format'
end
end
class ExtendedSourceContext
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :context, as: 'context', class: Google::Apis::ClouddebuggerV2::SourceContext, decorator: Google::Apis::ClouddebuggerV2::SourceContext::Representation
hash :labels, as: 'labels'
end
end
class AliasContext
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :name, as: 'name'
property :kind, as: 'kind'
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
end
end
class Empty
# @private
class Representation < Google::Apis::Core::JsonRepresentation
end
end
class SourceLocation
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :path, as: 'path'
property :line, as: 'line'
end
end
class Debuggee
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :project, as: 'project'
property :id, as: 'id'
property :agent_version, as: 'agentVersion'
property :is_disabled, as: 'isDisabled'
property :description, as: 'description'
property :uniquifier, as: 'uniquifier'
collection :source_contexts, as: 'sourceContexts', class: Google::Apis::ClouddebuggerV2::SourceContext, decorator: Google::Apis::ClouddebuggerV2::SourceContext::Representation
collection :ext_source_contexts, as: 'extSourceContexts', class: Google::Apis::ClouddebuggerV2::ExtendedSourceContext, decorator: Google::Apis::ClouddebuggerV2::ExtendedSourceContext::Representation
hash :labels, as: 'labels'
property :status, as: 'status', class: Google::Apis::ClouddebuggerV2::StatusMessage, decorator: Google::Apis::ClouddebuggerV2::StatusMessage::Representation
property :is_inactive, as: 'isInactive'
end
end
class ProjectRepoId
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :project_id, as: 'projectId'
property :repo_name, as: 'repoName'
end
end
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 :wait_expired, as: 'waitExpired'
end
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 :host_uri, as: 'hostUri'
property :revision_id, as: 'revisionId'
property :alias_name, as: 'aliasName'
property :gerrit_project, as: 'gerritProject'
property :alias_context, as: 'aliasContext', class: Google::Apis::ClouddebuggerV2::AliasContext, decorator: Google::Apis::ClouddebuggerV2::AliasContext::Representation
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 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
hash :labels, as: 'labels'
property :create_time, as: 'createTime'
property :log_message_format, as: 'logMessageFormat'
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 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 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
end
end
end

460
generated/google/apis/clouddebugger_v2/service.rb
View File

@ -47,147 +47,15 @@ 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.
# 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`.
# @param [Google::Apis::ClouddebuggerV2::RegisterDebuggeeRequest] register_debuggee_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::ClouddebuggerV2::RegisterDebuggeeResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ClouddebuggerV2::RegisterDebuggeeResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def register_debuggee(register_debuggee_request_object = nil, quota_user: nil, fields: nil, options: nil, &block)
command = make_simple_command(:post, 'v2/controller/debuggees/register', options)
command.request_representation = Google::Apis::ClouddebuggerV2::RegisterDebuggeeRequest::Representation
command.request_object = register_debuggee_request_object
command.response_representation = Google::Apis::ClouddebuggerV2::RegisterDebuggeeResponse::Representation
command.response_class = Google::Apis::ClouddebuggerV2::RegisterDebuggeeResponse
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['fields'] = fields unless fields.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.
# @param [String] debuggee_id
# Identifies the debuggee being debugged.
# @param [String] id
# Breakpoint identifier, unique in the scope of the debuggee.
# @param [Google::Apis::ClouddebuggerV2::UpdateActiveBreakpointRequest] update_active_breakpoint_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::ClouddebuggerV2::UpdateActiveBreakpointResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ClouddebuggerV2::UpdateActiveBreakpointResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_active_breakpoint(debuggee_id, id, update_active_breakpoint_request_object = nil, quota_user: nil, fields: nil, options: nil, &block)
command = make_simple_command(:put, 'v2/controller/debuggees/{debuggeeId}/breakpoints/{id}', options)
command.request_representation = Google::Apis::ClouddebuggerV2::UpdateActiveBreakpointRequest::Representation
command.request_object = update_active_breakpoint_request_object
command.response_representation = Google::Apis::ClouddebuggerV2::UpdateActiveBreakpointResponse::Representation
command.response_class = Google::Apis::ClouddebuggerV2::UpdateActiveBreakpointResponse
command.params['debuggeeId'] = debuggee_id unless debuggee_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 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 [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] 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 [String] quota_user
# Available to 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::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, success_on_timeout: nil, wait_token: nil, quota_user: nil, fields: 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['successOnTimeout'] = success_on_timeout unless success_on_timeout.nil?
command.query['waitToken'] = wait_token unless wait_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
# 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] client_version
# The client version making the call.
# Following: `domain/type/version` (e.g., `google.com/intellij/v1`).
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
@ -205,106 +73,13 @@ 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_debugger_debuggees(include_inactive: nil, project: nil, client_version: nil, quota_user: nil, fields: nil, options: nil, &block)
def list_debugger_debuggees(client_version: nil, include_inactive: nil, project: nil, quota_user: nil, fields: 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['clientVersion'] = client_version unless client_version.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 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] quota_user
# Available to 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::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, quota_user: nil, fields: 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['quotaUser'] = quota_user unless quota_user.nil?
command.query['fields'] = fields unless fields.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] client_version
# The client version making the call.
# Following: `domain/type/version` (e.g., `google.com/intellij/v1`).
# @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] action_value
# Only breakpoints with the specified action will pass the filter.
# @param [Boolean] include_inactive
# When set to `true`, the response includes active and inactive
# breakpoints. Otherwise, it includes only active breakpoints.
# @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] quota_user
# Available to 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::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, client_version: nil, include_all_users: nil, strip_results: nil, action_value: nil, include_inactive: nil, wait_token: nil, quota_user: nil, fields: 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['clientVersion'] = client_version unless client_version.nil?
command.query['includeAllUsers'] = include_all_users unless include_all_users.nil?
command.query['stripResults'] = strip_results unless strip_results.nil?
command.query['action.value'] = action_value unless action_value.nil?
command.query['includeInactive'] = include_inactive unless include_inactive.nil?
command.query['waitToken'] = wait_token unless wait_token.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['fields'] = fields unless fields.nil?
execute_or_queue_command(command, &block)
@ -383,6 +158,231 @@ module Google
command.query['fields'] = fields unless fields.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] quota_user
# Available to 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::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, quota_user: nil, fields: 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['quotaUser'] = quota_user unless quota_user.nil?
command.query['fields'] = fields unless fields.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_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] 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`).
# @param [String] action_value
# Only breakpoints with the specified action will pass the 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::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, include_inactive: nil, include_all_users: nil, strip_results: nil, wait_token: nil, client_version: nil, action_value: nil, quota_user: nil, fields: 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['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['waitToken'] = wait_token unless wait_token.nil?
command.query['clientVersion'] = client_version unless client_version.nil?
command.query['action.value'] = action_value unless action_value.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['fields'] = fields unless fields.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`.
# @param [Google::Apis::ClouddebuggerV2::RegisterDebuggeeRequest] register_debuggee_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::ClouddebuggerV2::RegisterDebuggeeResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ClouddebuggerV2::RegisterDebuggeeResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def register_debuggee(register_debuggee_request_object = nil, quota_user: nil, fields: nil, options: nil, &block)
command = make_simple_command(:post, 'v2/controller/debuggees/register', options)
command.request_representation = Google::Apis::ClouddebuggerV2::RegisterDebuggeeRequest::Representation
command.request_object = register_debuggee_request_object
command.response_representation = Google::Apis::ClouddebuggerV2::RegisterDebuggeeResponse::Representation
command.response_class = Google::Apis::ClouddebuggerV2::RegisterDebuggeeResponse
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['fields'] = fields unless fields.nil?
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 [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] 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 [String] quota_user
# Available to 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::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, success_on_timeout: nil, wait_token: nil, quota_user: nil, fields: 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['successOnTimeout'] = success_on_timeout unless success_on_timeout.nil?
command.query['waitToken'] = wait_token unless wait_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
# 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
# Breakpoint identifier, unique in the scope of the debuggee.
# @param [Google::Apis::ClouddebuggerV2::UpdateActiveBreakpointRequest] update_active_breakpoint_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::ClouddebuggerV2::UpdateActiveBreakpointResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ClouddebuggerV2::UpdateActiveBreakpointResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_active_breakpoint(debuggee_id, id, update_active_breakpoint_request_object = nil, quota_user: nil, fields: nil, options: nil, &block)
command = make_simple_command(:put, 'v2/controller/debuggees/{debuggeeId}/breakpoints/{id}', options)
command.request_representation = Google::Apis::ClouddebuggerV2::UpdateActiveBreakpointRequest::Representation
command.request_object = update_active_breakpoint_request_object
command.response_representation = Google::Apis::ClouddebuggerV2::UpdateActiveBreakpointResponse::Representation
command.response_class = Google::Apis::ClouddebuggerV2::UpdateActiveBreakpointResponse
command.params['debuggeeId'] = debuggee_id unless debuggee_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
protected

7
generated/google/apis/cloudkms_v1beta1.rb
View File

@ -18,14 +18,15 @@ require 'google/apis/cloudkms_v1beta1/representations.rb'
module Google
module Apis
# Google Cloud KMS API
# 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 = '20170117'
REVISION = '20170124'
# View and manage your data across Google Cloud Platform services
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'

1528
generated/google/apis/cloudkms_v1beta1/classes.rb
View File

File diff suppressed because it is too large Load Diff

490
generated/google/apis/cloudkms_v1beta1/representations.rb
View File

@ -22,54 +22,6 @@ 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
@ -130,6 +82,12 @@ module Google
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
@ -148,12 +106,6 @@ module Google
include Google::Apis::Core::JsonObjectSupport
end
class ListLocationsResponse
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class UpdateCryptoKeyPrimaryVersionRequest
class Representation < Google::Apis::Core::JsonRepresentation; end
@ -190,6 +142,235 @@ module Google
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 Rule
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 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 :update_mask, as: 'updateMask'
property :policy, as: 'policy', class: Google::Apis::CloudkmsV1beta1::Policy, decorator: Google::Apis::CloudkmsV1beta1::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
class Location
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :location_id, as: 'locationId'
hash :metadata, as: 'metadata'
hash :labels, as: 'labels'
property :name, as: 'name'
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 :value, as: 'value'
property :sys, as: 'sys'
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 ListLocationsResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :next_page_token, as: 'nextPageToken'
collection :locations, as: 'locations', class: Google::Apis::CloudkmsV1beta1::Location, decorator: Google::Apis::CloudkmsV1beta1::Location::Representation
end
end
class Policy
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :iam_owned, as: 'iamOwned'
collection :rules, as: 'rules', class: Google::Apis::CloudkmsV1beta1::Rule, decorator: Google::Apis::CloudkmsV1beta1::Rule::Representation
property :version, as: 'version'
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'
end
end
class EncryptResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :ciphertext, :base64 => true, as: 'ciphertext'
property :name, as: 'name'
end
end
class KeyRing
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :create_time, as: 'createTime'
property :name, as: 'name'
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
collection :key_rings, as: 'keyRings', class: Google::Apis::CloudkmsV1beta1::KeyRing, decorator: Google::Apis::CloudkmsV1beta1::KeyRing::Representation
property :next_page_token, as: 'nextPageToken'
property :total_size, as: 'totalSize'
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 :create_time, as: 'createTime'
property :state, as: 'state'
property :name, as: 'name'
property :destroy_event_time, as: 'destroyEventTime'
property :destroy_time, as: 'destroyTime'
end
end
class CloudAuditOptions
# @private
class Representation < Google::Apis::Core::JsonRepresentation
@ -235,212 +416,31 @@ module Google
end
end
class CryptoKey
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :name, as: 'name'
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::CloudkmsV1beta1::CryptoKeyVersion, decorator: Google::Apis::CloudkmsV1beta1::CryptoKeyVersion::Representation
end
end
class Rule
# @private
class Representation < Google::Apis::Core::JsonRepresentation
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'
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
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 :update_mask, as: 'updateMask'
property :policy, as: 'policy', class: Google::Apis::CloudkmsV1beta1::Policy, decorator: Google::Apis::CloudkmsV1beta1::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
class Location
# @private
class Representation < Google::Apis::Core::JsonRepresentation
hash :labels, as: 'labels'
property :name, as: 'name'
property :location_id, as: 'locationId'
hash :metadata, as: 'metadata'
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 :svc, as: 'svc'
property :sys, as: 'sys'
property :value, as: 'value'
collection :values, as: 'values'
property :iam, as: 'iam'
property :op, as: 'op'
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 :iam_owned, as: 'iamOwned'
collection :rules, as: 'rules', class: Google::Apis::CloudkmsV1beta1::Rule, decorator: Google::Apis::CloudkmsV1beta1::Rule::Representation
property :version, as: 'version'
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'
end
end
class EncryptResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :ciphertext, :base64 => true, as: 'ciphertext'
property :name, as: 'name'
end
end
class KeyRing
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'
end
end
class ListLocationsResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :next_page_token, as: 'nextPageToken'
collection :locations, as: 'locations', class: Google::Apis::CloudkmsV1beta1::Location, decorator: Google::Apis::CloudkmsV1beta1::Location::Representation
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 :create_time, as: 'createTime'
property :state, as: 'state'
property :name, as: 'name'
property :destroy_event_time, as: 'destroyEventTime'
property :destroy_time, as: 'destroyTime'
property :purpose, as: 'purpose'
property :next_rotation_time, as: 'nextRotationTime'
end
end
end

365
generated/google/apis/cloudkms_v1beta1/service.rb
View File

@ -20,9 +20,10 @@ require 'google/apis/errors'
module Google
module Apis
module CloudkmsV1beta1
# Google Cloud KMS API
# 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'
@ -119,14 +120,14 @@ module Google
# @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] page_token
# Optional pagination token, returned earlier via
# ListKeyRingsResponse.next_page_token.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@ -144,13 +145,13 @@ module Google
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_project_location_key_rings(parent, page_token: nil, page_size: nil, fields: nil, quota_user: nil, options: nil, &block)
def list_project_location_key_rings(parent, page_size: nil, page_token: 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['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)
@ -331,40 +332,6 @@ module Google
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.
# `resource` is usually specified as a path. For example, a Project
# resource is specified as `projects/`project``.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::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
@ -581,6 +548,42 @@ module Google
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.
# `resource` is usually specified as a path. For example, a Project
# resource is specified as `projects/`project``.
# @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
# Create a new CryptoKey within a KeyRing.
# CryptoKey.purpose is required.
# @param [String] parent
@ -620,42 +623,6 @@ module Google
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.
# `resource` is usually specified as a path. For example, a Project
# resource is specified as `projects/`project``.
# @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 the version of a CryptoKey that will be used in Encrypt
# @param [String] name
# The resource name of the CryptoKey to update.
@ -689,19 +656,13 @@ module Google
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.
# 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.
# `resource` is usually specified as a path. For example, a Project
# resource is specified as `projects/`project``.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@ -711,100 +672,19 @@ module Google
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::CloudkmsV1beta1::ListCryptoKeyVersionsResponse] parsed result object
# @yieldparam result [Google::Apis::CloudkmsV1beta1::Policy] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudkmsV1beta1::ListCryptoKeyVersionsResponse]
# @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 list_project_location_key_ring_crypto_key_crypto_key_versions(parent, page_token: nil, page_size: 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['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 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?
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)
@ -848,6 +728,36 @@ module Google
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
# Update a CryptoKeyVersion's metadata.
# state may be changed between
# ENABLED and
@ -890,9 +800,61 @@ module Google
execute_or_queue_command(command, &block)
end
# Returns metadata for a given CryptoKeyVersion.
# 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
# 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 name of the CryptoKeyVersion to get.
# 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
@ -910,8 +872,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 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)
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?
@ -919,6 +883,43 @@ module Google
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
protected

2
generated/google/apis/cloudmonitoring_v2beta2.rb
View File

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

2
generated/google/apis/cloudresourcemanager_v1.rb
View File

@ -26,7 +26,7 @@ module Google
# @see https://cloud.google.com/resource-manager
module CloudresourcemanagerV1
VERSION = 'V1'
REVISION = '20170125'
REVISION = '20170201'
# View your data across Google Cloud Platform services
AUTH_CLOUD_PLATFORM_READ_ONLY = 'https://www.googleapis.com/auth/cloud-platform.read-only'

872
generated/google/apis/cloudresourcemanager_v1/classes.rb
View File

@ -22,429 +22,6 @@ module Google
module Apis
module CloudresourcemanagerV1
# The request sent to the
# GetAncestry
# method.
class GetAncestryRequest
include Google::Apis::Core::Hashable
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
end
end
# A Project is a high-level Google Cloud Platform entity. It is a
# container for ACLs, APIs, AppEngine Apps, VMs, and other
# Google Cloud Platform resources.
class Project
include Google::Apis::Core::Hashable
# The Project lifecycle state.
# Read-only.
# Corresponds to the JSON property `lifecycleState`
# @return [String]
attr_accessor :lifecycle_state
# The number uniquely identifying the project.
# Example: <code>415104041262</code>
# Read-only.
# Corresponds to the JSON property `projectNumber`
# @return [String]
attr_accessor :project_number
# A container to reference an id for any resource type. A `resource` in Google
# Cloud Platform is a generic term for something you (a developer) may want to
# interact with through one of our API's. Some examples are an AppEngine app,
# a Compute Engine instance, a Cloud SQL database, and so on.
# Corresponds to the JSON property `parent`
# @return [Google::Apis::CloudresourcemanagerV1::ResourceId]
attr_accessor :parent
# Creation time.
# Read-only.
# Corresponds to the JSON property `createTime`
# @return [String]
attr_accessor :create_time
# The labels associated with this Project.
# Label keys must be between 1 and 63 characters long and must conform
# to the following regular expression: \[a-z\](\[-a-z0-9\]*\[a-z0-9\])?.
# Label values must be between 0 and 63 characters long and must conform
# to the regular expression (\[a-z\](\[-a-z0-9\]*\[a-z0-9\])?)?.
# No more than 256 labels can be associated with a given resource.
# Clients should store labels in a representation such as JSON that does not
# depend on specific characters being disallowed.
# Example: <code>"environment" : "dev"</code>
# Read-write.
# Corresponds to the JSON property `labels`
# @return [Hash<String,String>]
attr_accessor :labels
# The user-assigned display name of the Project.
# It must be 4 to 30 characters.
# Allowed characters are: lowercase and uppercase letters, numbers,
# hyphen, single-quote, double-quote, space, and exclamation point.
# Example: <code>My Project</code>
# Read-write.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# The unique, user-assigned ID of the Project.
# It must be 6 to 30 lowercase letters, digits, or hyphens.
# It must start with a letter.
# Trailing hyphens are prohibited.
# Example: <code>tokyo-rain-123</code>
# Read-only after creation.
# Corresponds to the JSON property `projectId`
# @return [String]
attr_accessor :project_id
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@lifecycle_state = args[:lifecycle_state] if args.key?(:lifecycle_state)
@project_number = args[:project_number] if args.key?(:project_number)
@parent = args[:parent] if args.key?(:parent)
@create_time = args[:create_time] if args.key?(:create_time)
@labels = args[:labels] if args.key?(:labels)
@name = args[:name] if args.key?(:name)
@project_id = args[:project_id] if args.key?(:project_id)
end
end
# The response returned from the `SearchOrganizations` method.
class SearchOrganizationsResponse
include Google::Apis::Core::Hashable
# The list of Organizations that matched the search query, possibly
# paginated.
# Corresponds to the JSON property `organizations`
# @return [Array<Google::Apis::CloudresourcemanagerV1::Organization>]
attr_accessor :organizations
# A pagination token to be used to retrieve the next page of results. If the
# result is too large to fit within the page size specified in the request,
# this field will be set with a token that can be used to fetch the next page
# of results. If this field is empty, it indicates that this response
# contains the last page of results.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@organizations = args[:organizations] if args.key?(:organizations)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
end
end
# Request message for `TestIamPermissions` method.
class TestIamPermissionsRequest
include Google::Apis::Core::Hashable
# The set of permissions to check for the `resource`. Permissions with
# wildcards (such as '*' or 'storage.*') are not allowed. For more
# information see
# [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
# Corresponds to the JSON property `permissions`
# @return [Array<String>]
attr_accessor :permissions
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@permissions = args[:permissions] if args.key?(:permissions)
end
end
# Defines an Identity and Access Management (IAM) policy. It is used to
# specify access control policies for Cloud Platform resources.
# A `Policy` consists of a list of `bindings`. A `Binding` binds a list of
# `members` to a `role`, where the members can be user accounts, Google groups,
# Google domains, and service accounts. A `role` is a named list of permissions
# defined by IAM.
# **Example**
# `
# "bindings": [
# `
# "role": "roles/owner",
# "members": [
# "user:mike@example.com",
# "group:admins@example.com",
# "domain:google.com",
# "serviceAccount:my-other-app@appspot.gserviceaccount.com",
# ]
# `,
# `
# "role": "roles/viewer",
# "members": ["user:sean@example.com"]
# `
# ]
# `
# For a description of IAM and its features, see the
# [IAM developer's guide](https://cloud.google.com/iam).
class Policy
include Google::Apis::Core::Hashable
# Associates a list of `members` to a `role`.
# Multiple `bindings` must not be specified for the same `role`.
# `bindings` with no members will result in an error.
# Corresponds to the JSON property `bindings`
# @return [Array<Google::Apis::CloudresourcemanagerV1::Binding>]
attr_accessor :bindings
# `etag` is used for optimistic concurrency control as a way to help
# prevent simultaneous updates of a policy from overwriting each other.
# It is strongly suggested that systems make use of the `etag` in the
# read-modify-write cycle to perform policy updates in order to avoid race
# conditions: An `etag` is returned in the response to `getIamPolicy`, and
# systems are expected to put that etag in the request to `setIamPolicy` to
# ensure that their change will be applied to the same version of the policy.
# If no `etag` is provided in the call to `setIamPolicy`, then the existing
# policy is overwritten blindly.
# Corresponds to the JSON property `etag`
# @return [String]
attr_accessor :etag
# Version of the `Policy`. The default version is 0.
# Corresponds to the JSON property `version`
# @return [Fixnum]
attr_accessor :version
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@bindings = args[:bindings] if args.key?(:bindings)
@etag = args[:etag] if args.key?(:etag)
@version = args[:version] if args.key?(:version)
end
end
# Metadata describing a long running folder operation
class FolderOperation
include Google::Apis::Core::Hashable
# The display name of the folder.
# Corresponds to the JSON property `displayName`
# @return [String]
attr_accessor :display_name
# The resource name of the folder's parent.
# Only applicable when the operation_type is MOVE.
# Corresponds to the JSON property `sourceParent`
# @return [String]
attr_accessor :source_parent
# The resource name of the folder or organization we are either creating
# the folder under or moving the folder to.
# Corresponds to the JSON property `destinationParent`
# @return [String]
attr_accessor :destination_parent
# The type of this operation.
# Corresponds to the JSON property `operationType`
# @return [String]
attr_accessor :operation_type
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@display_name = args[:display_name] if args.key?(:display_name)
@source_parent = args[:source_parent] if args.key?(:source_parent)
@destination_parent = args[:destination_parent] if args.key?(:destination_parent)
@operation_type = args[:operation_type] if args.key?(:operation_type)
end
end
# A classification of the Folder Operation error.
class FolderOperationError
include Google::Apis::Core::Hashable
# The type of operation error experienced.
# Corresponds to the JSON property `errorMessageId`
# @return [String]
attr_accessor :error_message_id
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@error_message_id = args[:error_message_id] if args.key?(:error_message_id)
end
end
# A container to reference an id for any resource type. A `resource` in Google
# Cloud Platform is a generic term for something you (a developer) may want to
# interact with through one of our API's. Some examples are an AppEngine app,
# a Compute Engine instance, a Cloud SQL database, and so on.
class ResourceId
include Google::Apis::Core::Hashable
# Required field representing the resource type this id is for.
# At present, the only valid type is "organization".
# Corresponds to the JSON property `type`
# @return [String]
attr_accessor :type
# Required field for the type-specific id. This should correspond to the id
# used in the type-specific API's.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@type = args[:type] if args.key?(:type)
@id = args[:id] if args.key?(:id)
end
end
# This resource represents a long-running operation that is the result of a
# network API call.
class Operation
include Google::Apis::Core::Hashable
# If the value is `false`, it means the operation is still in progress.
# If true, the operation is completed, and either `error` or `response` is
# available.
# Corresponds to the JSON property `done`
# @return [Boolean]
attr_accessor :done
alias_method :done?, :done
# The normal response of the operation in case of success. If the original
# method returns no data on success, such as `Delete`, the response is
# `google.protobuf.Empty`. If the original method is standard
# `Get`/`Create`/`Update`, the response should be the resource. For other
# methods, the response should have the type `XxxResponse`, where `Xxx`
# is the original method name. For example, if the original method name
# is `TakeSnapshot()`, the inferred response type is
# `TakeSnapshotResponse`.
# Corresponds to the JSON property `response`
# @return [Hash<String,Object>]
attr_accessor :response
# The server-assigned name, which is only unique within the same service that
# originally returns it. If you use the default HTTP mapping, the
# `name` should have the format of `operations/some/unique/name`.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# The `Status` type defines a logical error model that is suitable for different
# programming environments, including REST APIs and RPC APIs. It is used by
# [gRPC](https://github.com/grpc). The error model is designed to be:
# - Simple to use and understand for most users
# - Flexible enough to meet unexpected needs
# # Overview
# The `Status` message contains three pieces of data: error code, error message,
# and error details. The error code should be an enum value of
# google.rpc.Code, but it may accept additional error codes if needed. The
# error message should be a developer-facing English message that helps
# developers *understand* and *resolve* the error. If a localized user-facing
# error message is needed, put the localized message in the error details or
# localize it in the client. The optional error details may contain arbitrary
# information about the error. There is a predefined set of error detail types
# in the package `google.rpc` which can be used for common error conditions.
# # Language mapping
# The `Status` message is the logical representation of the error model, but it
# is not necessarily the actual wire format. When the `Status` message is
# exposed in different client libraries and different wire protocols, it can be
# mapped differently. For example, it will likely be mapped to some exceptions
# in Java, but more likely mapped to some error codes in C.
# # Other uses
# The error model and the `Status` message can be used in a variety of
# environments, either with or without APIs, to provide a
# consistent developer experience across different environments.
# Example uses of this error model include:
# - Partial errors. If a service needs to return partial errors to the client,
# it may embed the `Status` in the normal response to indicate the partial
# errors.
# - Workflow errors. A typical workflow has multiple steps. Each step may
# have a `Status` message for error reporting purpose.
# - Batch operations. If a client uses batch request and batch response, the
# `Status` message should be used directly inside batch response, one for
# each error sub-response.
# - Asynchronous operations. If an API call embeds asynchronous operation
# results in its response, the status of those operations should be
# represented directly using the `Status` message.
# - Logging. If some API errors are stored in logs, the message `Status` could
# be used directly after any stripping needed for security/privacy reasons.
# Corresponds to the JSON property `error`
# @return [Google::Apis::CloudresourcemanagerV1::Status]
attr_accessor :error
# Service-specific metadata associated with the operation. It typically
# contains progress information and common metadata such as create time.
# Some services might not provide such metadata. Any method that returns a
# long-running operation should document the metadata type, if any.
# Corresponds to the JSON property `metadata`
# @return [Hash<String,Object>]
attr_accessor :metadata
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@done = args[:done] if args.key?(:done)
@response = args[:response] if args.key?(:response)
@name = args[:name] if args.key?(:name)
@error = args[:error] if args.key?(:error)
@metadata = args[:metadata] if args.key?(:metadata)
end
end
# Identifying information for a single ancestor of a project.
class Ancestor
include Google::Apis::Core::Hashable
# A container to reference an id for any resource type. A `resource` in Google
# Cloud Platform is a generic term for something you (a developer) may want to
# interact with through one of our API's. Some examples are an AppEngine app,
# a Compute Engine instance, a Cloud SQL database, and so on.
# Corresponds to the JSON property `resourceId`
# @return [Google::Apis::CloudresourcemanagerV1::ResourceId]
attr_accessor :resource_id
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@resource_id = args[:resource_id] if args.key?(:resource_id)
end
end
# Request message for `SetIamPolicy` method.
class SetIamPolicyRequest
include Google::Apis::Core::Hashable
@ -725,19 +302,6 @@ module Google
end
end
# Request message for `GetIamPolicy` method.
class GetIamPolicyRequest
include Google::Apis::Core::Hashable
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
end
end
# Response message for `TestIamPermissions` method.
class TestIamPermissionsResponse
include Google::Apis::Core::Hashable
@ -758,6 +322,19 @@ module Google
end
end
# Request message for `GetIamPolicy` method.
class GetIamPolicyRequest
include Google::Apis::Core::Hashable
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
end
end
# Response from the GetAncestry method.
class GetAncestryResponse
include Google::Apis::Core::Hashable
@ -881,6 +458,429 @@ module Google
@page_size = args[:page_size] if args.key?(:page_size)
end
end
# The request sent to the
# GetAncestry
# method.
class GetAncestryRequest
include Google::Apis::Core::Hashable
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
end
end
# A Project is a high-level Google Cloud Platform entity. It is a
# container for ACLs, APIs, AppEngine Apps, VMs, and other
# Google Cloud Platform resources.
class Project
include Google::Apis::Core::Hashable
# The Project lifecycle state.
# Read-only.
# Corresponds to the JSON property `lifecycleState`
# @return [String]
attr_accessor :lifecycle_state
# The number uniquely identifying the project.
# Example: <code>415104041262</code>
# Read-only.
# Corresponds to the JSON property `projectNumber`
# @return [String]
attr_accessor :project_number
# A container to reference an id for any resource type. A `resource` in Google
# Cloud Platform is a generic term for something you (a developer) may want to
# interact with through one of our API's. Some examples are an AppEngine app,
# a Compute Engine instance, a Cloud SQL database, and so on.
# Corresponds to the JSON property `parent`
# @return [Google::Apis::CloudresourcemanagerV1::ResourceId]
attr_accessor :parent
# Creation time.
# Read-only.
# Corresponds to the JSON property `createTime`
# @return [String]
attr_accessor :create_time
# The labels associated with this Project.
# Label keys must be between 1 and 63 characters long and must conform
# to the following regular expression: \[a-z\](\[-a-z0-9\]*\[a-z0-9\])?.
# Label values must be between 0 and 63 characters long and must conform
# to the regular expression (\[a-z\](\[-a-z0-9\]*\[a-z0-9\])?)?.
# No more than 256 labels can be associated with a given resource.
# Clients should store labels in a representation such as JSON that does not
# depend on specific characters being disallowed.
# Example: <code>"environment" : "dev"</code>
# Read-write.
# Corresponds to the JSON property `labels`
# @return [Hash<String,String>]
attr_accessor :labels
# The user-assigned display name of the Project.
# It must be 4 to 30 characters.
# Allowed characters are: lowercase and uppercase letters, numbers,
# hyphen, single-quote, double-quote, space, and exclamation point.
# Example: <code>My Project</code>
# Read-write.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# The unique, user-assigned ID of the Project.
# It must be 6 to 30 lowercase letters, digits, or hyphens.
# It must start with a letter.
# Trailing hyphens are prohibited.
# Example: <code>tokyo-rain-123</code>
# Read-only after creation.
# Corresponds to the JSON property `projectId`
# @return [String]
attr_accessor :project_id
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@lifecycle_state = args[:lifecycle_state] if args.key?(:lifecycle_state)
@project_number = args[:project_number] if args.key?(:project_number)
@parent = args[:parent] if args.key?(:parent)
@create_time = args[:create_time] if args.key?(:create_time)
@labels = args[:labels] if args.key?(:labels)
@name = args[:name] if args.key?(:name)
@project_id = args[:project_id] if args.key?(:project_id)
end
end
# Request message for `TestIamPermissions` method.
class TestIamPermissionsRequest
include Google::Apis::Core::Hashable
# The set of permissions to check for the `resource`. Permissions with
# wildcards (such as '*' or 'storage.*') are not allowed. For more
# information see
# [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
# Corresponds to the JSON property `permissions`
# @return [Array<String>]
attr_accessor :permissions
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@permissions = args[:permissions] if args.key?(:permissions)
end
end
# The response returned from the `SearchOrganizations` method.
class SearchOrganizationsResponse
include Google::Apis::Core::Hashable
# A pagination token to be used to retrieve the next page of results. If the
# result is too large to fit within the page size specified in the request,
# this field will be set with a token that can be used to fetch the next page
# of results. If this field is empty, it indicates that this response
# contains the last page of results.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# The list of Organizations that matched the search query, possibly
# paginated.
# Corresponds to the JSON property `organizations`
# @return [Array<Google::Apis::CloudresourcemanagerV1::Organization>]
attr_accessor :organizations
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
@organizations = args[:organizations] if args.key?(:organizations)
end
end
# Defines an Identity and Access Management (IAM) policy. It is used to
# specify access control policies for Cloud Platform resources.
# A `Policy` consists of a list of `bindings`. A `Binding` binds a list of
# `members` to a `role`, where the members can be user accounts, Google groups,
# Google domains, and service accounts. A `role` is a named list of permissions
# defined by IAM.
# **Example**
# `
# "bindings": [
# `
# "role": "roles/owner",
# "members": [
# "user:mike@example.com",
# "group:admins@example.com",
# "domain:google.com",
# "serviceAccount:my-other-app@appspot.gserviceaccount.com",
# ]
# `,
# `
# "role": "roles/viewer",
# "members": ["user:sean@example.com"]
# `
# ]
# `
# For a description of IAM and its features, see the
# [IAM developer's guide](https://cloud.google.com/iam).
class Policy
include Google::Apis::Core::Hashable
# `etag` is used for optimistic concurrency control as a way to help
# prevent simultaneous updates of a policy from overwriting each other.
# It is strongly suggested that systems make use of the `etag` in the
# read-modify-write cycle to perform policy updates in order to avoid race
# conditions: An `etag` is returned in the response to `getIamPolicy`, and
# systems are expected to put that etag in the request to `setIamPolicy` to
# ensure that their change will be applied to the same version of the policy.
# If no `etag` is provided in the call to `setIamPolicy`, then the existing
# policy is overwritten blindly.
# Corresponds to the JSON property `etag`
# @return [String]
attr_accessor :etag
# Version of the `Policy`. The default version is 0.
# Corresponds to the JSON property `version`
# @return [Fixnum]
attr_accessor :version
# Associates a list of `members` to a `role`.
# Multiple `bindings` must not be specified for the same `role`.
# `bindings` with no members will result in an error.
# Corresponds to the JSON property `bindings`
# @return [Array<Google::Apis::CloudresourcemanagerV1::Binding>]
attr_accessor :bindings
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@etag = args[:etag] if args.key?(:etag)
@version = args[:version] if args.key?(:version)
@bindings = args[:bindings] if args.key?(:bindings)
end
end
# Metadata describing a long running folder operation
class FolderOperation
include Google::Apis::Core::Hashable
# The type of this operation.
# Corresponds to the JSON property `operationType`
# @return [String]
attr_accessor :operation_type
# The display name of the folder.
# Corresponds to the JSON property `displayName`
# @return [String]
attr_accessor :display_name
# The resource name of the folder's parent.
# Only applicable when the operation_type is MOVE.
# Corresponds to the JSON property `sourceParent`
# @return [String]
attr_accessor :source_parent
# The resource name of the folder or organization we are either creating
# the folder under or moving the folder to.
# Corresponds to the JSON property `destinationParent`
# @return [String]
attr_accessor :destination_parent
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@operation_type = args[:operation_type] if args.key?(:operation_type)
@display_name = args[:display_name] if args.key?(:display_name)
@source_parent = args[:source_parent] if args.key?(:source_parent)
@destination_parent = args[:destination_parent] if args.key?(:destination_parent)
end
end
# A classification of the Folder Operation error.
class FolderOperationError
include Google::Apis::Core::Hashable
# The type of operation error experienced.
# Corresponds to the JSON property `errorMessageId`
# @return [String]
attr_accessor :error_message_id
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@error_message_id = args[:error_message_id] if args.key?(:error_message_id)
end
end
# A container to reference an id for any resource type. A `resource` in Google
# Cloud Platform is a generic term for something you (a developer) may want to
# interact with through one of our API's. Some examples are an AppEngine app,
# a Compute Engine instance, a Cloud SQL database, and so on.
class ResourceId
include Google::Apis::Core::Hashable
# Required field representing the resource type this id is for.
# At present, the only valid type is "organization".
# Corresponds to the JSON property `type`
# @return [String]
attr_accessor :type
# Required field for the type-specific id. This should correspond to the id
# used in the type-specific API's.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@type = args[:type] if args.key?(:type)
@id = args[:id] if args.key?(:id)
end
end
# This resource represents a long-running operation that is the result of a
# network API call.
class Operation
include Google::Apis::Core::Hashable
# If the value is `false`, it means the operation is still in progress.
# If true, the operation is completed, and either `error` or `response` is
# available.
# Corresponds to the JSON property `done`
# @return [Boolean]
attr_accessor :done
alias_method :done?, :done
# The normal response of the operation in case of success. If the original
# method returns no data on success, such as `Delete`, the response is
# `google.protobuf.Empty`. If the original method is standard
# `Get`/`Create`/`Update`, the response should be the resource. For other
# methods, the response should have the type `XxxResponse`, where `Xxx`
# is the original method name. For example, if the original method name
# is `TakeSnapshot()`, the inferred response type is
# `TakeSnapshotResponse`.
# Corresponds to the JSON property `response`
# @return [Hash<String,Object>]
attr_accessor :response
# The server-assigned name, which is only unique within the same service that
# originally returns it. If you use the default HTTP mapping, the
# `name` should have the format of `operations/some/unique/name`.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# The `Status` type defines a logical error model that is suitable for different
# programming environments, including REST APIs and RPC APIs. It is used by
# [gRPC](https://github.com/grpc). The error model is designed to be:
# - Simple to use and understand for most users
# - Flexible enough to meet unexpected needs
# # Overview
# The `Status` message contains three pieces of data: error code, error message,
# and error details. The error code should be an enum value of
# google.rpc.Code, but it may accept additional error codes if needed. The
# error message should be a developer-facing English message that helps
# developers *understand* and *resolve* the error. If a localized user-facing
# error message is needed, put the localized message in the error details or
# localize it in the client. The optional error details may contain arbitrary
# information about the error. There is a predefined set of error detail types
# in the package `google.rpc` which can be used for common error conditions.
# # Language mapping
# The `Status` message is the logical representation of the error model, but it
# is not necessarily the actual wire format. When the `Status` message is
# exposed in different client libraries and different wire protocols, it can be
# mapped differently. For example, it will likely be mapped to some exceptions
# in Java, but more likely mapped to some error codes in C.
# # Other uses
# The error model and the `Status` message can be used in a variety of
# environments, either with or without APIs, to provide a
# consistent developer experience across different environments.
# Example uses of this error model include:
# - Partial errors. If a service needs to return partial errors to the client,
# it may embed the `Status` in the normal response to indicate the partial
# errors.
# - Workflow errors. A typical workflow has multiple steps. Each step may
# have a `Status` message for error reporting purpose.
# - Batch operations. If a client uses batch request and batch response, the
# `Status` message should be used directly inside batch response, one for
# each error sub-response.
# - Asynchronous operations. If an API call embeds asynchronous operation
# results in its response, the status of those operations should be
# represented directly using the `Status` message.
# - Logging. If some API errors are stored in logs, the message `Status` could
# be used directly after any stripping needed for security/privacy reasons.
# Corresponds to the JSON property `error`
# @return [Google::Apis::CloudresourcemanagerV1::Status]
attr_accessor :error
# Service-specific metadata associated with the operation. It typically
# contains progress information and common metadata such as create time.
# Some services might not provide such metadata. Any method that returns a
# long-running operation should document the metadata type, if any.
# Corresponds to the JSON property `metadata`
# @return [Hash<String,Object>]
attr_accessor :metadata
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@done = args[:done] if args.key?(:done)
@response = args[:response] if args.key?(:response)
@name = args[:name] if args.key?(:name)
@error = args[:error] if args.key?(:error)
@metadata = args[:metadata] if args.key?(:metadata)
end
end
# Identifying information for a single ancestor of a project.
class Ancestor
include Google::Apis::Core::Hashable
# A container to reference an id for any resource type. A `resource` in Google
# Cloud Platform is a generic term for something you (a developer) may want to
# interact with through one of our API's. Some examples are an AppEngine app,
# a Compute Engine instance, a Cloud SQL database, and so on.
# Corresponds to the JSON property `resourceId`
# @return [Google::Apis::CloudresourcemanagerV1::ResourceId]
attr_accessor :resource_id
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@resource_id = args[:resource_id] if args.key?(:resource_id)
end
end
end
end
end

256
generated/google/apis/cloudresourcemanager_v1/representations.rb
View File

@ -22,66 +22,6 @@ module Google
module Apis
module CloudresourcemanagerV1
class GetAncestryRequest
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 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 FolderOperation
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class FolderOperationError
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class ResourceId
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 Ancestor
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class SetIamPolicyRequest
class Representation < Google::Apis::Core::JsonRepresentation; end
@ -124,13 +64,13 @@ module Google
include Google::Apis::Core::JsonObjectSupport
end
class GetIamPolicyRequest
class TestIamPermissionsResponse
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class TestIamPermissionsResponse
class GetIamPolicyRequest
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
@ -161,94 +101,63 @@ module Google
end
class GetAncestryRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation
end
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
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
class Representation < Google::Apis::Core::JsonRepresentation; end
property :create_time, as: 'createTime'
hash :labels, as: 'labels'
property :name, as: 'name'
property :project_id, as: 'projectId'
end
end
class SearchOrganizationsResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :organizations, as: 'organizations', class: Google::Apis::CloudresourcemanagerV1::Organization, decorator: Google::Apis::CloudresourcemanagerV1::Organization::Representation
property :next_page_token, as: 'nextPageToken'
end
include Google::Apis::Core::JsonObjectSupport
end
class TestIamPermissionsRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :permissions, as: 'permissions'
end
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 Policy
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :bindings, as: 'bindings', class: Google::Apis::CloudresourcemanagerV1::Binding, decorator: Google::Apis::CloudresourcemanagerV1::Binding::Representation
class Representation < Google::Apis::Core::JsonRepresentation; end
property :etag, :base64 => true, as: 'etag'
property :version, as: 'version'
end
include Google::Apis::Core::JsonObjectSupport
end
class FolderOperation
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :display_name, as: 'displayName'
property :source_parent, as: 'sourceParent'
property :destination_parent, as: 'destinationParent'
property :operation_type, as: 'operationType'
end
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class FolderOperationError
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :error_message_id, as: 'errorMessageId'
end
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class ResourceId
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :type, as: 'type'
property :id, as: 'id'
end
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
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
class Representation < Google::Apis::Core::JsonRepresentation; end
hash :metadata, as: 'metadata'
end
include Google::Apis::Core::JsonObjectSupport
end
class Ancestor
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :resource_id, as: 'resourceId', class: Google::Apis::CloudresourcemanagerV1::ResourceId, decorator: Google::Apis::CloudresourcemanagerV1::ResourceId::Representation
class Representation < Google::Apis::Core::JsonRepresentation; end
end
include Google::Apis::Core::JsonObjectSupport
end
class SetIamPolicyRequest
@ -309,12 +218,6 @@ module Google
end
end
class GetIamPolicyRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation
end
end
class TestIamPermissionsResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
@ -322,6 +225,12 @@ module Google
end
end
class GetIamPolicyRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation
end
end
class GetAncestryResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
@ -354,6 +263,97 @@ module Google
property :page_size, as: 'pageSize'
end
end
class GetAncestryRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation
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
property :create_time, as: 'createTime'
hash :labels, as: 'labels'
property :name, as: 'name'
property :project_id, as: 'projectId'
end
end
class TestIamPermissionsRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :permissions, as: 'permissions'
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 Policy
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :etag, :base64 => true, as: 'etag'
property :version, as: 'version'
collection :bindings, as: 'bindings', class: Google::Apis::CloudresourcemanagerV1::Binding, decorator: Google::Apis::CloudresourcemanagerV1::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 FolderOperationError
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :error_message_id, as: 'errorMessageId'
end
end
class ResourceId
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :type, as: 'type'
property :id, as: 'id'
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 Ancestor
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :resource_id, as: 'resourceId', class: Google::Apis::CloudresourcemanagerV1::ResourceId, decorator: Google::Apis::CloudresourcemanagerV1::ResourceId::Representation
end
end
end
end
end

252
generated/google/apis/cloudresourcemanager_v1/service.rb
View File

@ -155,42 +155,6 @@ module Google
execute_or_queue_command(command, &block)
end
# Updates the attributes of the Project identified by the specified
# `project_id` (for example, `my-project-123`).
# The caller must have modify permissions for this Project.
# @param [String] project_id
# The project ID (for example, `my-project-123`).
# Required.
# @param [Google::Apis::CloudresourcemanagerV1::Project] project_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::CloudresourcemanagerV1::Project] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudresourcemanagerV1::Project]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def update_project(project_id, project_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:put, 'v1/projects/{projectId}', options)
command.request_representation = Google::Apis::CloudresourcemanagerV1::Project::Representation
command.request_object = project_object
command.response_representation = Google::Apis::CloudresourcemanagerV1::Project::Representation
command.response_class = Google::Apis::CloudresourcemanagerV1::Project
command.params['projectId'] = project_id unless project_id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Gets a list of ancestors in the resource hierarchy for the Project
# identified by the specified `project_id` (for example, `my-project-123`).
# The caller must have read permissions for this Project.
@ -227,6 +191,42 @@ module Google
execute_or_queue_command(command, &block)
end
# Updates the attributes of the Project identified by the specified
# `project_id` (for example, `my-project-123`).
# The caller must have modify permissions for this Project.
# @param [String] project_id
# The project ID (for example, `my-project-123`).
# Required.
# @param [Google::Apis::CloudresourcemanagerV1::Project] project_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::CloudresourcemanagerV1::Project] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudresourcemanagerV1::Project]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def update_project(project_id, project_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:put, 'v1/projects/{projectId}', options)
command.request_representation = Google::Apis::CloudresourcemanagerV1::Project::Representation
command.request_object = project_object
command.response_representation = Google::Apis::CloudresourcemanagerV1::Project::Representation
command.response_class = Google::Apis::CloudresourcemanagerV1::Project
command.params['projectId'] = project_id unless project_id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Returns permissions that a caller has on the specified Project.
# @param [String] resource
# REQUIRED: The resource for which the policy detail is being requested.
@ -370,6 +370,42 @@ module Google
execute_or_queue_command(command, &block)
end
# Request that a new Project be created. The result is an Operation which
# can be used to track the creation process. It is automatically deleted
# after a few hours, so there is no need to call DeleteOperation.
# Our SLO permits Project creation to take up to 30 seconds at the 90th
# percentile. As of 2016-08-29, we are observing 6 seconds 50th percentile
# latency. 95th percentile latency is around 11 seconds. We recommend
# polling at the 5th second with an exponential backoff.
# @param [Google::Apis::CloudresourcemanagerV1::Project] project_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::CloudresourcemanagerV1::Operation] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudresourcemanagerV1::Operation]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def create_project(project_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/projects', options)
command.request_representation = Google::Apis::CloudresourcemanagerV1::Project::Representation
command.request_object = project_object
command.response_representation = Google::Apis::CloudresourcemanagerV1::Operation::Representation
command.response_class = Google::Apis::CloudresourcemanagerV1::Operation
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Sets the IAM access control policy for the specified Project. Replaces
# any existing policy.
# The following constraints apply when using `setIamPolicy()`:
@ -432,14 +468,14 @@ module Google
execute_or_queue_command(command, &block)
end
# Request that a new Project be created. The result is an Operation which
# can be used to track the creation process. It is automatically deleted
# after a few hours, so there is no need to call DeleteOperation.
# Our SLO permits Project creation to take up to 30 seconds at the 90th
# percentile. As of 2016-08-29, we are observing 6 seconds 50th percentile
# latency. 95th percentile latency is around 11 seconds. We recommend
# polling at the 5th second with an exponential backoff.
# @param [Google::Apis::CloudresourcemanagerV1::Project] project_object
# Returns permissions that a caller has on the specified Organization.
# The `resource` field should be the organization's resource name,
# e.g. "organizations/123".
# @param [String] resource
# REQUIRED: The resource for which the policy detail is being requested.
# `resource` is usually specified as a path. For example, a Project
# resource is specified as `projects/`project``.
# @param [Google::Apis::CloudresourcemanagerV1::TestIamPermissionsRequest] test_iam_permissions_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@ -449,20 +485,58 @@ module Google
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::CloudresourcemanagerV1::Operation] parsed result object
# @yieldparam result [Google::Apis::CloudresourcemanagerV1::TestIamPermissionsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudresourcemanagerV1::Operation]
# @return [Google::Apis::CloudresourcemanagerV1::TestIamPermissionsResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def create_project(project_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/projects', options)
command.request_representation = Google::Apis::CloudresourcemanagerV1::Project::Representation
command.request_object = project_object
command.response_representation = Google::Apis::CloudresourcemanagerV1::Operation::Representation
command.response_class = Google::Apis::CloudresourcemanagerV1::Operation
def test_organization_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+resource}:testIamPermissions', options)
command.request_representation = Google::Apis::CloudresourcemanagerV1::TestIamPermissionsRequest::Representation
command.request_object = test_iam_permissions_request_object
command.response_representation = Google::Apis::CloudresourcemanagerV1::TestIamPermissionsResponse::Representation
command.response_class = Google::Apis::CloudresourcemanagerV1::TestIamPermissionsResponse
command.params['resource'] = resource unless resource.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Gets the access control policy for an Organization resource. May be empty
# if no such policy or resource exists. The `resource` field should be the
# organization's resource name, e.g. "organizations/123".
# @param [String] resource
# REQUIRED: The resource for which the policy is being requested.
# `resource` is usually specified as a path. For example, a Project
# resource is specified as `projects/`project``.
# @param [Google::Apis::CloudresourcemanagerV1::GetIamPolicyRequest] get_iam_policy_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::CloudresourcemanagerV1::Policy] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudresourcemanagerV1::Policy]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_organization_iam_policy(resource, get_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+resource}:getIamPolicy', options)
command.request_representation = Google::Apis::CloudresourcemanagerV1::GetIamPolicyRequest::Representation
command.request_object = get_iam_policy_request_object
command.response_representation = Google::Apis::CloudresourcemanagerV1::Policy::Representation
command.response_class = Google::Apis::CloudresourcemanagerV1::Policy
command.params['resource'] = resource unless resource.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
@ -568,80 +642,6 @@ module Google
execute_or_queue_command(command, &block)
end
# Returns permissions that a caller has on the specified Organization.
# The `resource` field should be the organization's resource name,
# e.g. "organizations/123".
# @param [String] resource
# REQUIRED: The resource for which the policy detail is being requested.
# `resource` is usually specified as a path. For example, a Project
# resource is specified as `projects/`project``.
# @param [Google::Apis::CloudresourcemanagerV1::TestIamPermissionsRequest] test_iam_permissions_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::CloudresourcemanagerV1::TestIamPermissionsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudresourcemanagerV1::TestIamPermissionsResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def test_organization_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+resource}:testIamPermissions', options)
command.request_representation = Google::Apis::CloudresourcemanagerV1::TestIamPermissionsRequest::Representation
command.request_object = test_iam_permissions_request_object
command.response_representation = Google::Apis::CloudresourcemanagerV1::TestIamPermissionsResponse::Representation
command.response_class = Google::Apis::CloudresourcemanagerV1::TestIamPermissionsResponse
command.params['resource'] = resource unless resource.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Gets the access control policy for an Organization resource. May be empty
# if no such policy or resource exists. The `resource` field should be the
# organization's resource name, e.g. "organizations/123".
# @param [String] resource
# REQUIRED: The resource for which the policy is being requested.
# `resource` is usually specified as a path. For example, a Project
# resource is specified as `projects/`project``.
# @param [Google::Apis::CloudresourcemanagerV1::GetIamPolicyRequest] get_iam_policy_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::CloudresourcemanagerV1::Policy] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudresourcemanagerV1::Policy]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_organization_iam_policy(resource, get_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+resource}:getIamPolicy', options)
command.request_representation = Google::Apis::CloudresourcemanagerV1::GetIamPolicyRequest::Representation
command.request_object = get_iam_policy_request_object
command.response_representation = Google::Apis::CloudresourcemanagerV1::Policy::Representation
command.response_class = Google::Apis::CloudresourcemanagerV1::Policy
command.params['resource'] = resource unless resource.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Gets 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.

2
generated/google/apis/cloudresourcemanager_v1beta1.rb
View File

@ -26,7 +26,7 @@ module Google
# @see https://cloud.google.com/resource-manager
module CloudresourcemanagerV1beta1
VERSION = 'V1beta1'
REVISION = '20170125'
REVISION = '20170201'
# View your data across Google Cloud Platform services
AUTH_CLOUD_PLATFORM_READ_ONLY = 'https://www.googleapis.com/auth/cloud-platform.read-only'

394
generated/google/apis/cloudresourcemanager_v1beta1/classes.rb
View File

@ -22,6 +22,160 @@ module Google
module Apis
module CloudresourcemanagerV1beta1
# A classification of the Folder Operation error.
class FolderOperationError
include Google::Apis::Core::Hashable
# The type of operation error experienced.
# Corresponds to the JSON property `errorMessageId`
# @return [String]
attr_accessor :error_message_id
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@error_message_id = args[:error_message_id] if args.key?(:error_message_id)
end
end
# Metadata describing a long running folder operation
class FolderOperation
include Google::Apis::Core::Hashable
# The type of this operation.
# Corresponds to the JSON property `operationType`
# @return [String]
attr_accessor :operation_type
# The display name of the folder.
# Corresponds to the JSON property `displayName`
# @return [String]
attr_accessor :display_name
# The resource name of the folder's parent.
# Only applicable when the operation_type is MOVE.
# Corresponds to the JSON property `sourceParent`
# @return [String]
attr_accessor :source_parent
# The resource name of the folder or organization we are either creating
# the folder under or moving the folder to.
# Corresponds to the JSON property `destinationParent`
# @return [String]
attr_accessor :destination_parent
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@operation_type = args[:operation_type] if args.key?(:operation_type)
@display_name = args[:display_name] if args.key?(:display_name)
@source_parent = args[:source_parent] if args.key?(:source_parent)
@destination_parent = args[:destination_parent] if args.key?(:destination_parent)
end
end
# Defines an Identity and Access Management (IAM) policy. It is used to
# specify access control policies for Cloud Platform resources.
# A `Policy` consists of a list of `bindings`. A `Binding` binds a list of
# `members` to a `role`, where the members can be user accounts, Google groups,
# Google domains, and service accounts. A `role` is a named list of permissions
# defined by IAM.
# **Example**
# `
# "bindings": [
# `
# "role": "roles/owner",
# "members": [
# "user:mike@example.com",
# "group:admins@example.com",
# "domain:google.com",
# "serviceAccount:my-other-app@appspot.gserviceaccount.com",
# ]
# `,
# `
# "role": "roles/viewer",
# "members": ["user:sean@example.com"]
# `
# ]
# `
# For a description of IAM and its features, see the
# [IAM developer's guide](https://cloud.google.com/iam).
class Policy
include Google::Apis::Core::Hashable
# Associates a list of `members` to a `role`.
# Multiple `bindings` must not be specified for the same `role`.
# `bindings` with no members will result in an error.
# Corresponds to the JSON property `bindings`
# @return [Array<Google::Apis::CloudresourcemanagerV1beta1::Binding>]
attr_accessor :bindings
# `etag` is used for optimistic concurrency control as a way to help
# prevent simultaneous updates of a policy from overwriting each other.
# It is strongly suggested that systems make use of the `etag` in the
# read-modify-write cycle to perform policy updates in order to avoid race
# conditions: An `etag` is returned in the response to `getIamPolicy`, and
# systems are expected to put that etag in the request to `setIamPolicy` to
# ensure that their change will be applied to the same version of the policy.
# If no `etag` is provided in the call to `setIamPolicy`, then the existing
# policy is overwritten blindly.
# Corresponds to the JSON property `etag`
# @return [String]
attr_accessor :etag
# Version of the `Policy`. The default version is 0.
# Corresponds to the JSON property `version`
# @return [Fixnum]
attr_accessor :version
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@bindings = args[:bindings] if args.key?(:bindings)
@etag = args[:etag] if args.key?(:etag)
@version = args[:version] if args.key?(:version)
end
end
# A container to reference an id for any resource type. A `resource` in Google
# Cloud Platform is a generic term for something you (a developer) may want to
# interact with through one of our API's. Some examples are an AppEngine app,
# a Compute Engine instance, a Cloud SQL database, and so on.
class ResourceId
include Google::Apis::Core::Hashable
# Required field representing the resource type this id is for.
# At present, the valid types are "project" and "organization".
# Corresponds to the JSON property `type`
# @return [String]
attr_accessor :type
# Required field for the type-specific id. This should correspond to the id
# used in the type-specific API's.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@type = args[:type] if args.key?(:type)
@id = args[:id] if args.key?(:id)
end
end
# Identifying information for a single ancestor of a project.
class Ancestor
include Google::Apis::Core::Hashable
@ -92,11 +246,6 @@ module Google
class ListOrganizationsResponse
include Google::Apis::Core::Hashable
# The list of Organizations that matched the list query, possibly paginated.
# Corresponds to the JSON property `organizations`
# @return [Array<Google::Apis::CloudresourcemanagerV1beta1::Organization>]
attr_accessor :organizations
# A pagination token to be used to retrieve the next page of results. If the
# result is too large to fit within the page size specified in the request,
# this field will be set with a token that can be used to fetch the next page
@ -106,14 +255,19 @@ module Google
# @return [String]
attr_accessor :next_page_token
# The list of Organizations that matched the list query, possibly paginated.
# Corresponds to the JSON property `organizations`
# @return [Array<Google::Apis::CloudresourcemanagerV1beta1::Organization>]
attr_accessor :organizations
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@organizations = args[:organizations] if args.key?(:organizations)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
@organizations = args[:organizations] if args.key?(:organizations)
end
end
@ -195,21 +349,6 @@ module Google
class Organization
include Google::Apis::Core::Hashable
# The entity that owns an Organization. The lifetime of the Organization and
# all of its descendants are bound to the `OrganizationOwner`. If the
# `OrganizationOwner` is deleted, the Organization and all its descendants will
# be deleted.
# Corresponds to the JSON property `owner`
# @return [Google::Apis::CloudresourcemanagerV1beta1::OrganizationOwner]
attr_accessor :owner
# Output Only. The resource name of the organization. This is the
# organization's relative path in the API. Its format is
# "organizations/[organization_id]". For example, "organizations/1234".
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# An immutable id for the Organization that is assigned on creation. This
# should be omitted when creating a new Organization.
# This field is read-only.
@ -238,18 +377,33 @@ module Google
# @return [String]
attr_accessor :creation_time
# The entity that owns an Organization. The lifetime of the Organization and
# all of its descendants are bound to the `OrganizationOwner`. If the
# `OrganizationOwner` is deleted, the Organization and all its descendants will
# be deleted.
# Corresponds to the JSON property `owner`
# @return [Google::Apis::CloudresourcemanagerV1beta1::OrganizationOwner]
attr_accessor :owner
# Output Only. The resource name of the organization. This is the
# organization's relative path in the API. Its format is
# "organizations/[organization_id]". For example, "organizations/1234".
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@owner = args[:owner] if args.key?(:owner)
@name = args[:name] if args.key?(:name)
@organization_id = args[:organization_id] if args.key?(:organization_id)
@lifecycle_state = args[:lifecycle_state] if args.key?(:lifecycle_state)
@display_name = args[:display_name] if args.key?(:display_name)
@creation_time = args[:creation_time] if args.key?(:creation_time)
@owner = args[:owner] if args.key?(:owner)
@name = args[:name] if args.key?(:name)
end
end
@ -290,6 +444,19 @@ module Google
end
end
# Request message for `GetIamPolicy` method.
class GetIamPolicyRequest
include Google::Apis::Core::Hashable
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
end
end
# Response message for `TestIamPermissions` method.
class TestIamPermissionsResponse
include Google::Apis::Core::Hashable
@ -310,19 +477,6 @@ module Google
end
end
# Request message for `GetIamPolicy` method.
class GetIamPolicyRequest
include Google::Apis::Core::Hashable
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
end
end
# Response from the GetAncestry method.
class GetAncestryResponse
include Google::Apis::Core::Hashable
@ -425,6 +579,12 @@ module Google
class Project
include Google::Apis::Core::Hashable
# Creation time.
# Read-only.
# Corresponds to the JSON property `createTime`
# @return [String]
attr_accessor :create_time
# The labels associated with this Project.
# Label keys must be between 1 and 63 characters long and must conform
# to the following regular expression: \[a-z\](\[-a-z0-9\]*\[a-z0-9\])?.
@ -439,12 +599,6 @@ module Google
# @return [Hash<String,String>]
attr_accessor :labels
# Creation time.
# Read-only.
# Corresponds to the JSON property `createTime`
# @return [String]
attr_accessor :create_time
# The user-assigned display name of the Project.
# It must be 4 to 30 characters.
# Allowed characters are: lowercase and uppercase letters, numbers,
@ -492,8 +646,8 @@ module Google
# Update properties of this object
def update!(**args)
@labels = args[:labels] if args.key?(:labels)
@create_time = args[:create_time] if args.key?(:create_time)
@labels = args[:labels] if args.key?(:labels)
@name = args[:name] if args.key?(:name)
@project_id = args[:project_id] if args.key?(:project_id)
@lifecycle_state = args[:lifecycle_state] if args.key?(:lifecycle_state)
@ -523,160 +677,6 @@ module Google
@permissions = args[:permissions] if args.key?(:permissions)
end
end
# A classification of the Folder Operation error.
class FolderOperationError
include Google::Apis::Core::Hashable
# The type of operation error experienced.
# Corresponds to the JSON property `errorMessageId`
# @return [String]
attr_accessor :error_message_id
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@error_message_id = args[:error_message_id] if args.key?(:error_message_id)
end
end
# Defines an Identity and Access Management (IAM) policy. It is used to
# specify access control policies for Cloud Platform resources.
# A `Policy` consists of a list of `bindings`. A `Binding` binds a list of
# `members` to a `role`, where the members can be user accounts, Google groups,
# Google domains, and service accounts. A `role` is a named list of permissions
# defined by IAM.
# **Example**
# `
# "bindings": [
# `
# "role": "roles/owner",
# "members": [
# "user:mike@example.com",
# "group:admins@example.com",
# "domain:google.com",
# "serviceAccount:my-other-app@appspot.gserviceaccount.com",
# ]
# `,
# `
# "role": "roles/viewer",
# "members": ["user:sean@example.com"]
# `
# ]
# `
# For a description of IAM and its features, see the
# [IAM developer's guide](https://cloud.google.com/iam).
class Policy
include Google::Apis::Core::Hashable
# `etag` is used for optimistic concurrency control as a way to help
# prevent simultaneous updates of a policy from overwriting each other.
# It is strongly suggested that systems make use of the `etag` in the
# read-modify-write cycle to perform policy updates in order to avoid race
# conditions: An `etag` is returned in the response to `getIamPolicy`, and
# systems are expected to put that etag in the request to `setIamPolicy` to
# ensure that their change will be applied to the same version of the policy.
# If no `etag` is provided in the call to `setIamPolicy`, then the existing
# policy is overwritten blindly.
# Corresponds to the JSON property `etag`
# @return [String]
attr_accessor :etag
# Version of the `Policy`. The default version is 0.
# Corresponds to the JSON property `version`
# @return [Fixnum]
attr_accessor :version
# Associates a list of `members` to a `role`.
# Multiple `bindings` must not be specified for the same `role`.
# `bindings` with no members will result in an error.
# Corresponds to the JSON property `bindings`
# @return [Array<Google::Apis::CloudresourcemanagerV1beta1::Binding>]
attr_accessor :bindings
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@etag = args[:etag] if args.key?(:etag)
@version = args[:version] if args.key?(:version)
@bindings = args[:bindings] if args.key?(:bindings)
end
end
# Metadata describing a long running folder operation
class FolderOperation
include Google::Apis::Core::Hashable
# The display name of the folder.
# Corresponds to the JSON property `displayName`
# @return [String]
attr_accessor :display_name
# The resource name of the folder's parent.
# Only applicable when the operation_type is MOVE.
# Corresponds to the JSON property `sourceParent`
# @return [String]
attr_accessor :source_parent
# The resource name of the folder or organization we are either creating
# the folder under or moving the folder to.
# Corresponds to the JSON property `destinationParent`
# @return [String]
attr_accessor :destination_parent
# The type of this operation.
# Corresponds to the JSON property `operationType`
# @return [String]
attr_accessor :operation_type
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@display_name = args[:display_name] if args.key?(:display_name)
@source_parent = args[:source_parent] if args.key?(:source_parent)
@destination_parent = args[:destination_parent] if args.key?(:destination_parent)
@operation_type = args[:operation_type] if args.key?(:operation_type)
end
end
# A container to reference an id for any resource type. A `resource` in Google
# Cloud Platform is a generic term for something you (a developer) may want to
# interact with through one of our API's. Some examples are an AppEngine app,
# a Compute Engine instance, a Cloud SQL database, and so on.
class ResourceId
include Google::Apis::Core::Hashable
# Required field representing the resource type this id is for.
# At present, the valid types are "project" and "organization".
# Corresponds to the JSON property `type`
# @return [String]
attr_accessor :type
# Required field for the type-specific id. This should correspond to the id
# used in the type-specific API's.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@type = args[:type] if args.key?(:type)
@id = args[:id] if args.key?(:id)
end
end
end
end
end

124
generated/google/apis/cloudresourcemanager_v1beta1/representations.rb
View File

@ -22,6 +22,30 @@ module Google
module Apis
module CloudresourcemanagerV1beta1
class FolderOperationError
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 Policy
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 Ancestor
class Representation < Google::Apis::Core::JsonRepresentation; end
@ -70,13 +94,13 @@ module Google
include Google::Apis::Core::JsonObjectSupport
end
class TestIamPermissionsResponse
class GetIamPolicyRequest
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class GetIamPolicyRequest
class TestIamPermissionsResponse
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
@ -119,27 +143,38 @@ module Google
end
class FolderOperationError
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
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :error_message_id, as: 'errorMessageId'
end
end
class FolderOperation
class Representation < Google::Apis::Core::JsonRepresentation; end
# @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
include Google::Apis::Core::JsonObjectSupport
class Policy
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :bindings, as: 'bindings', class: Google::Apis::CloudresourcemanagerV1beta1::Binding, decorator: Google::Apis::CloudresourcemanagerV1beta1::Binding::Representation
property :etag, :base64 => true, as: 'etag'
property :version, as: 'version'
end
end
class ResourceId
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :type, as: 'type'
property :id, as: 'id'
end
end
class Ancestor
@ -161,9 +196,9 @@ module Google
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
@ -190,13 +225,13 @@ module Google
class Organization
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :owner, as: 'owner', class: Google::Apis::CloudresourcemanagerV1beta1::OrganizationOwner, decorator: Google::Apis::CloudresourcemanagerV1beta1::OrganizationOwner::Representation
property :name, as: 'name'
property :organization_id, as: 'organizationId'
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'
end
end
@ -209,6 +244,12 @@ module Google
end
end
class GetIamPolicyRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation
end
end
class TestIamPermissionsResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
@ -216,12 +257,6 @@ module Google
end
end
class GetIamPolicyRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation
end
end
class GetAncestryResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
@ -255,8 +290,8 @@ module Google
class Project
# @private
class Representation < Google::Apis::Core::JsonRepresentation
hash :labels, as: 'labels'
property :create_time, as: 'createTime'
hash :labels, as: 'labels'
property :name, as: 'name'
property :project_id, as: 'projectId'
property :lifecycle_state, as: 'lifecycleState'
@ -272,41 +307,6 @@ module Google
collection :permissions, as: 'permissions'
end
end
class FolderOperationError
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :error_message_id, as: 'errorMessageId'
end
end
class Policy
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :etag, :base64 => true, as: 'etag'
property :version, as: 'version'
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 :display_name, as: 'displayName'
property :source_parent, as: 'sourceParent'
property :destination_parent, as: 'destinationParent'
property :operation_type, as: 'operationType'
end
end
class ResourceId
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :type, as: 'type'
property :id, as: 'id'
end
end
end
end
end

668
generated/google/apis/cloudresourcemanager_v1beta1/service.rb
View File

@ -47,247 +47,17 @@ module Google
super('https://cloudresourcemanager.googleapis.com/', '')
end
# Returns permissions that a caller has on the specified Organization.
# The `resource` field should be the organization's resource name,
# e.g. "organizations/123".
# @param [String] resource
# REQUIRED: The resource for which the policy detail is being requested.
# `resource` is usually specified as a path. For example, a Project
# resource is specified as `projects/`project``.
# @param [Google::Apis::CloudresourcemanagerV1beta1::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::CloudresourcemanagerV1beta1::TestIamPermissionsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudresourcemanagerV1beta1::TestIamPermissionsResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def test_organization_iam_permissions(resource, test_iam_permissions_request_object = nil, quota_user: nil, fields: nil, options: nil, &block)
command = make_simple_command(:post, 'v1beta1/{+resource}:testIamPermissions', options)
command.request_representation = Google::Apis::CloudresourcemanagerV1beta1::TestIamPermissionsRequest::Representation
command.request_object = test_iam_permissions_request_object
command.response_representation = Google::Apis::CloudresourcemanagerV1beta1::TestIamPermissionsResponse::Representation
command.response_class = Google::Apis::CloudresourcemanagerV1beta1::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 Organization resources that are visible to the user and satisfy
# the specified filter. This method returns Organizations in an unspecified
# order. New Organizations do not necessarily appear at the end of the list.
# @param [String] filter
# An optional query string used to filter the Organizations to return in
# the response. Filter rules are case-insensitive.
# Organizations may be filtered by `owner.directoryCustomerId` or by
# `domain`, where the domain is a Google for Work domain, for example:
# |Filter|Description|
# |------|-----------|
# |owner.directorycustomerid:123456789|Organizations with `owner.
# directory_customer_id` equal to `123456789`.|
# |domain:google.com|Organizations corresponding to the domain `google.com`.|
# This field is optional.
# @param [String] page_token
# A pagination token returned from a previous call to `ListOrganizations`
# that indicates from where listing should continue.
# This field is optional.
# @param [Fixnum] page_size
# The maximum number of Organizations to return in the response.
# This field is optional.
# @param [String] quota_user
# Available to 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::CloudresourcemanagerV1beta1::ListOrganizationsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudresourcemanagerV1beta1::ListOrganizationsResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_organizations(filter: nil, page_token: nil, page_size: nil, quota_user: nil, fields: nil, options: nil, &block)
command = make_simple_command(:get, 'v1beta1/organizations', options)
command.response_representation = Google::Apis::CloudresourcemanagerV1beta1::ListOrganizationsResponse::Representation
command.response_class = Google::Apis::CloudresourcemanagerV1beta1::ListOrganizationsResponse
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
# Sets the access control policy on an Organization resource. Replaces any
# existing policy. The `resource` field should be the organization's resource
# name, e.g. "organizations/123".
# @param [String] resource
# REQUIRED: The resource for which the policy is being specified.
# `resource` is usually specified as a path. For example, a Project
# resource is specified as `projects/`project``.
# @param [Google::Apis::CloudresourcemanagerV1beta1::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::CloudresourcemanagerV1beta1::Policy] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudresourcemanagerV1beta1::Policy]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def set_organization_iam_policy(resource, set_iam_policy_request_object = nil, quota_user: nil, fields: nil, options: nil, &block)
command = make_simple_command(:post, 'v1beta1/{+resource}:setIamPolicy', options)
command.request_representation = Google::Apis::CloudresourcemanagerV1beta1::SetIamPolicyRequest::Representation
command.request_object = set_iam_policy_request_object
command.response_representation = Google::Apis::CloudresourcemanagerV1beta1::Policy::Representation
command.response_class = Google::Apis::CloudresourcemanagerV1beta1::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 an Organization resource. May be empty
# if no such policy or resource exists. The `resource` field should be the
# organization's resource name, e.g. "organizations/123".
# @param [String] resource
# REQUIRED: The resource for which the policy is being requested.
# `resource` is usually specified as a path. For example, a Project
# resource is specified as `projects/`project``.
# @param [Google::Apis::CloudresourcemanagerV1beta1::GetIamPolicyRequest] get_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::CloudresourcemanagerV1beta1::Policy] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudresourcemanagerV1beta1::Policy]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_organization_iam_policy(resource, get_iam_policy_request_object = nil, quota_user: nil, fields: nil, options: nil, &block)
command = make_simple_command(:post, 'v1beta1/{+resource}:getIamPolicy', options)
command.request_representation = Google::Apis::CloudresourcemanagerV1beta1::GetIamPolicyRequest::Representation
command.request_object = get_iam_policy_request_object
command.response_representation = Google::Apis::CloudresourcemanagerV1beta1::Policy::Representation
command.response_class = Google::Apis::CloudresourcemanagerV1beta1::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
# Fetches an Organization resource identified by the specified resource name.
# @param [String] name
# The resource name of the Organization to fetch, e.g. "organizations/1234".
# @param [String] organization_id
# The id of the Organization resource to fetch.
# This field is deprecated and will be removed in v1. Use name instead.
# @param [String] quota_user
# Available to 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::CloudresourcemanagerV1beta1::Organization] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudresourcemanagerV1beta1::Organization]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_organization(name, organization_id: nil, quota_user: nil, fields: nil, options: nil, &block)
command = make_simple_command(:get, 'v1beta1/{+name}', options)
command.response_representation = Google::Apis::CloudresourcemanagerV1beta1::Organization::Representation
command.response_class = Google::Apis::CloudresourcemanagerV1beta1::Organization
command.params['name'] = name unless name.nil?
command.query['organizationId'] = organization_id unless organization_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 Organization resource identified by the specified resource name.
# @param [String] name
# Output Only. The resource name of the organization. This is the
# organization's relative path in the API. Its format is
# "organizations/[organization_id]". For example, "organizations/1234".
# @param [Google::Apis::CloudresourcemanagerV1beta1::Organization] organization_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::CloudresourcemanagerV1beta1::Organization] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudresourcemanagerV1beta1::Organization]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def update_organization(name, organization_object = nil, quota_user: nil, fields: nil, options: nil, &block)
command = make_simple_command(:put, 'v1beta1/{+name}', options)
command.request_representation = Google::Apis::CloudresourcemanagerV1beta1::Organization::Representation
command.request_object = organization_object
command.response_representation = Google::Apis::CloudresourcemanagerV1beta1::Organization::Representation
command.response_class = Google::Apis::CloudresourcemanagerV1beta1::Organization
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
# Retrieves the Project identified by the specified
# `project_id` (for example, `my-project-123`).
# The caller must have read permissions for this Project.
# @param [String] project_id
# The Project ID (for example, `my-project-123`).
# Required.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
@ -300,13 +70,13 @@ module Google
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_project(project_id, quota_user: nil, fields: nil, options: nil, &block)
def get_project(project_id, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1beta1/projects/{projectId}', options)
command.response_representation = Google::Apis::CloudresourcemanagerV1beta1::Project::Representation
command.response_class = Google::Apis::CloudresourcemanagerV1beta1::Project
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?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
@ -320,11 +90,11 @@ module Google
# The project ID (for example, `foo-bar-123`).
# Required.
# @param [Google::Apis::CloudresourcemanagerV1beta1::UndeleteProjectRequest] undelete_project_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
@ -337,51 +107,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 undelete_project(project_id, undelete_project_request_object = nil, quota_user: nil, fields: nil, options: nil, &block)
def undelete_project(project_id, undelete_project_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1beta1/projects/{projectId}:undelete', options)
command.request_representation = Google::Apis::CloudresourcemanagerV1beta1::UndeleteProjectRequest::Representation
command.request_object = undelete_project_request_object
command.response_representation = Google::Apis::CloudresourcemanagerV1beta1::Empty::Representation
command.response_class = Google::Apis::CloudresourcemanagerV1beta1::Empty
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
# Updates the attributes of the Project identified by the specified
# `project_id` (for example, `my-project-123`).
# The caller must have modify permissions for this Project.
# @param [String] project_id
# The project ID (for example, `my-project-123`).
# Required.
# @param [Google::Apis::CloudresourcemanagerV1beta1::Project] project_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::CloudresourcemanagerV1beta1::Project] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudresourcemanagerV1beta1::Project]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def update_project(project_id, project_object = nil, quota_user: nil, fields: nil, options: nil, &block)
command = make_simple_command(:put, 'v1beta1/projects/{projectId}', options)
command.request_representation = Google::Apis::CloudresourcemanagerV1beta1::Project::Representation
command.request_object = project_object
command.response_representation = Google::Apis::CloudresourcemanagerV1beta1::Project::Representation
command.response_class = Google::Apis::CloudresourcemanagerV1beta1::Project
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
@ -392,11 +126,11 @@ module Google
# The Project ID (for example, `my-project-123`).
# Required.
# @param [Google::Apis::CloudresourcemanagerV1beta1::GetAncestryRequest] get_ancestry_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
@ -409,15 +143,51 @@ module Google
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_project_ancestry(project_id, get_ancestry_request_object = nil, quota_user: nil, fields: nil, options: nil, &block)
def get_project_ancestry(project_id, get_ancestry_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1beta1/projects/{projectId}:getAncestry', options)
command.request_representation = Google::Apis::CloudresourcemanagerV1beta1::GetAncestryRequest::Representation
command.request_object = get_ancestry_request_object
command.response_representation = Google::Apis::CloudresourcemanagerV1beta1::GetAncestryResponse::Representation
command.response_class = Google::Apis::CloudresourcemanagerV1beta1::GetAncestryResponse
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?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Updates the attributes of the Project identified by the specified
# `project_id` (for example, `my-project-123`).
# The caller must have modify permissions for this Project.
# @param [String] project_id
# The project ID (for example, `my-project-123`).
# Required.
# @param [Google::Apis::CloudresourcemanagerV1beta1::Project] project_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::CloudresourcemanagerV1beta1::Project] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudresourcemanagerV1beta1::Project]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def update_project(project_id, project_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:put, 'v1beta1/projects/{projectId}', options)
command.request_representation = Google::Apis::CloudresourcemanagerV1beta1::Project::Representation
command.request_object = project_object
command.response_representation = Google::Apis::CloudresourcemanagerV1beta1::Project::Representation
command.response_class = Google::Apis::CloudresourcemanagerV1beta1::Project
command.params['projectId'] = project_id unless project_id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
@ -427,11 +197,11 @@ module Google
# `resource` is usually specified as a path. For example, a Project
# resource is specified as `projects/`project``.
# @param [Google::Apis::CloudresourcemanagerV1beta1::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 [String] fields
# Selector specifying which fields to include in a partial response.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
@ -444,15 +214,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 test_project_iam_permissions(resource, test_iam_permissions_request_object = nil, quota_user: nil, fields: nil, options: nil, &block)
def test_project_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1beta1/projects/{resource}:testIamPermissions', options)
command.request_representation = Google::Apis::CloudresourcemanagerV1beta1::TestIamPermissionsRequest::Representation
command.request_object = test_iam_permissions_request_object
command.response_representation = Google::Apis::CloudresourcemanagerV1beta1::TestIamPermissionsResponse::Representation
command.response_class = Google::Apis::CloudresourcemanagerV1beta1::TestIamPermissionsResponse
command.params['resource'] = resource unless resource.nil?
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
@ -478,11 +248,11 @@ module Google
# @param [String] project_id
# The Project ID (for example, `foo-bar-123`).
# Required.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
@ -495,13 +265,13 @@ 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 delete_project(project_id, quota_user: nil, fields: nil, options: nil, &block)
def delete_project(project_id, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:delete, 'v1beta1/projects/{projectId}', options)
command.response_representation = Google::Apis::CloudresourcemanagerV1beta1::Empty::Representation
command.response_class = Google::Apis::CloudresourcemanagerV1beta1::Empty
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?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
@ -535,11 +305,11 @@ module Google
# A pagination token returned from a previous call to ListProjects
# that indicates from where listing should continue.
# Optional.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
@ -552,15 +322,53 @@ 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_projects(page_size: nil, filter: nil, page_token: nil, quota_user: nil, fields: nil, options: nil, &block)
def list_projects(page_size: nil, filter: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1beta1/projects', options)
command.response_representation = Google::Apis::CloudresourcemanagerV1beta1::ListProjectsResponse::Representation
command.response_class = Google::Apis::CloudresourcemanagerV1beta1::ListProjectsResponse
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?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Creates a Project resource.
# Initially, the Project resource is owned by its creator exclusively.
# The creator can later grant permission to others to read or update the
# Project.
# Several APIs are activated automatically for the Project, including
# Google Cloud Storage.
# @param [Google::Apis::CloudresourcemanagerV1beta1::Project] project_object
# @param [Boolean] use_legacy_stack
# A safety hatch to opt out of the new reliable project creation process.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::CloudresourcemanagerV1beta1::Project] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudresourcemanagerV1beta1::Project]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def create_project(project_object = nil, use_legacy_stack: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1beta1/projects', options)
command.request_representation = Google::Apis::CloudresourcemanagerV1beta1::Project::Representation
command.request_object = project_object
command.response_representation = Google::Apis::CloudresourcemanagerV1beta1::Project::Representation
command.response_class = Google::Apis::CloudresourcemanagerV1beta1::Project
command.query['useLegacyStack'] = use_legacy_stack unless use_legacy_stack.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
@ -595,11 +403,11 @@ module Google
# `resource` is usually specified as a path. For example, a Project
# resource is specified as `projects/`project``.
# @param [Google::Apis::CloudresourcemanagerV1beta1::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 [String] fields
# Selector specifying which fields to include in a partial response.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
@ -612,53 +420,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 set_project_iam_policy(resource, set_iam_policy_request_object = nil, quota_user: nil, fields: nil, options: nil, &block)
def set_project_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1beta1/projects/{resource}:setIamPolicy', options)
command.request_representation = Google::Apis::CloudresourcemanagerV1beta1::SetIamPolicyRequest::Representation
command.request_object = set_iam_policy_request_object
command.response_representation = Google::Apis::CloudresourcemanagerV1beta1::Policy::Representation
command.response_class = Google::Apis::CloudresourcemanagerV1beta1::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
# Creates a Project resource.
# Initially, the Project resource is owned by its creator exclusively.
# The creator can later grant permission to others to read or update the
# Project.
# Several APIs are activated automatically for the Project, including
# Google Cloud Storage.
# @param [Google::Apis::CloudresourcemanagerV1beta1::Project] project_object
# @param [Boolean] use_legacy_stack
# A safety hatch to opt out of the new reliable project creation process.
# @param [String] quota_user
# Available to 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::CloudresourcemanagerV1beta1::Project] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudresourcemanagerV1beta1::Project]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def create_project(project_object = nil, use_legacy_stack: nil, quota_user: nil, fields: nil, options: nil, &block)
command = make_simple_command(:post, 'v1beta1/projects', options)
command.request_representation = Google::Apis::CloudresourcemanagerV1beta1::Project::Representation
command.request_object = project_object
command.response_representation = Google::Apis::CloudresourcemanagerV1beta1::Project::Representation
command.response_class = Google::Apis::CloudresourcemanagerV1beta1::Project
command.query['useLegacyStack'] = use_legacy_stack unless use_legacy_stack.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['fields'] = fields unless fields.nil?
execute_or_queue_command(command, &block)
end
@ -669,11 +439,11 @@ module Google
# `resource` is usually specified as a path. For example, a Project
# resource is specified as `projects/`project``.
# @param [Google::Apis::CloudresourcemanagerV1beta1::GetIamPolicyRequest] get_iam_policy_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
@ -686,15 +456,245 @@ module Google
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_project_iam_policy(resource, get_iam_policy_request_object = nil, quota_user: nil, fields: nil, options: nil, &block)
def get_project_iam_policy(resource, get_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1beta1/projects/{resource}:getIamPolicy', options)
command.request_representation = Google::Apis::CloudresourcemanagerV1beta1::GetIamPolicyRequest::Representation
command.request_object = get_iam_policy_request_object
command.response_representation = Google::Apis::CloudresourcemanagerV1beta1::Policy::Representation
command.response_class = Google::Apis::CloudresourcemanagerV1beta1::Policy
command.params['resource'] = resource unless resource.nil?
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
# Lists Organization resources that are visible to the user and satisfy
# the specified filter. This method returns Organizations in an unspecified
# order. New Organizations do not necessarily appear at the end of the list.
# @param [String] filter
# An optional query string used to filter the Organizations to return in
# the response. Filter rules are case-insensitive.
# Organizations may be filtered by `owner.directoryCustomerId` or by
# `domain`, where the domain is a Google for Work domain, for example:
# |Filter|Description|
# |------|-----------|
# |owner.directorycustomerid:123456789|Organizations with `owner.
# directory_customer_id` equal to `123456789`.|
# |domain:google.com|Organizations corresponding to the domain `google.com`.|
# This field is optional.
# @param [String] page_token
# A pagination token returned from a previous call to `ListOrganizations`
# that indicates from where listing should continue.
# This field is optional.
# @param [Fixnum] page_size
# The maximum number of Organizations to return in the response.
# This field is optional.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::CloudresourcemanagerV1beta1::ListOrganizationsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudresourcemanagerV1beta1::ListOrganizationsResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_organizations(filter: nil, page_token: nil, page_size: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1beta1/organizations', options)
command.response_representation = Google::Apis::CloudresourcemanagerV1beta1::ListOrganizationsResponse::Representation
command.response_class = Google::Apis::CloudresourcemanagerV1beta1::ListOrganizationsResponse
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['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Sets the access control policy on an Organization resource. Replaces any
# existing policy. The `resource` field should be the organization's resource
# name, e.g. "organizations/123".
# @param [String] resource
# REQUIRED: The resource for which the policy is being specified.
# `resource` is usually specified as a path. For example, a Project
# resource is specified as `projects/`project``.
# @param [Google::Apis::CloudresourcemanagerV1beta1::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::CloudresourcemanagerV1beta1::Policy] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudresourcemanagerV1beta1::Policy]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def set_organization_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1beta1/{+resource}:setIamPolicy', options)
command.request_representation = Google::Apis::CloudresourcemanagerV1beta1::SetIamPolicyRequest::Representation
command.request_object = set_iam_policy_request_object
command.response_representation = Google::Apis::CloudresourcemanagerV1beta1::Policy::Representation
command.response_class = Google::Apis::CloudresourcemanagerV1beta1::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 an Organization resource. May be empty
# if no such policy or resource exists. The `resource` field should be the
# organization's resource name, e.g. "organizations/123".
# @param [String] resource
# REQUIRED: The resource for which the policy is being requested.
# `resource` is usually specified as a path. For example, a Project
# resource is specified as `projects/`project``.
# @param [Google::Apis::CloudresourcemanagerV1beta1::GetIamPolicyRequest] get_iam_policy_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::CloudresourcemanagerV1beta1::Policy] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudresourcemanagerV1beta1::Policy]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_organization_iam_policy(resource, get_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1beta1/{+resource}:getIamPolicy', options)
command.request_representation = Google::Apis::CloudresourcemanagerV1beta1::GetIamPolicyRequest::Representation
command.request_object = get_iam_policy_request_object
command.response_representation = Google::Apis::CloudresourcemanagerV1beta1::Policy::Representation
command.response_class = Google::Apis::CloudresourcemanagerV1beta1::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
# Fetches an Organization resource identified by the specified resource name.
# @param [String] name
# The resource name of the Organization to fetch, e.g. "organizations/1234".
# @param [String] organization_id
# The id of the Organization resource to fetch.
# This field is deprecated and will be removed in v1. Use name instead.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::CloudresourcemanagerV1beta1::Organization] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudresourcemanagerV1beta1::Organization]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_organization(name, organization_id: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1beta1/{+name}', options)
command.response_representation = Google::Apis::CloudresourcemanagerV1beta1::Organization::Representation
command.response_class = Google::Apis::CloudresourcemanagerV1beta1::Organization
command.params['name'] = name unless name.nil?
command.query['organizationId'] = organization_id unless organization_id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Updates an Organization resource identified by the specified resource name.
# @param [String] name
# Output Only. The resource name of the organization. This is the
# organization's relative path in the API. Its format is
# "organizations/[organization_id]". For example, "organizations/1234".
# @param [Google::Apis::CloudresourcemanagerV1beta1::Organization] organization_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::CloudresourcemanagerV1beta1::Organization] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudresourcemanagerV1beta1::Organization]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def update_organization(name, organization_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:put, 'v1beta1/{+name}', options)
command.request_representation = Google::Apis::CloudresourcemanagerV1beta1::Organization::Representation
command.request_object = organization_object
command.response_representation = Google::Apis::CloudresourcemanagerV1beta1::Organization::Representation
command.response_class = Google::Apis::CloudresourcemanagerV1beta1::Organization
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Returns permissions that a caller has on the specified Organization.
# The `resource` field should be the organization's resource name,
# e.g. "organizations/123".
# @param [String] resource
# REQUIRED: The resource for which the policy detail is being requested.
# `resource` is usually specified as a path. For example, a Project
# resource is specified as `projects/`project``.
# @param [Google::Apis::CloudresourcemanagerV1beta1::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::CloudresourcemanagerV1beta1::TestIamPermissionsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudresourcemanagerV1beta1::TestIamPermissionsResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def test_organization_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1beta1/{+resource}:testIamPermissions', options)
command.request_representation = Google::Apis::CloudresourcemanagerV1beta1::TestIamPermissionsRequest::Representation
command.request_object = test_iam_permissions_request_object
command.response_representation = Google::Apis::CloudresourcemanagerV1beta1::TestIamPermissionsResponse::Representation
command.response_class = Google::Apis::CloudresourcemanagerV1beta1::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

2
generated/google/apis/content_v2.rb
View File

@ -26,7 +26,7 @@ module Google
# @see https://developers.google.com/shopping-content
module ContentV2
VERSION = 'V2'
REVISION = '20170111'
REVISION = '20170123'
# Manage your product listings and accounts for Google Shopping
AUTH_CONTENT = 'https://www.googleapis.com/auth/content'

12
generated/google/apis/content_v2/classes.rb
View File

@ -661,6 +661,11 @@ module Google
# @return [String]
attr_accessor :country
# A more detailed description of the issue.
# Corresponds to the JSON property `detail`
# @return [String]
attr_accessor :detail
# Actual value displayed on the landing page.
# Corresponds to the JSON property `displayedValue`
# @return [String]
@ -681,6 +686,11 @@ module Google
# @return [String]
attr_accessor :last_checked
# The attribute name that is relevant for the issue.
# Corresponds to the JSON property `location`
# @return [String]
attr_accessor :location
# Number of items in the account found to have the said issue.
# Corresponds to the JSON property `numItems`
# @return [Fixnum]
@ -703,10 +713,12 @@ module Google
# Update properties of this object
def update!(**args)
@country = args[:country] if args.key?(:country)
@detail = args[:detail] if args.key?(:detail)
@displayed_value = args[:displayed_value] if args.key?(:displayed_value)
@example_items = args[:example_items] if args.key?(:example_items)
@id = args[:id] if args.key?(:id)
@last_checked = args[:last_checked] if args.key?(:last_checked)
@location = args[:location] if args.key?(:location)
@num_items = args[:num_items] if args.key?(:num_items)
@severity = args[:severity] if args.key?(:severity)
@submitted_value = args[:submitted_value] if args.key?(:submitted_value)

2
generated/google/apis/content_v2/representations.rb
View File

@ -1202,11 +1202,13 @@ module Google
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :country, as: 'country'
property :detail, as: 'detail'
property :displayed_value, as: 'displayedValue'
collection :example_items, as: 'exampleItems', class: Google::Apis::ContentV2::AccountStatusExampleItem, decorator: Google::Apis::ContentV2::AccountStatusExampleItem::Representation
property :id, as: 'id'
property :last_checked, as: 'lastChecked'
property :location, as: 'location'
property :num_items, as: 'numItems'
property :severity, as: 'severity'
property :submitted_value, as: 'submittedValue'

2
generated/google/apis/dataflow_v1b3.rb
View File

@ -25,7 +25,7 @@ module Google
# @see https://cloud.google.com/dataflow
module DataflowV1b3
VERSION = 'V1b3'
REVISION = '20161004'
REVISION = '20170127'
# View and manage your data across Google Cloud Platform services
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'

7543
generated/google/apis/dataflow_v1b3/classes.rb
View File

File diff suppressed because it is too large Load Diff

2636
generated/google/apis/dataflow_v1b3/representations.rb
View File

File diff suppressed because it is too large Load Diff

1264
generated/google/apis/dataflow_v1b3/service.rb
View File

File diff suppressed because it is too large Load Diff

2
generated/google/apis/datastore_v1.rb
View File

@ -26,7 +26,7 @@ module Google
# @see https://cloud.google.com/datastore/
module DatastoreV1
VERSION = 'V1'
REVISION = '20170110'
REVISION = '20170123'
# View and manage your data across Google Cloud Platform services
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'

2
generated/google/apis/deploymentmanager_v2.rb
View File

@ -25,7 +25,7 @@ module Google
# @see https://cloud.google.com/deployment-manager/
module DeploymentmanagerV2
VERSION = 'V2'
REVISION = '20161221'
REVISION = '20170126'
# View and manage your data across Google Cloud Platform services
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'

33
generated/google/apis/deploymentmanager_v2/classes.rb
View File

@ -22,18 +22,20 @@ module Google
module Apis
module DeploymentmanagerV2
# Provides the configuration for non-admin_activity logging for a service.
# Controls exemptions and specific log sub-types.
# Specifies the audit configuration for a service. It consists of which
# permission types are logged, and what identities, if any, are exempted from
# logging. An AuditConifg must have one or more AuditLogConfigs.
class AuditConfig
include Google::Apis::Core::Hashable
# The configuration for each type of logging
# The configuration for logging of each type of permission.
# Corresponds to the JSON property `auditLogConfigs`
# @return [Array<Google::Apis::DeploymentmanagerV2::AuditLogConfig>]
attr_accessor :audit_log_configs
# Specifies the identities that are exempted from "data access" audit logging
# for the `service` specified above. Follows the same format of Binding.members.
# This field is deprecated in favor of per-permission-type exemptions.
# Corresponds to the JSON property `exemptedMembers`
# @return [Array<String>]
attr_accessor :exempted_members
@ -57,12 +59,16 @@ module Google
end
end
# Provides the configuration for a sub-type of logging.
# Provides the configuration for logging a type of permissions. Example:
# ` "audit_log_configs": [ ` "log_type": "DATA_READ", "exempted_members": [ "
# user:foo@gmail.com" ] `, ` "log_type": "DATA_WRITE", ` ] `
# This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting foo@gmail.
# com from DATA_READ logging.
class AuditLogConfig
include Google::Apis::Core::Hashable
# Specifies the identities that are exempted from this type of logging Follows
# the same format of Binding.members.
# Specifies the identities that do not cause logging for this type of permission.
# Follows the same format of [Binding.members][].
# Corresponds to the JSON property `exemptedMembers`
# @return [Array<String>]
attr_accessor :exempted_members
@ -317,6 +323,12 @@ module Google
class DeploymentUpdate
include Google::Apis::Core::Hashable
# [Output Only] An optional user-provided description of the deployment after
# the current update has been applied.
# Corresponds to the JSON property `description`
# @return [String]
attr_accessor :description
# [Output Only] Map of labels; provided by the client when the resource is
# created or updated. Specifically: Label keys must be between 1 and 63
# characters long and must conform to the following regular expression: [a-z]([-
@ -338,6 +350,7 @@ module Google
# Update properties of this object
def update!(**args)
@description = args[:description] if args.key?(:description)
@labels = args[:labels] if args.key?(:labels)
@manifest = args[:manifest] if args.key?(:manifest)
end
@ -614,7 +627,7 @@ module Google
# @return [String]
attr_accessor :client_operation_id
# [Output Only] Creation timestamp in RFC3339 text format.
# [Deprecated] This field is deprecated.
# Corresponds to the JSON property `creationTimestamp`
# @return [String]
attr_accessor :creation_timestamp
@ -936,11 +949,7 @@ module Google
class Policy
include Google::Apis::Core::Hashable
# Specifies audit logging configs for "data access". "data access": generally
# refers to data reads/writes and admin reads. "admin activity": generally
# refers to admin writes.
# Note: `AuditConfig` doesn't apply to "admin activity", which always enables
# audit logging.
# Specifies cloud audit logging configuration for this policy.
# Corresponds to the JSON property `auditConfigs`
# @return [Array<Google::Apis::DeploymentmanagerV2::AuditConfig>]
attr_accessor :audit_configs

1
generated/google/apis/deploymentmanager_v2/representations.rb
View File

@ -339,6 +339,7 @@ module Google
class DeploymentUpdate
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :description, as: 'description'
collection :labels, as: 'labels', class: Google::Apis::DeploymentmanagerV2::DeploymentUpdateLabelEntry, decorator: Google::Apis::DeploymentmanagerV2::DeploymentUpdateLabelEntry::Representation
property :manifest, as: 'manifest'

10
generated/google/apis/deploymentmanager_v2/service.rb
View File

@ -287,7 +287,7 @@ module Google
# The maximum number of results per page that should be returned. If the number
# of available results is larger than maxResults, Compute Engine returns a
# nextPageToken that can be used to get the next page of results in subsequent
# list requests.
# list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)
# @param [String] order_by
# Sorts list results by a certain order. By default, results are returned in
# alphanumerical order based on the resource name.
@ -650,7 +650,7 @@ module Google
# The maximum number of results per page that should be returned. If the number
# of available results is larger than maxResults, Compute Engine returns a
# nextPageToken that can be used to get the next page of results in subsequent
# list requests.
# list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)
# @param [String] order_by
# Sorts list results by a certain order. By default, results are returned in
# alphanumerical order based on the resource name.
@ -766,7 +766,7 @@ module Google
# The maximum number of results per page that should be returned. If the number
# of available results is larger than maxResults, Compute Engine returns a
# nextPageToken that can be used to get the next page of results in subsequent
# list requests.
# list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)
# @param [String] order_by
# Sorts list results by a certain order. By default, results are returned in
# alphanumerical order based on the resource name.
@ -886,7 +886,7 @@ module Google
# The maximum number of results per page that should be returned. If the number
# of available results is larger than maxResults, Compute Engine returns a
# nextPageToken that can be used to get the next page of results in subsequent
# list requests.
# list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)
# @param [String] order_by
# Sorts list results by a certain order. By default, results are returned in
# alphanumerical order based on the resource name.
@ -964,7 +964,7 @@ module Google
# The maximum number of results per page that should be returned. If the number
# of available results is larger than maxResults, Compute Engine returns a
# nextPageToken that can be used to get the next page of results in subsequent
# list requests.
# list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)
# @param [String] order_by
# Sorts list results by a certain order. By default, results are returned in
# alphanumerical order based on the resource name.

2
generated/google/apis/dns_v1.rb
View File

@ -25,7 +25,7 @@ module Google
# @see https://developers.google.com/cloud-dns
module DnsV1
VERSION = 'V1'
REVISION = '20170118'
REVISION = '20170130'
# View and manage your data across Google Cloud Platform services
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'

2
generated/google/apis/dns_v2beta1.rb
View File

@ -25,7 +25,7 @@ module Google
# @see https://developers.google.com/cloud-dns
module DnsV2beta1
VERSION = 'V2beta1'
REVISION = '20170118'
REVISION = '20170130'
# View and manage your data across Google Cloud Platform services
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'

2
generated/google/apis/doubleclicksearch_v2.rb
View File

@ -26,7 +26,7 @@ module Google
# @see https://developers.google.com/doubleclick-search/
module DoubleclicksearchV2
VERSION = 'V2'
REVISION = '20170119'
REVISION = '20170131'
# View and manage your advertising data in DoubleClick Search
AUTH_DOUBLECLICKSEARCH = 'https://www.googleapis.com/auth/doubleclicksearch'

10
generated/google/apis/doubleclicksearch_v2/classes.rb
View File

@ -121,10 +121,12 @@ module Google
# @return [String]
attr_accessor :click_id
# For offline conversions, this is an ID that advertisers are required to
# provide. Advertisers can specify any ID that is meaningful to them. For online
# conversions, DS copies the dsConversionId or floodlightOrderId into this
# property depending on the advertiser's Floodlight instructions.
# For offline conversions, advertisers provide this ID. Advertisers can specify
# any ID that is meaningful to them. Each conversion in a request must specify a
# unique ID, and the combination of ID and timestamp must be unique amongst all
# conversions within the advertiser.
# For online conversions, DS copies the dsConversionId or floodlightOrderId into
# this property depending on the advertiser's Floodlight instructions.
# Corresponds to the JSON property `conversionId`
# @return [String]
attr_accessor :conversion_id

2
generated/google/apis/drive_v2.rb
View File

@ -26,7 +26,7 @@ module Google
# @see https://developers.google.com/drive/
module DriveV2
VERSION = 'V2'
REVISION = '20170119'
REVISION = '20170131'
# View and manage the files in your Google Drive
AUTH_DRIVE = 'https://www.googleapis.com/auth/drive'

26
generated/google/apis/drive_v2/classes.rb
View File

@ -2559,6 +2559,32 @@ module Google
end
end
#
class StartPageToken
include Google::Apis::Core::Hashable
# Identifies what kind of resource this is. Value: the fixed string "drive#
# startPageToken".
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# The starting page token for listing changes.
# Corresponds to the JSON property `startPageToken`
# @return [String]
attr_accessor :start_page_token
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@kind = args[:kind] if args.key?(:kind)
@start_page_token = args[:start_page_token] if args.key?(:start_page_token)
end
end
# Information about a Drive user.
class User
include Google::Apis::Core::Hashable

14
generated/google/apis/drive_v2/representations.rb
View File

@ -256,6 +256,12 @@ module Google
include Google::Apis::Core::JsonObjectSupport
end
class StartPageToken
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class User
class Representation < Google::Apis::Core::JsonRepresentation; end
@ -861,6 +867,14 @@ module Google
end
end
class StartPageToken
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :kind, as: 'kind'
property :start_page_token, as: 'startPageToken'
end
end
class User
# @private
class Representation < Google::Apis::Core::JsonRepresentation

40
generated/google/apis/drive_v2/service.rb
View File

@ -216,6 +216,38 @@ module Google
execute_or_queue_command(command, &block)
end
# Gets the starting pageToken for listing future changes.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# Overrides userIp if both are provided.
# @param [String] user_ip
# IP address of the site where the request originates. Use this if you want to
# enforce per-user limits.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DriveV2::StartPageToken] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DriveV2::StartPageToken]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_change_start_page_token(fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:get, 'changes/startPageToken', options)
command.response_representation = Google::Apis::DriveV2::StartPageToken::Representation
command.response_class = Google::Apis::DriveV2::StartPageToken
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['userIp'] = user_ip unless user_ip.nil?
execute_or_queue_command(command, &block)
end
# Lists the changes for a user.
# @param [Boolean] include_deleted
# Whether to include deleted items.
@ -226,7 +258,9 @@ module Google
# @param [Fixnum] max_results
# Maximum number of changes to return.
# @param [String] page_token
# Page token for changes.
# The token for continuing a previous list request on the next page. This should
# be set to the value of 'nextPageToken' from the previous response or to the
# response from the getStartPageToken method.
# @param [String] spaces
# A comma-separated list of spaces to query. Supported values are 'drive', '
# appDataFolder' and 'photos'.
@ -280,7 +314,9 @@ module Google
# @param [Fixnum] max_results
# Maximum number of changes to return.
# @param [String] page_token
# Page token for changes.
# The token for continuing a previous list request on the next page. This should
# be set to the value of 'nextPageToken' from the previous response or to the
# response from the getStartPageToken method.
# @param [String] spaces
# A comma-separated list of spaces to query. Supported values are 'drive', '
# appDataFolder' and 'photos'.

2
generated/google/apis/drive_v3.rb
View File

@ -26,7 +26,7 @@ module Google
# @see https://developers.google.com/drive/
module DriveV3
VERSION = 'V3'
REVISION = '20170119'
REVISION = '20170131'
# View and manage the files in your Google Drive
AUTH_DRIVE = 'https://www.googleapis.com/auth/drive'

2
generated/google/apis/games_configuration_v1configuration.rb
View File

@ -25,7 +25,7 @@ module Google
# @see https://developers.google.com/games/services
module GamesConfigurationV1configuration
VERSION = 'V1configuration'
REVISION = '20170119'
REVISION = '20170126'
# View and manage your Google Play Developer account
AUTH_ANDROIDPUBLISHER = 'https://www.googleapis.com/auth/androidpublisher'

2
generated/google/apis/games_management_v1management.rb
View File

@ -25,7 +25,7 @@ module Google
# @see https://developers.google.com/games/services
module GamesManagementV1management
VERSION = 'V1management'
REVISION = '20170119'
REVISION = '20170126'
# Share your Google+ profile information and view and manage your game activity
AUTH_GAMES = 'https://www.googleapis.com/auth/games'

2
generated/google/apis/games_v1.rb
View File

@ -25,7 +25,7 @@ module Google
# @see https://developers.google.com/games/services/
module GamesV1
VERSION = 'V1'
REVISION = '20170119'
REVISION = '20170126'
# View and manage its own configuration data in your Google Drive
AUTH_DRIVE_APPDATA = 'https://www.googleapis.com/auth/drive.appdata'

8
generated/google/apis/genomics_v1.rb
View File

@ -25,7 +25,10 @@ module Google
# @see https://cloud.google.com/genomics
module GenomicsV1
VERSION = 'V1'
REVISION = '20170126'
REVISION = '20170202'
# View and manage Genomics data
AUTH_GENOMICS = 'https://www.googleapis.com/auth/genomics'
# View and manage your data in Google BigQuery
AUTH_BIGQUERY = 'https://www.googleapis.com/auth/bigquery'
@ -38,9 +41,6 @@ module Google
# View Genomics data
AUTH_GENOMICS_READONLY = 'https://www.googleapis.com/auth/genomics.readonly'
# View and manage Genomics data
AUTH_GENOMICS = 'https://www.googleapis.com/auth/genomics'
end
end
end

3128
generated/google/apis/genomics_v1/classes.rb
View File

File diff suppressed because it is too large Load Diff

806
generated/google/apis/genomics_v1/representations.rb
View File

File diff suppressed because it is too large Load Diff

2082
generated/google/apis/genomics_v1/service.rb
View File

File diff suppressed because it is too large Load Diff

2
generated/google/apis/gmail_v1.rb
View File

@ -25,7 +25,7 @@ module Google
# @see https://developers.google.com/gmail/api/
module GmailV1
VERSION = 'V1'
REVISION = '20170124'
REVISION = '20170131'
# View and manage your mail
AUTH_SCOPE = 'https://mail.google.com/'

83
generated/google/apis/gmail_v1/classes.rb
View File

@ -725,6 +725,25 @@ module Google
end
end
#
class ListSmimeInfoResponse
include Google::Apis::Core::Hashable
# List of SmimeInfo.
# Corresponds to the JSON property `smimeInfo`
# @return [Array<Google::Apis::GmailV1::SmimeInfo>]
attr_accessor :smime_info
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@smime_info = args[:smime_info] if args.key?(:smime_info)
end
end
#
class ListThreadsResponse
include Google::Apis::Core::Hashable
@ -1153,6 +1172,68 @@ module Google
end
end
# An S/MIME email config.
class SmimeInfo
include Google::Apis::Core::Hashable
# Encrypted key password, when key is encrypted.
# Corresponds to the JSON property `encryptedKeyPassword`
# @return [String]
attr_accessor :encrypted_key_password
# When the certificate expires (in milliseconds since epoch).
# Corresponds to the JSON property `expiration`
# @return [String]
attr_accessor :expiration
# The immutable ID for the SmimeInfo.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# Whether this SmimeInfo is the default one for this user's send-as address.
# Corresponds to the JSON property `isDefault`
# @return [Boolean]
attr_accessor :is_default
alias_method :is_default?, :is_default
# The S/MIME certificate issuer's common name.
# Corresponds to the JSON property `issuerCn`
# @return [String]
attr_accessor :issuer_cn
# PEM formatted X509 concatenated certificate string (standard base64 encoding).
# Format used for returning key, which includes public key as well as
# certificate chain (not private key).
# Corresponds to the JSON property `pem`
# @return [String]
attr_accessor :pem
# PKCS#12 format containing a single private/public key pair and certificate
# chain. This format is only accepted from client for creating a new SmimeInfo
# and is never returned, because the private key is not intended to be exported.
# PKCS#12 may be encrypted, in which case encryptedKeyPassword should be set
# appropriately.
# Corresponds to the JSON property `pkcs12`
# @return [String]
attr_accessor :pkcs12
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@encrypted_key_password = args[:encrypted_key_password] if args.key?(:encrypted_key_password)
@expiration = args[:expiration] if args.key?(:expiration)
@id = args[:id] if args.key?(:id)
@is_default = args[:is_default] if args.key?(:is_default)
@issuer_cn = args[:issuer_cn] if args.key?(:issuer_cn)
@pem = args[:pem] if args.key?(:pem)
@pkcs12 = args[:pkcs12] if args.key?(:pkcs12)
end
end
# Configuration for communication with an SMTP service.
class SmtpMsa
include Google::Apis::Core::Hashable
@ -1282,7 +1363,7 @@ module Google
alias_method :restrict_to_contacts?, :restrict_to_contacts
# Flag that determines whether responses are sent to recipients who are outside
# of the user's domain. This feature is only available for Google Apps users.
# of the user's domain. This feature is only available for G Suite users.
# Corresponds to the JSON property `restrictToDomain`
# @return [Boolean]
attr_accessor :restrict_to_domain

33
generated/google/apis/gmail_v1/representations.rb
View File

@ -154,6 +154,12 @@ module Google
include Google::Apis::Core::JsonObjectSupport
end
class ListSmimeInfoResponse
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class ListThreadsResponse
class Representation < Google::Apis::Core::JsonRepresentation; end
@ -214,6 +220,12 @@ module Google
include Google::Apis::Core::JsonObjectSupport
end
class SmimeInfo
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class SmtpMsa
class Representation < Google::Apis::Core::JsonRepresentation; end
@ -459,6 +471,14 @@ module Google
end
end
class ListSmimeInfoResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :smime_info, as: 'smimeInfo', class: Google::Apis::GmailV1::SmimeInfo, decorator: Google::Apis::GmailV1::SmimeInfo::Representation
end
end
class ListThreadsResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
@ -567,6 +587,19 @@ module Google
end
end
class SmimeInfo
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :encrypted_key_password, as: 'encryptedKeyPassword'
property :expiration, as: 'expiration'
property :id, as: 'id'
property :is_default, as: 'isDefault'
property :issuer_cn, as: 'issuerCn'
property :pem, as: 'pem'
property :pkcs12, :base64 => true, as: 'pkcs12'
end
end
class SmtpMsa
# @private
class Representation < Google::Apis::Core::JsonRepresentation

220
generated/google/apis/gmail_v1/service.rb
View File

@ -447,6 +447,8 @@ module Google
# @param [String] user_id
# The user's email address. The special value me can be used to indicate the
# authenticated user.
# @param [Array<String>, String] history_types
# History types to be returned by the function
# @param [String] label_id
# Only return messages with a label matching the ID.
# @param [Fixnum] max_results
@ -485,11 +487,12 @@ module Google
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_user_histories(user_id, label_id: nil, max_results: nil, page_token: nil, start_history_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
def list_user_histories(user_id, history_types: nil, label_id: nil, max_results: nil, page_token: nil, start_history_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:get, '{userId}/history', options)
command.response_representation = Google::Apis::GmailV1::ListHistoryResponse::Representation
command.response_class = Google::Apis::GmailV1::ListHistoryResponse
command.params['userId'] = user_id unless user_id.nil?
command.query['historyTypes'] = history_types unless history_types.nil?
command.query['labelId'] = label_id unless label_id.nil?
command.query['maxResults'] = max_results unless max_results.nil?
command.query['pageToken'] = page_token unless page_token.nil?
@ -903,8 +906,7 @@ module Google
# @param [Google::Apis::GmailV1::Message] message_object
# @param [Boolean] deleted
# Mark the email as permanently deleted (not TRASH) and only visible in Google
# Apps Vault to a Vault administrator. Only used for Google Apps for Work
# accounts.
# Vault to a Vault administrator. Only used for G Suite accounts.
# @param [String] internal_date_source
# Source for Gmail's internal date of the message.
# @param [Boolean] never_mark_spam
@ -969,8 +971,7 @@ module Google
# @param [Google::Apis::GmailV1::Message] message_object
# @param [Boolean] deleted
# Mark the email as permanently deleted (not TRASH) and only visible in Google
# Apps Vault to a Vault administrator. Only used for Google Apps for Work
# accounts.
# Vault to a Vault administrator. Only used for G Suite accounts.
# @param [String] internal_date_source
# Source for Gmail's internal date of the message.
# @param [String] fields
@ -2176,6 +2177,215 @@ module Google
execute_or_queue_command(command, &block)
end
# Deletes the specified S/MIME config for the specified send-as alias.
# @param [String] user_id
# The user's email address. The special value me can be used to indicate the
# authenticated user.
# @param [String] send_as_email
# The email address that appears in the "From:" header for mail sent using this
# alias.
# @param [String] id
# The immutable ID for the SmimeInfo.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# Overrides userIp if both are provided.
# @param [String] user_ip
# IP address of the site where the request originates. Use this if you want to
# enforce per-user limits.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [NilClass] No result returned for this method
# @yieldparam err [StandardError] error object if request failed
#
# @return [void]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def delete_user_setting_send_a_smime_info(user_id, send_as_email, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:delete, '{userId}/settings/sendAs/{sendAsEmail}/smimeInfo/{id}', options)
command.params['userId'] = user_id unless user_id.nil?
command.params['sendAsEmail'] = send_as_email unless send_as_email.nil?
command.params['id'] = id unless id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['userIp'] = user_ip unless user_ip.nil?
execute_or_queue_command(command, &block)
end
# Gets the specified S/MIME config for the specified send-as alias.
# @param [String] user_id
# The user's email address. The special value me can be used to indicate the
# authenticated user.
# @param [String] send_as_email
# The email address that appears in the "From:" header for mail sent using this
# alias.
# @param [String] id
# The immutable ID for the SmimeInfo.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# Overrides userIp if both are provided.
# @param [String] user_ip
# IP address of the site where the request originates. Use this if you want to
# enforce per-user limits.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::GmailV1::SmimeInfo] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::GmailV1::SmimeInfo]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_user_setting_send_a_smime_info(user_id, send_as_email, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:get, '{userId}/settings/sendAs/{sendAsEmail}/smimeInfo/{id}', options)
command.response_representation = Google::Apis::GmailV1::SmimeInfo::Representation
command.response_class = Google::Apis::GmailV1::SmimeInfo
command.params['userId'] = user_id unless user_id.nil?
command.params['sendAsEmail'] = send_as_email unless send_as_email.nil?
command.params['id'] = id unless id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['userIp'] = user_ip unless user_ip.nil?
execute_or_queue_command(command, &block)
end
# Insert (upload) the given S/MIME config for the specified send-as alias. Note
# that pkcs12 format is required for the key.
# @param [String] user_id
# The user's email address. The special value me can be used to indicate the
# authenticated user.
# @param [String] send_as_email
# The email address that appears in the "From:" header for mail sent using this
# alias.
# @param [Google::Apis::GmailV1::SmimeInfo] smime_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.
# Overrides userIp if both are provided.
# @param [String] user_ip
# IP address of the site where the request originates. Use this if you want to
# enforce per-user limits.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::GmailV1::SmimeInfo] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::GmailV1::SmimeInfo]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def insert_user_setting_send_a_smime_info(user_id, send_as_email, smime_info_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:post, '{userId}/settings/sendAs/{sendAsEmail}/smimeInfo', options)
command.request_representation = Google::Apis::GmailV1::SmimeInfo::Representation
command.request_object = smime_info_object
command.response_representation = Google::Apis::GmailV1::SmimeInfo::Representation
command.response_class = Google::Apis::GmailV1::SmimeInfo
command.params['userId'] = user_id unless user_id.nil?
command.params['sendAsEmail'] = send_as_email unless send_as_email.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['userIp'] = user_ip unless user_ip.nil?
execute_or_queue_command(command, &block)
end
# Lists S/MIME configs for the specified send-as alias.
# @param [String] user_id
# The user's email address. The special value me can be used to indicate the
# authenticated user.
# @param [String] send_as_email
# The email address that appears in the "From:" header for mail sent using this
# alias.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# Overrides userIp if both are provided.
# @param [String] user_ip
# IP address of the site where the request originates. Use this if you want to
# enforce per-user limits.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::GmailV1::ListSmimeInfoResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::GmailV1::ListSmimeInfoResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_user_setting_send_a_smime_infos(user_id, send_as_email, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:get, '{userId}/settings/sendAs/{sendAsEmail}/smimeInfo', options)
command.response_representation = Google::Apis::GmailV1::ListSmimeInfoResponse::Representation
command.response_class = Google::Apis::GmailV1::ListSmimeInfoResponse
command.params['userId'] = user_id unless user_id.nil?
command.params['sendAsEmail'] = send_as_email unless send_as_email.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['userIp'] = user_ip unless user_ip.nil?
execute_or_queue_command(command, &block)
end
# Sets the default S/MIME config for the specified send-as alias.
# @param [String] user_id
# The user's email address. The special value me can be used to indicate the
# authenticated user.
# @param [String] send_as_email
# The email address that appears in the "From:" header for mail sent using this
# alias.
# @param [String] id
# The immutable ID for the SmimeInfo.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# Overrides userIp if both are provided.
# @param [String] user_ip
# IP address of the site where the request originates. Use this if you 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 set_user_setting_send_a_smime_info_default(user_id, send_as_email, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:post, '{userId}/settings/sendAs/{sendAsEmail}/smimeInfo/{id}/setDefault', options)
command.params['userId'] = user_id unless user_id.nil?
command.params['sendAsEmail'] = send_as_email unless send_as_email.nil?
command.params['id'] = id unless id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['userIp'] = user_ip unless user_ip.nil?
execute_or_queue_command(command, &block)
end
# Immediately and permanently deletes the specified thread. This operation
# cannot be undone. Prefer threads.trash instead.
# @param [String] user_id

2
generated/google/apis/iam_v1.rb
View File

@ -27,7 +27,7 @@ module Google
# @see https://cloud.google.com/iam/
module IamV1
VERSION = 'V1'
REVISION = '20160915'
REVISION = '20170126'
# View and manage your data across Google Cloud Platform services
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'

981
generated/google/apis/iam_v1/classes.rb
View File

File diff suppressed because it is too large Load Diff

333
generated/google/apis/iam_v1/representations.rb
View File

@ -22,36 +22,6 @@ module Google
module Apis
module IamV1
class ListServiceAccountsResponse
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class ServiceAccount
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class CreateServiceAccountRequest
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class Empty
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class ListServiceAccountKeysResponse
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class ServiceAccountKey
class Representation < Google::Apis::Core::JsonRepresentation; end
@ -64,7 +34,7 @@ module Google
include Google::Apis::Core::JsonObjectSupport
end
class SignBlobRequest
class SignJwtResponse
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
@ -76,49 +46,19 @@ module Google
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 Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class TestIamPermissionsResponse
class Policy
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class QueryGrantableRolesRequest
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class QueryGrantableRolesResponse
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class Role
class SignJwtRequest
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
@ -130,73 +70,100 @@ module Google
include Google::Apis::Core::JsonObjectSupport
end
class PolicyDelta
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class BindingDelta
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class ListServiceAccountsResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :accounts, as: 'accounts', class: Google::Apis::IamV1::ServiceAccount, decorator: Google::Apis::IamV1::ServiceAccount::Representation
class PolicyDelta
class Representation < Google::Apis::Core::JsonRepresentation; end
property :next_page_token, as: 'nextPageToken'
end
include Google::Apis::Core::JsonObjectSupport
end
class ServiceAccount
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :name, as: 'name'
property :project_id, as: 'projectId'
property :unique_id, as: 'uniqueId'
property :email, as: 'email'
property :display_name, as: 'displayName'
property :etag, :base64 => true, as: 'etag'
property :oauth2_client_id, as: 'oauth2ClientId'
end
class ListServiceAccountsResponse
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class CreateServiceAccountRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :account_id, as: 'accountId'
property :service_account, as: 'serviceAccount', class: Google::Apis::IamV1::ServiceAccount, decorator: Google::Apis::IamV1::ServiceAccount::Representation
class Representation < Google::Apis::Core::JsonRepresentation; end
end
include Google::Apis::Core::JsonObjectSupport
end
class QueryGrantableRolesResponse
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class SignBlobRequest
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class Role
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 Binding
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class QueryGrantableRolesRequest
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class Empty
# @private
class Representation < Google::Apis::Core::JsonRepresentation
end
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class ServiceAccount
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class TestIamPermissionsResponse
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class ListServiceAccountKeysResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :keys, as: 'keys', class: Google::Apis::IamV1::ServiceAccountKey, decorator: Google::Apis::IamV1::ServiceAccountKey::Representation
class Representation < Google::Apis::Core::JsonRepresentation; end
end
include Google::Apis::Core::JsonObjectSupport
end
class ServiceAccountKey
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :name, as: 'name'
property :valid_after_time, as: 'validAfterTime'
property :private_key_type, as: 'privateKeyType'
property :key_algorithm, as: 'keyAlgorithm'
property :private_key_data, :base64 => true, as: 'privateKeyData'
property :public_key_data, :base64 => true, as: 'publicKeyData'
property :valid_after_time, as: 'validAfterTime'
property :name, as: 'name'
property :valid_before_time, as: 'validBeforeTime'
property :key_algorithm, as: 'keyAlgorithm'
end
end
@ -208,44 +175,19 @@ module Google
end
end
class SignBlobRequest
class SignJwtResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :bytes_to_sign, :base64 => true, as: 'bytesToSign'
property :key_id, as: 'keyId'
property :signed_jwt, as: 'signedJwt'
end
end
class SignBlobResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :key_id, as: 'keyId'
property :signature, :base64 => true, as: 'signature'
end
end
class Policy
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :version, as: 'version'
collection :bindings, as: 'bindings', class: Google::Apis::IamV1::Binding, decorator: Google::Apis::IamV1::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::IamV1::Policy, decorator: Google::Apis::IamV1::Policy::Representation
property :key_id, as: 'keyId'
end
end
@ -256,34 +198,20 @@ module Google
end
end
class TestIamPermissionsResponse
class Policy
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :permissions, as: 'permissions'
end
end
class QueryGrantableRolesRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :full_resource_name, as: 'fullResourceName'
end
end
class QueryGrantableRolesResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :roles, as: 'roles', class: Google::Apis::IamV1::Role, decorator: Google::Apis::IamV1::Role::Representation
property :etag, :base64 => true, as: 'etag'
property :version, as: 'version'
collection :bindings, as: 'bindings', class: Google::Apis::IamV1::Binding, decorator: Google::Apis::IamV1::Binding::Representation
end
end
class Role
class SignJwtRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :name, as: 'name'
property :title, as: 'title'
property :description, as: 'description'
property :payload, as: 'payload'
end
end
@ -295,6 +223,15 @@ module Google
end
end
class BindingDelta
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :action, as: 'action'
property :member, as: 'member'
property :role, as: 'role'
end
end
class PolicyDelta
# @private
class Representation < Google::Apis::Core::JsonRepresentation
@ -303,12 +240,102 @@ module Google
end
end
class BindingDelta
class ListServiceAccountsResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :action, as: 'action'
property :next_page_token, as: 'nextPageToken'
collection :accounts, as: 'accounts', class: Google::Apis::IamV1::ServiceAccount, decorator: Google::Apis::IamV1::ServiceAccount::Representation
end
end
class CreateServiceAccountRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :service_account, as: 'serviceAccount', class: Google::Apis::IamV1::ServiceAccount, decorator: Google::Apis::IamV1::ServiceAccount::Representation
property :account_id, as: 'accountId'
end
end
class QueryGrantableRolesResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :roles, as: 'roles', class: Google::Apis::IamV1::Role, decorator: Google::Apis::IamV1::Role::Representation
end
end
class SignBlobRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :bytes_to_sign, :base64 => true, as: 'bytesToSign'
end
end
class Role
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :name, as: 'name'
property :description, as: 'description'
property :title, as: 'title'
end
end
class SetIamPolicyRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :policy, as: 'policy', class: Google::Apis::IamV1::Policy, decorator: Google::Apis::IamV1::Policy::Representation
end
end
class Binding
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :members, as: 'members'
property :role, as: 'role'
property :member, as: 'member'
end
end
class QueryGrantableRolesRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :full_resource_name, as: 'fullResourceName'
end
end
class Empty
# @private
class Representation < Google::Apis::Core::JsonRepresentation
end
end
class ServiceAccount
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :display_name, as: 'displayName'
property :etag, :base64 => true, as: 'etag'
property :email, as: 'email'
property :name, as: 'name'
property :project_id, as: 'projectId'
property :unique_id, as: 'uniqueId'
property :oauth2_client_id, as: 'oauth2ClientId'
end
end
class TestIamPermissionsResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :permissions, as: 'permissions'
end
end
class ListServiceAccountKeysResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :keys, as: 'keys', class: Google::Apis::IamV1::ServiceAccountKey, decorator: Google::Apis::IamV1::ServiceAccountKey::Representation
end
end
end

584
generated/google/apis/iam_v1/service.rb
View File

@ -48,17 +48,10 @@ module Google
super('https://iam.googleapis.com/', '')
end
# Lists ServiceAccounts for a project.
# @param [String] name
# Required. The resource name of the project associated with the service
# accounts, such as `projects/my-project-123`.
# @param [Fixnum] page_size
# Optional limit on the number of service accounts to include in the response.
# Further accounts can subsequently be obtained by including the
# ListServiceAccountsResponse.next_page_token in a subsequent request.
# @param [String] page_token
# Optional pagination token returned in an earlier ListServiceAccountsResponse.
# next_page_token.
# Queries roles that can be granted on a particular resource.
# A role is grantable if it can be used as the role in a binding for a policy
# for that resource.
# @param [Google::Apis::IamV1::QueryGrantableRolesRequest] query_grantable_roles_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@ -68,60 +61,27 @@ module Google
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::IamV1::ListServiceAccountsResponse] parsed result object
# @yieldparam result [Google::Apis::IamV1::QueryGrantableRolesResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::IamV1::ListServiceAccountsResponse]
# @return [Google::Apis::IamV1::QueryGrantableRolesResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_project_service_accounts(name, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+name}/serviceAccounts', options)
command.response_representation = Google::Apis::IamV1::ListServiceAccountsResponse::Representation
command.response_class = Google::Apis::IamV1::ListServiceAccountsResponse
command.params['name'] = name unless name.nil?
command.query['pageSize'] = page_size unless page_size.nil?
command.query['pageToken'] = page_token unless page_token.nil?
def query_grantable_roles(query_grantable_roles_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/roles:queryGrantableRoles', options)
command.request_representation = Google::Apis::IamV1::QueryGrantableRolesRequest::Representation
command.request_object = query_grantable_roles_request_object
command.response_representation = Google::Apis::IamV1::QueryGrantableRolesResponse::Representation
command.response_class = Google::Apis::IamV1::QueryGrantableRolesResponse
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Gets a ServiceAccount.
# @param [String] name
# The resource name of the service account in the following format: `projects/`
# project`/serviceAccounts/`account``. Using `-` as a wildcard for the project
# will infer the project from the account. The `account` value can be the `email`
# address or the `unique_id` of the service account.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::IamV1::ServiceAccount] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::IamV1::ServiceAccount]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_project_service_account(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+name}', options)
command.response_representation = Google::Apis::IamV1::ServiceAccount::Representation
command.response_class = Google::Apis::IamV1::ServiceAccount
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Creates a ServiceAccount and returns it.
# Creates a ServiceAccount
# and returns it.
# @param [String] name
# Required. The resource name of the project associated with the service
# accounts, such as `projects/my-project-123`.
@ -155,16 +115,17 @@ module Google
execute_or_queue_command(command, &block)
end
# Updates a ServiceAccount. Currently, only the following fields are updatable: `
# display_name` . The `etag` is mandatory.
# Signs a JWT using a service account's system-managed private key.
# If no expiry time (`exp`) is provided in the `SignJwtRequest`, IAM sets an
# an expiry time of one hour by default. If you request an expiry time of
# more than one hour, the request will fail.
# @param [String] name
# The resource name of the service account in the following format: `projects/`
# project`/serviceAccounts/`account``. Requests using `-` as a wildcard for the
# project will infer the project from the `account` and the `account` value can
# be the `email` address or the `unique_id` of the service account. In responses
# the resource name will always be in the format `projects/`project`/
# serviceAccounts/`email``.
# @param [Google::Apis::IamV1::ServiceAccount] service_account_object
# The resource name of the service account in the following format:
# `projects/`PROJECT_ID`/serviceAccounts/`SERVICE_ACCOUNT_EMAIL``.
# Using `-` as a wildcard for the project will infer the project from
# the account. The `account` value can be the `email` address or the
# `unique_id` of the service account.
# @param [Google::Apis::IamV1::SignJwtRequest] sign_jwt_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@ -174,132 +135,32 @@ module Google
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::IamV1::ServiceAccount] parsed result object
# @yieldparam result [Google::Apis::IamV1::SignJwtResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::IamV1::ServiceAccount]
# @return [Google::Apis::IamV1::SignJwtResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def update_project_service_account(name, service_account_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:put, 'v1/{+name}', options)
command.request_representation = Google::Apis::IamV1::ServiceAccount::Representation
command.request_object = service_account_object
command.response_representation = Google::Apis::IamV1::ServiceAccount::Representation
command.response_class = Google::Apis::IamV1::ServiceAccount
def sign_service_account_jwt(name, sign_jwt_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+name}:signJwt', options)
command.request_representation = Google::Apis::IamV1::SignJwtRequest::Representation
command.request_object = sign_jwt_request_object
command.response_representation = Google::Apis::IamV1::SignJwtResponse::Representation
command.response_class = Google::Apis::IamV1::SignJwtResponse
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Deletes a ServiceAccount.
# @param [String] name
# The resource name of the service account in the following format: `projects/`
# project`/serviceAccounts/`account``. Using `-` as a wildcard for the project
# will infer the project from the account. The `account` value can be the `email`
# address or the `unique_id` of the service account.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::IamV1::Empty] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::IamV1::Empty]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def delete_project_service_account(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:delete, 'v1/{+name}', options)
command.response_representation = Google::Apis::IamV1::Empty::Representation
command.response_class = Google::Apis::IamV1::Empty
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Signs a blob using a service account's system-managed private key.
# @param [String] name
# The resource name of the service account in the following format: `projects/`
# project`/serviceAccounts/`account``. Using `-` as a wildcard for the project
# will infer the project from the account. The `account` value can be the `email`
# address or the `unique_id` of the service account.
# @param [Google::Apis::IamV1::SignBlobRequest] sign_blob_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::IamV1::SignBlobResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::IamV1::SignBlobResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def sign_service_account_blob(name, sign_blob_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+name}:signBlob', options)
command.request_representation = Google::Apis::IamV1::SignBlobRequest::Representation
command.request_object = sign_blob_request_object
command.response_representation = Google::Apis::IamV1::SignBlobResponse::Representation
command.response_class = Google::Apis::IamV1::SignBlobResponse
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Returns the IAM access control policy for a ServiceAccount.
# Sets the IAM access control policy for a
# ServiceAccount.
# @param [String] resource
# REQUIRED: The resource for which the policy is being requested. `resource` is
# usually specified as a path. For example, a Project resource is specified as `
# projects/`project``.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::IamV1::Policy] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::IamV1::Policy]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_project_service_account_iam_policy(resource, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+resource}:getIamPolicy', options)
command.response_representation = Google::Apis::IamV1::Policy::Representation
command.response_class = Google::Apis::IamV1::Policy
command.params['resource'] = resource unless resource.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Sets the IAM access control policy for a ServiceAccount.
# @param [String] resource
# REQUIRED: The resource for which the policy is being specified. `resource` is
# usually specified as a path. For example, a Project resource is specified as `
# projects/`project``.
# REQUIRED: The resource for which the policy is being specified.
# `resource` is usually specified as a path. For example, a Project
# resource is specified as `projects/`project``.
# @param [Google::Apis::IamV1::SetIamPolicyRequest] set_iam_policy_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
@ -330,12 +191,121 @@ module Google
execute_or_queue_command(command, &block)
end
# Tests the specified permissions against the IAM access control policy for a
# Returns the IAM access control policy for a
# ServiceAccount.
# @param [String] resource
# REQUIRED: The resource for which the policy detail is being requested. `
# resource` is usually specified as a path. For example, a Project resource is
# specified as `projects/`project``.
# REQUIRED: The resource for which the policy is being requested.
# `resource` is usually specified as a path. For example, a Project
# resource is specified as `projects/`project``.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::IamV1::Policy] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::IamV1::Policy]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_project_service_account_iam_policy(resource, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+resource}:getIamPolicy', options)
command.response_representation = Google::Apis::IamV1::Policy::Representation
command.response_class = Google::Apis::IamV1::Policy
command.params['resource'] = resource unless resource.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Gets a ServiceAccount.
# @param [String] name
# The resource name of the service account in the following format:
# `projects/`PROJECT_ID`/serviceAccounts/`SERVICE_ACCOUNT_EMAIL``.
# Using `-` as a wildcard for the project will infer the project from
# the account. The `account` value can be the `email` address or the
# `unique_id` of the service account.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::IamV1::ServiceAccount] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::IamV1::ServiceAccount]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_project_service_account(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+name}', options)
command.response_representation = Google::Apis::IamV1::ServiceAccount::Representation
command.response_class = Google::Apis::IamV1::ServiceAccount
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Updates a ServiceAccount.
# Currently, only the following fields are updatable:
# `display_name` .
# The `etag` is mandatory.
# @param [String] name
# The resource name of the service account in the following format:
# `projects/`PROJECT_ID`/serviceAccounts/`SERVICE_ACCOUNT_EMAIL``.
# Requests using `-` as a wildcard for the project will infer the project
# from the `account` and the `account` value can be the `email` address or
# the `unique_id` of the service account.
# In responses the resource name will always be in the format
# `projects/`PROJECT_ID`/serviceAccounts/`SERVICE_ACCOUNT_EMAIL``.
# @param [Google::Apis::IamV1::ServiceAccount] service_account_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::IamV1::ServiceAccount] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::IamV1::ServiceAccount]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def update_project_service_account(name, service_account_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:put, 'v1/{+name}', options)
command.request_representation = Google::Apis::IamV1::ServiceAccount::Representation
command.request_object = service_account_object
command.response_representation = Google::Apis::IamV1::ServiceAccount::Representation
command.response_class = Google::Apis::IamV1::ServiceAccount
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Tests the specified permissions against the IAM access control policy
# for a ServiceAccount.
# @param [String] resource
# REQUIRED: The resource for which the policy detail is being requested.
# `resource` is usually specified as a path. For example, a Project
# resource is specified as `projects/`project``.
# @param [Google::Apis::IamV1::TestIamPermissionsRequest] test_iam_permissions_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
@ -366,16 +336,163 @@ module Google
execute_or_queue_command(command, &block)
end
# Deletes a ServiceAccount.
# @param [String] name
# The resource name of the service account in the following format:
# `projects/`PROJECT_ID`/serviceAccounts/`SERVICE_ACCOUNT_EMAIL``.
# Using `-` as a wildcard for the project will infer the project from
# the account. The `account` value can be the `email` address or the
# `unique_id` of the service account.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::IamV1::Empty] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::IamV1::Empty]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def delete_project_service_account(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:delete, 'v1/{+name}', options)
command.response_representation = Google::Apis::IamV1::Empty::Representation
command.response_class = Google::Apis::IamV1::Empty
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Lists ServiceAccounts for a project.
# @param [String] name
# Required. The resource name of the project associated with the service
# accounts, such as `projects/my-project-123`.
# @param [String] page_token
# Optional pagination token returned in an earlier
# ListServiceAccountsResponse.next_page_token.
# @param [Fixnum] page_size
# Optional limit on the number of service accounts to include in the
# response. Further accounts can subsequently be obtained by including the
# ListServiceAccountsResponse.next_page_token
# in a subsequent request.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::IamV1::ListServiceAccountsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::IamV1::ListServiceAccountsResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_project_service_accounts(name, page_token: nil, page_size: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+name}/serviceAccounts', options)
command.response_representation = Google::Apis::IamV1::ListServiceAccountsResponse::Representation
command.response_class = Google::Apis::IamV1::ListServiceAccountsResponse
command.params['name'] = name unless name.nil?
command.query['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
# Signs a blob using a service account's system-managed private key.
# @param [String] name
# The resource name of the service account in the following format:
# `projects/`PROJECT_ID`/serviceAccounts/`SERVICE_ACCOUNT_EMAIL``.
# Using `-` as a wildcard for the project will infer the project from
# the account. The `account` value can be the `email` address or the
# `unique_id` of the service account.
# @param [Google::Apis::IamV1::SignBlobRequest] sign_blob_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::IamV1::SignBlobResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::IamV1::SignBlobResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def sign_service_account_blob(name, sign_blob_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+name}:signBlob', options)
command.request_representation = Google::Apis::IamV1::SignBlobRequest::Representation
command.request_object = sign_blob_request_object
command.response_representation = Google::Apis::IamV1::SignBlobResponse::Representation
command.response_class = Google::Apis::IamV1::SignBlobResponse
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Deletes a ServiceAccountKey.
# @param [String] name
# The resource name of the service account key in the following format:
# `projects/`PROJECT_ID`/serviceAccounts/`SERVICE_ACCOUNT_EMAIL`/keys/`key``.
# Using `-` as a wildcard for the project will infer the project from
# the account. The `account` value can be the `email` address or the
# `unique_id` of the service account.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::IamV1::Empty] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::IamV1::Empty]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def delete_project_service_account_key(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:delete, 'v1/{+name}', options)
command.response_representation = Google::Apis::IamV1::Empty::Representation
command.response_class = Google::Apis::IamV1::Empty
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Lists ServiceAccountKeys.
# @param [String] name
# The resource name of the service account in the following format: `projects/`
# project`/serviceAccounts/`account``. Using `-` as a wildcard for the project,
# will infer the project from the account. The `account` value can be the `email`
# address or the `unique_id` of the service account.
# The resource name of the service account in the following format:
# `projects/`PROJECT_ID`/serviceAccounts/`SERVICE_ACCOUNT_EMAIL``.
# Using `-` as a wildcard for the project, will infer the project from
# the account. The `account` value can be the `email` address or the
# `unique_id` of the service account.
# @param [Array<String>, String] key_types
# Filters the types of keys the user wants to include in the list response.
# Duplicate key types are not allowed. If no key type is provided, all keys are
# returned.
# Filters the types of keys the user wants to include in the list
# response. Duplicate key types are not allowed. If no key type
# is provided, all keys are returned.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@ -404,15 +521,17 @@ module Google
execute_or_queue_command(command, &block)
end
# Gets the ServiceAccountKey by key id.
# Gets the ServiceAccountKey
# by key id.
# @param [String] name
# The resource name of the service account key in the following format: `
# projects/`project`/serviceAccounts/`account`/keys/`key``. Using `-` as a
# wildcard for the project will infer the project from the account. The `account`
# value can be the `email` address or the `unique_id` of the service account.
# The resource name of the service account key in the following format:
# `projects/`PROJECT_ID`/serviceAccounts/`SERVICE_ACCOUNT_EMAIL`/keys/`key``.
# Using `-` as a wildcard for the project will infer the project from
# the account. The `account` value can be the `email` address or the
# `unique_id` of the service account.
# @param [String] public_key_type
# The output format of the public key requested. X509_PEM is the default output
# format.
# The output format of the public key requested.
# X509_PEM is the default output format.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@ -441,12 +560,14 @@ module Google
execute_or_queue_command(command, &block)
end
# Creates a ServiceAccountKey and returns it.
# Creates a ServiceAccountKey
# and returns it.
# @param [String] name
# The resource name of the service account in the following format: `projects/`
# project`/serviceAccounts/`account``. Using `-` as a wildcard for the project
# will infer the project from the account. The `account` value can be the `email`
# address or the `unique_id` of the service account.
# The resource name of the service account in the following format:
# `projects/`PROJECT_ID`/serviceAccounts/`SERVICE_ACCOUNT_EMAIL``.
# Using `-` as a wildcard for the project will infer the project from
# the account. The `account` value can be the `email` address or the
# `unique_id` of the service account.
# @param [Google::Apis::IamV1::CreateServiceAccountKeyRequest] create_service_account_key_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
@ -476,71 +597,6 @@ module Google
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Deletes a ServiceAccountKey.
# @param [String] name
# The resource name of the service account key in the following format: `
# projects/`project`/serviceAccounts/`account`/keys/`key``. Using `-` as a
# wildcard for the project will infer the project from the account. The `account`
# value can be the `email` address or the `unique_id` of the service account.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::IamV1::Empty] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::IamV1::Empty]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def delete_project_service_account_key(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:delete, 'v1/{+name}', options)
command.response_representation = Google::Apis::IamV1::Empty::Representation
command.response_class = Google::Apis::IamV1::Empty
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Queries roles that can be granted on a particular resource. A role is
# grantable if it can be used as the role in a binding for a policy for that
# resource.
# @param [Google::Apis::IamV1::QueryGrantableRolesRequest] query_grantable_roles_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::IamV1::QueryGrantableRolesResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::IamV1::QueryGrantableRolesResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def query_grantable_roles(query_grantable_roles_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/roles:queryGrantableRoles', options)
command.request_representation = Google::Apis::IamV1::QueryGrantableRolesRequest::Representation
command.request_object = query_grantable_roles_request_object
command.response_representation = Google::Apis::IamV1::QueryGrantableRolesResponse::Representation
command.response_class = Google::Apis::IamV1::QueryGrantableRolesResponse
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
protected

12
generated/google/apis/kgsearch_v1/classes.rb
View File

@ -27,17 +27,17 @@ module Google
class SearchResponse
include Google::Apis::Core::Hashable
# The schema type of top-level JSON-LD object, e.g. ItemList.
# Corresponds to the JSON property `@type`
# @return [Object]
attr_accessor :_type
# The local context applicable for the response. See more details at
# http://www.w3.org/TR/json-ld/#context-definitions.
# Corresponds to the JSON property `@context`
# @return [Object]
attr_accessor :_context
# The schema type of top-level JSON-LD object, e.g. ItemList.
# Corresponds to the JSON property `@type`
# @return [Object]
attr_accessor :_type
# The item list of search results.
# Corresponds to the JSON property `itemListElement`
# @return [Array<Object>]
@ -49,8 +49,8 @@ module Google
# Update properties of this object
def update!(**args)
@_context = args[:_context] if args.key?(:_context)
@_type = args[:_type] if args.key?(:_type)
@_context = args[:_context] if args.key?(:_context)
@item_list_element = args[:item_list_element] if args.key?(:item_list_element)
end
end

2
generated/google/apis/kgsearch_v1/representations.rb
View File

@ -31,8 +31,8 @@ module Google
class SearchResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :_context, as: '@context'
property :_type, as: '@type'
property :_context, as: '@context'
collection :item_list_element, as: 'itemListElement'
end
end

30
generated/google/apis/kgsearch_v1/service.rb
View File

@ -49,30 +49,30 @@ module Google
# Searches Knowledge Graph for entities that match the constraints.
# A list of matched entities will be returned in response, which will be in
# JSON-LD format and compatible with http://schema.org
# @param [Fixnum] limit
# Limits the number of entities to be returned.
# @param [Array<String>, String] ids
# The list of entity id to be used for search instead of query string.
# To specify multiple ids in the HTTP request, repeat the parameter in the
# URL as in ...?ids=A&ids=B
# @param [Boolean] prefix
# Enables prefix match against names and aliases of entities
# @param [String] query
# The literal query string for search.
# @param [Boolean] indent
# Enables indenting of json results.
# @param [Array<String>, String] types
# Restricts returned entities with these types, e.g. Person
# (as defined in http://schema.org/Person). If multiple types are specified,
# returned entities will contain one or more of these types.
# @param [Boolean] indent
# Enables indenting of json results.
# @param [Array<String>, String] languages
# The list of language codes (defined in ISO 693) to run the query with,
# e.g. 'en'.
# @param [Array<String>, String] ids
# The list of entity id to be used for search instead of query string.
# To specify multiple ids in the HTTP request, repeat the parameter in the
# URL as in ...?ids=A&ids=B
# @param [Fixnum] limit
# Limits the number of entities to be returned.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
@ -85,19 +85,19 @@ 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_entities(limit: nil, ids: nil, prefix: nil, query: nil, indent: nil, types: nil, languages: nil, quota_user: nil, fields: nil, options: nil, &block)
def search_entities(prefix: nil, query: nil, types: nil, indent: nil, languages: nil, ids: nil, limit: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/entities:search', options)
command.response_representation = Google::Apis::KgsearchV1::SearchResponse::Representation
command.response_class = Google::Apis::KgsearchV1::SearchResponse
command.query['limit'] = limit unless limit.nil?
command.query['ids'] = ids unless ids.nil?
command.query['prefix'] = prefix unless prefix.nil?
command.query['query'] = query unless query.nil?
command.query['indent'] = indent unless indent.nil?
command.query['types'] = types unless types.nil?
command.query['indent'] = indent unless indent.nil?
command.query['languages'] = languages unless languages.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['ids'] = ids unless ids.nil?
command.query['limit'] = limit unless limit.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end

2
generated/google/apis/language_v1beta1.rb
View File

@ -27,7 +27,7 @@ module Google
# @see https://cloud.google.com/natural-language/
module LanguageV1beta1
VERSION = 'V1beta1'
REVISION = '20170103'
REVISION = '20170123'
# View and manage your data across Google Cloud Platform services
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'

936
generated/google/apis/language_v1beta1/classes.rb
View File

File diff suppressed because it is too large Load Diff

440
generated/google/apis/language_v1beta1/representations.rb
View File

@ -22,127 +22,203 @@ module Google
module Apis
module LanguageV1beta1
class Document
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class TextSpan
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class Status
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class AnalyzeEntitiesRequest
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class EntityMention
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class AnalyzeSentimentRequest
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class AnalyzeSentimentResponse
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class AnalyzeSyntaxRequest
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class DependencyEdge
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class AnalyzeSyntaxResponse
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class AnnotateTextRequest
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class Sentence
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class Features
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class PartOfSpeech
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class AnnotateTextResponse
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class Entity
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class Sentiment
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class Token
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class AnalyzeEntitiesResponse
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class AnalyzeSyntaxResponse
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class Entity
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class AnnotateTextRequest
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class AnnotateTextResponse
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class AnalyzeSentimentRequest
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class DependencyEdge
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class TextSpan
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class Token
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class Status
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class EntityMention
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class Features
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class Document
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class Sentence
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class AnalyzeEntitiesRequest
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class Sentiment
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class PartOfSpeech
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class AnalyzeSyntaxRequest
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class AnalyzeSentimentResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :language, as: 'language'
property :gcs_content_uri, as: 'gcsContentUri'
collection :sentences, as: 'sentences', class: Google::Apis::LanguageV1beta1::Sentence, decorator: Google::Apis::LanguageV1beta1::Sentence::Representation
property :document_sentiment, as: 'documentSentiment', class: Google::Apis::LanguageV1beta1::Sentiment, decorator: Google::Apis::LanguageV1beta1::Sentiment::Representation
end
end
class AnalyzeEntitiesResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :language, as: 'language'
collection :entities, as: 'entities', class: Google::Apis::LanguageV1beta1::Entity, decorator: Google::Apis::LanguageV1beta1::Entity::Representation
end
end
class AnalyzeSyntaxResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :language, as: 'language'
collection :sentences, as: 'sentences', class: Google::Apis::LanguageV1beta1::Sentence, decorator: Google::Apis::LanguageV1beta1::Sentence::Representation
collection :tokens, as: 'tokens', class: Google::Apis::LanguageV1beta1::Token, decorator: Google::Apis::LanguageV1beta1::Token::Representation
end
end
class Entity
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :mentions, as: 'mentions', class: Google::Apis::LanguageV1beta1::EntityMention, decorator: Google::Apis::LanguageV1beta1::EntityMention::Representation
property :name, as: 'name'
property :type, as: 'type'
property :content, as: 'content'
hash :metadata, as: 'metadata'
property :salience, as: 'salience'
end
end
class AnnotateTextRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :encoding_type, as: 'encodingType'
property :document, as: 'document', class: Google::Apis::LanguageV1beta1::Document, decorator: Google::Apis::LanguageV1beta1::Document::Representation
property :features, as: 'features', class: Google::Apis::LanguageV1beta1::Features, decorator: Google::Apis::LanguageV1beta1::Features::Representation
end
end
class AnnotateTextResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :language, as: 'language'
collection :sentences, as: 'sentences', class: Google::Apis::LanguageV1beta1::Sentence, decorator: Google::Apis::LanguageV1beta1::Sentence::Representation
collection :tokens, as: 'tokens', class: Google::Apis::LanguageV1beta1::Token, decorator: Google::Apis::LanguageV1beta1::Token::Representation
collection :entities, as: 'entities', class: Google::Apis::LanguageV1beta1::Entity, decorator: Google::Apis::LanguageV1beta1::Entity::Representation
property :document_sentiment, as: 'documentSentiment', class: Google::Apis::LanguageV1beta1::Sentiment, decorator: Google::Apis::LanguageV1beta1::Sentiment::Representation
end
end
class AnalyzeSentimentRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :encoding_type, as: 'encodingType'
property :document, as: 'document', class: Google::Apis::LanguageV1beta1::Document, decorator: Google::Apis::LanguageV1beta1::Document::Representation
end
end
class DependencyEdge
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :head_token_index, as: 'headTokenIndex'
property :label, as: 'label'
end
end
@ -154,21 +230,25 @@ module Google
end
end
class Status
class Token
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :code, as: 'code'
collection :details, as: 'details'
property :message, as: 'message'
property :lemma, as: 'lemma'
property :part_of_speech, as: 'partOfSpeech', class: Google::Apis::LanguageV1beta1::PartOfSpeech, decorator: Google::Apis::LanguageV1beta1::PartOfSpeech::Representation
property :text, as: 'text', class: Google::Apis::LanguageV1beta1::TextSpan, decorator: Google::Apis::LanguageV1beta1::TextSpan::Representation
property :dependency_edge, as: 'dependencyEdge', class: Google::Apis::LanguageV1beta1::DependencyEdge, decorator: Google::Apis::LanguageV1beta1::DependencyEdge::Representation
end
end
class AnalyzeEntitiesRequest
class Status
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :document, as: 'document', class: Google::Apis::LanguageV1beta1::Document, decorator: Google::Apis::LanguageV1beta1::Document::Representation
property :encoding_type, as: 'encodingType'
collection :details, as: 'details'
property :code, as: 'code'
property :message, as: 'message'
end
end
@ -181,62 +261,22 @@ module Google
end
end
class AnalyzeSentimentRequest
class Features
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :document, as: 'document', class: Google::Apis::LanguageV1beta1::Document, decorator: Google::Apis::LanguageV1beta1::Document::Representation
property :encoding_type, as: 'encodingType'
property :extract_syntax, as: 'extractSyntax'
property :extract_document_sentiment, as: 'extractDocumentSentiment'
property :extract_entities, as: 'extractEntities'
end
end
class AnalyzeSentimentResponse
class Document
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :document_sentiment, as: 'documentSentiment', class: Google::Apis::LanguageV1beta1::Sentiment, decorator: Google::Apis::LanguageV1beta1::Sentiment::Representation
property :gcs_content_uri, as: 'gcsContentUri'
property :language, as: 'language'
collection :sentences, as: 'sentences', class: Google::Apis::LanguageV1beta1::Sentence, decorator: Google::Apis::LanguageV1beta1::Sentence::Representation
end
end
class AnalyzeSyntaxRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :document, as: 'document', class: Google::Apis::LanguageV1beta1::Document, decorator: Google::Apis::LanguageV1beta1::Document::Representation
property :encoding_type, as: 'encodingType'
end
end
class DependencyEdge
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :head_token_index, as: 'headTokenIndex'
property :label, as: 'label'
end
end
class AnalyzeSyntaxResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :language, as: 'language'
collection :tokens, as: 'tokens', class: Google::Apis::LanguageV1beta1::Token, decorator: Google::Apis::LanguageV1beta1::Token::Representation
collection :sentences, as: 'sentences', class: Google::Apis::LanguageV1beta1::Sentence, decorator: Google::Apis::LanguageV1beta1::Sentence::Representation
end
end
class AnnotateTextRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :document, as: 'document', class: Google::Apis::LanguageV1beta1::Document, decorator: Google::Apis::LanguageV1beta1::Document::Representation
property :encoding_type, as: 'encodingType'
property :features, as: 'features', class: Google::Apis::LanguageV1beta1::Features, decorator: Google::Apis::LanguageV1beta1::Features::Representation
property :type, as: 'type'
property :content, as: 'content'
end
end
@ -250,88 +290,48 @@ module Google
end
end
class Features
class AnalyzeEntitiesRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :extract_document_sentiment, as: 'extractDocumentSentiment'
property :extract_entities, as: 'extractEntities'
property :extract_syntax, as: 'extractSyntax'
end
end
property :encoding_type, as: 'encodingType'
property :document, as: 'document', class: Google::Apis::LanguageV1beta1::Document, decorator: Google::Apis::LanguageV1beta1::Document::Representation
class PartOfSpeech
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :aspect, as: 'aspect'
property :gender, as: 'gender'
property :person, as: 'person'
property :case, as: 'case'
property :form, as: 'form'
property :tense, as: 'tense'
property :proper, as: 'proper'
property :mood, as: 'mood'
property :tag, as: 'tag'
property :number, as: 'number'
property :reciprocity, as: 'reciprocity'
property :voice, as: 'voice'
end
end
class AnnotateTextResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :entities, as: 'entities', class: Google::Apis::LanguageV1beta1::Entity, decorator: Google::Apis::LanguageV1beta1::Entity::Representation
property :document_sentiment, as: 'documentSentiment', class: Google::Apis::LanguageV1beta1::Sentiment, decorator: Google::Apis::LanguageV1beta1::Sentiment::Representation
property :language, as: 'language'
collection :tokens, as: 'tokens', class: Google::Apis::LanguageV1beta1::Token, decorator: Google::Apis::LanguageV1beta1::Token::Representation
collection :sentences, as: 'sentences', class: Google::Apis::LanguageV1beta1::Sentence, decorator: Google::Apis::LanguageV1beta1::Sentence::Representation
end
end
class Entity
# @private
class Representation < Google::Apis::Core::JsonRepresentation
hash :metadata, as: 'metadata'
property :salience, as: 'salience'
property :type, as: 'type'
collection :mentions, as: 'mentions', class: Google::Apis::LanguageV1beta1::EntityMention, decorator: Google::Apis::LanguageV1beta1::EntityMention::Representation
property :name, as: 'name'
end
end
class Sentiment
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :score, as: 'score'
property :polarity, as: 'polarity'
property :score, as: 'score'
property :magnitude, as: 'magnitude'
end
end
class Token
class PartOfSpeech
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :text, as: 'text', class: Google::Apis::LanguageV1beta1::TextSpan, decorator: Google::Apis::LanguageV1beta1::TextSpan::Representation
property :part_of_speech, as: 'partOfSpeech', class: Google::Apis::LanguageV1beta1::PartOfSpeech, decorator: Google::Apis::LanguageV1beta1::PartOfSpeech::Representation
property :dependency_edge, as: 'dependencyEdge', class: Google::Apis::LanguageV1beta1::DependencyEdge, decorator: Google::Apis::LanguageV1beta1::DependencyEdge::Representation
property :lemma, as: 'lemma'
property :case, as: 'case'
property :tense, as: 'tense'
property :reciprocity, as: 'reciprocity'
property :form, as: 'form'
property :number, as: 'number'
property :voice, as: 'voice'
property :aspect, as: 'aspect'
property :mood, as: 'mood'
property :tag, as: 'tag'
property :gender, as: 'gender'
property :person, as: 'person'
property :proper, as: 'proper'
end
end
class AnalyzeEntitiesResponse
class AnalyzeSyntaxRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :entities, as: 'entities', class: Google::Apis::LanguageV1beta1::Entity, decorator: Google::Apis::LanguageV1beta1::Entity::Representation
property :encoding_type, as: 'encodingType'
property :document, as: 'document', class: Google::Apis::LanguageV1beta1::Document, decorator: Google::Apis::LanguageV1beta1::Document::Representation
property :language, as: 'language'
end
end
end

86
generated/google/apis/language_v1beta1/service.rb
View File

@ -50,11 +50,11 @@ module Google
# Analyzes the sentiment of the provided text.
# @param [Google::Apis::LanguageV1beta1::AnalyzeSentimentRequest] analyze_sentiment_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
@ -67,57 +67,25 @@ 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 analyze_document_sentiment(analyze_sentiment_request_object = nil, quota_user: nil, fields: nil, options: nil, &block)
def analyze_document_sentiment(analyze_sentiment_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1beta1/documents:analyzeSentiment', options)
command.request_representation = Google::Apis::LanguageV1beta1::AnalyzeSentimentRequest::Representation
command.request_object = analyze_sentiment_request_object
command.response_representation = Google::Apis::LanguageV1beta1::AnalyzeSentimentResponse::Representation
command.response_class = Google::Apis::LanguageV1beta1::AnalyzeSentimentResponse
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['fields'] = fields unless fields.nil?
execute_or_queue_command(command, &block)
end
# Analyzes the syntax of the text and provides sentence boundaries and
# tokenization along with part of speech tags, dependency trees, and other
# properties.
# @param [Google::Apis::LanguageV1beta1::AnalyzeSyntaxRequest] analyze_syntax_request_object
# @param [String] quota_user
# Available to 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::LanguageV1beta1::AnalyzeSyntaxResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::LanguageV1beta1::AnalyzeSyntaxResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def analyze_document_syntax(analyze_syntax_request_object = nil, quota_user: nil, fields: nil, options: nil, &block)
command = make_simple_command(:post, 'v1beta1/documents:analyzeSyntax', options)
command.request_representation = Google::Apis::LanguageV1beta1::AnalyzeSyntaxRequest::Representation
command.request_object = analyze_syntax_request_object
command.response_representation = Google::Apis::LanguageV1beta1::AnalyzeSyntaxResponse::Representation
command.response_class = Google::Apis::LanguageV1beta1::AnalyzeSyntaxResponse
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['fields'] = fields unless fields.nil?
execute_or_queue_command(command, &block)
end
# A convenience method that provides all the features that analyzeSentiment,
# analyzeEntities, and analyzeSyntax provide in one call.
# @param [Google::Apis::LanguageV1beta1::AnnotateTextRequest] annotate_text_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
@ -130,25 +98,25 @@ 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 annotate_document_text(annotate_text_request_object = nil, quota_user: nil, fields: nil, options: nil, &block)
def annotate_document_text(annotate_text_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1beta1/documents:annotateText', options)
command.request_representation = Google::Apis::LanguageV1beta1::AnnotateTextRequest::Representation
command.request_object = annotate_text_request_object
command.response_representation = Google::Apis::LanguageV1beta1::AnnotateTextResponse::Representation
command.response_class = Google::Apis::LanguageV1beta1::AnnotateTextResponse
command.query['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
# Finds named entities (currently finds proper names) in the text,
# entity types, salience, mentions for each entity, and other properties.
# @param [Google::Apis::LanguageV1beta1::AnalyzeEntitiesRequest] analyze_entities_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
@ -161,14 +129,46 @@ 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 analyze_document_entities(analyze_entities_request_object = nil, quota_user: nil, fields: nil, options: nil, &block)
def analyze_document_entities(analyze_entities_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1beta1/documents:analyzeEntities', options)
command.request_representation = Google::Apis::LanguageV1beta1::AnalyzeEntitiesRequest::Representation
command.request_object = analyze_entities_request_object
command.response_representation = Google::Apis::LanguageV1beta1::AnalyzeEntitiesResponse::Representation
command.response_class = Google::Apis::LanguageV1beta1::AnalyzeEntitiesResponse
command.query['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
# Analyzes the syntax of the text and provides sentence boundaries and
# tokenization along with part of speech tags, dependency trees, and other
# properties.
# @param [Google::Apis::LanguageV1beta1::AnalyzeSyntaxRequest] analyze_syntax_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::LanguageV1beta1::AnalyzeSyntaxResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::LanguageV1beta1::AnalyzeSyntaxResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def analyze_document_syntax(analyze_syntax_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1beta1/documents:analyzeSyntax', options)
command.request_representation = Google::Apis::LanguageV1beta1::AnalyzeSyntaxRequest::Representation
command.request_object = analyze_syntax_request_object
command.response_representation = Google::Apis::LanguageV1beta1::AnalyzeSyntaxResponse::Representation
command.response_class = Google::Apis::LanguageV1beta1::AnalyzeSyntaxResponse
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end

2
generated/google/apis/logging_v2beta1.rb
View File

@ -25,7 +25,7 @@ module Google
# @see https://cloud.google.com/logging/docs/
module LoggingV2beta1
VERSION = 'V2beta1'
REVISION = '20170121'
REVISION = '20170130'
# View your data across Google Cloud Platform services
AUTH_CLOUD_PLATFORM_READ_ONLY = 'https://www.googleapis.com/auth/cloud-platform.read-only'

1340
generated/google/apis/logging_v2beta1/classes.rb
View File

File diff suppressed because it is too large Load Diff

322
generated/google/apis/logging_v2beta1/representations.rb
View File

@ -22,48 +22,6 @@ module Google
module Apis
module LoggingV2beta1
class LogLine
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class ListLogMetricsResponse
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class LogEntry
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 ListLogEntriesRequest
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class RequestLog
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class ListMonitoredResourceDescriptorsResponse
class Representation < Google::Apis::Core::JsonRepresentation; end
@ -76,12 +34,6 @@ module Google
include Google::Apis::Core::JsonObjectSupport
end
class WriteLogEntriesResponse
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class LogEntryOperation
class Representation < Google::Apis::Core::JsonRepresentation; end
@ -94,19 +46,25 @@ module Google
include Google::Apis::Core::JsonObjectSupport
end
class WriteLogEntriesResponse
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class MonitoredResource
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class WriteLogEntriesRequest
class LogSink
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class LogSink
class WriteLogEntriesRequest
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
@ -155,121 +113,53 @@ module Google
end
class LogLine
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :severity, as: 'severity'
property :log_message, as: 'logMessage'
property :source_location, as: 'sourceLocation', class: Google::Apis::LoggingV2beta1::SourceLocation, decorator: Google::Apis::LoggingV2beta1::SourceLocation::Representation
class Representation < Google::Apis::Core::JsonRepresentation; end
property :time, as: 'time'
end
include Google::Apis::Core::JsonObjectSupport
end
class ListLogMetricsResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :metrics, as: 'metrics', class: Google::Apis::LoggingV2beta1::LogMetric, decorator: Google::Apis::LoggingV2beta1::LogMetric::Representation
class Representation < Google::Apis::Core::JsonRepresentation; end
property :next_page_token, as: 'nextPageToken'
end
include Google::Apis::Core::JsonObjectSupport
end
class LogEntry
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :trace, as: 'trace'
hash :labels, as: 'labels'
property :severity, as: 'severity'
property :source_location, as: 'sourceLocation', class: Google::Apis::LoggingV2beta1::LogEntrySourceLocation, decorator: Google::Apis::LoggingV2beta1::LogEntrySourceLocation::Representation
class Representation < Google::Apis::Core::JsonRepresentation; end
property :timestamp, as: 'timestamp'
property :log_name, as: 'logName'
property :http_request, as: 'httpRequest', class: Google::Apis::LoggingV2beta1::HttpRequest, decorator: Google::Apis::LoggingV2beta1::HttpRequest::Representation
property :resource, as: 'resource', class: Google::Apis::LoggingV2beta1::MonitoredResource, decorator: Google::Apis::LoggingV2beta1::MonitoredResource::Representation
hash :json_payload, as: 'jsonPayload'
property :operation, as: 'operation', class: Google::Apis::LoggingV2beta1::LogEntryOperation, decorator: Google::Apis::LoggingV2beta1::LogEntryOperation::Representation
property :insert_id, as: 'insertId'
property :text_payload, as: 'textPayload'
hash :proto_payload, as: 'protoPayload'
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 SourceLocation
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :file, as: 'file'
property :function_name, as: 'functionName'
property :line, as: 'line'
end
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class ListLogEntriesRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :filter, as: 'filter'
collection :project_ids, as: 'projectIds'
property :page_token, as: 'pageToken'
property :page_size, as: 'pageSize'
property :order_by, as: 'orderBy'
collection :resource_names, as: 'resourceNames'
end
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class RequestLog
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :instance_index, as: 'instanceIndex'
property :host, as: 'host'
property :finished, as: 'finished'
property :http_version, as: 'httpVersion'
property :start_time, as: 'startTime'
property :latency, as: 'latency'
property :ip, as: 'ip'
property :app_id, as: 'appId'
property :app_engine_release, as: 'appEngineRelease'
property :method_prop, as: 'method'
property :cost, as: 'cost'
property :instance_id, as: 'instanceId'
property :mega_cycles, as: 'megaCycles'
property :first, as: 'first'
property :version_id, as: 'versionId'
property :module_id, as: 'moduleId'
property :end_time, as: 'endTime'
property :user_agent, as: 'userAgent'
property :was_loading_request, as: 'wasLoadingRequest'
collection :source_reference, as: 'sourceReference', class: Google::Apis::LoggingV2beta1::SourceReference, decorator: Google::Apis::LoggingV2beta1::SourceReference::Representation
class Representation < Google::Apis::Core::JsonRepresentation; end
property :response_size, as: 'responseSize'
property :trace_id, as: 'traceId'
collection :line, as: 'line', class: Google::Apis::LoggingV2beta1::LogLine, decorator: Google::Apis::LoggingV2beta1::LogLine::Representation
property :referrer, as: 'referrer'
property :task_queue_name, as: 'taskQueueName'
property :request_id, as: 'requestId'
property :nickname, as: 'nickname'
property :status, as: 'status'
property :pending_time, as: 'pendingTime'
property :resource, as: 'resource'
property :task_name, as: 'taskName'
property :url_map_entry, as: 'urlMapEntry'
end
include Google::Apis::Core::JsonObjectSupport
end
class ListMonitoredResourceDescriptorsResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :next_page_token, as: 'nextPageToken'
collection :resource_descriptors, as: 'resourceDescriptors', class: Google::Apis::LoggingV2beta1::MonitoredResourceDescriptor, decorator: Google::Apis::LoggingV2beta1::MonitoredResourceDescriptor::Representation
property :next_page_token, as: 'nextPageToken'
end
end
@ -281,12 +171,6 @@ module Google
end
end
class WriteLogEntriesResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
end
end
class LogEntryOperation
# @private
class Representation < Google::Apis::Core::JsonRepresentation
@ -307,6 +191,12 @@ module Google
end
end
class WriteLogEntriesResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
end
end
class MonitoredResource
# @private
class Representation < Google::Apis::Core::JsonRepresentation
@ -315,29 +205,29 @@ module Google
end
end
class WriteLogEntriesRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :log_name, as: 'logName'
collection :entries, as: 'entries', class: Google::Apis::LoggingV2beta1::LogEntry, decorator: Google::Apis::LoggingV2beta1::LogEntry::Representation
property :partial_success, as: 'partialSuccess'
hash :labels, as: 'labels'
property :resource, as: 'resource', class: Google::Apis::LoggingV2beta1::MonitoredResource, decorator: Google::Apis::LoggingV2beta1::MonitoredResource::Representation
end
end
class LogSink
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :name, as: 'name'
property :destination, as: 'destination'
property :filter, as: 'filter'
property :end_time, as: 'endTime'
property :start_time, as: 'startTime'
property :writer_identity, as: 'writerIdentity'
property :output_version_format, as: 'outputVersionFormat'
property :name, as: 'name'
end
end
class WriteLogEntriesRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation
hash :labels, as: 'labels'
property :resource, as: 'resource', class: Google::Apis::LoggingV2beta1::MonitoredResource, decorator: Google::Apis::LoggingV2beta1::MonitoredResource::Representation
property :log_name, as: 'logName'
collection :entries, as: 'entries', class: Google::Apis::LoggingV2beta1::LogEntry, decorator: Google::Apis::LoggingV2beta1::LogEntry::Representation
property :partial_success, as: 'partialSuccess'
end
end
@ -372,39 +262,39 @@ module Google
class ListSinksResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :next_page_token, as: 'nextPageToken'
collection :sinks, as: 'sinks', class: Google::Apis::LoggingV2beta1::LogSink, decorator: Google::Apis::LoggingV2beta1::LogSink::Representation
property :next_page_token, as: 'nextPageToken'
end
end
class LabelDescriptor
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :value_type, as: 'valueType'
property :key, as: 'key'
property :description, as: 'description'
property :value_type, as: 'valueType'
end
end
class MonitoredResourceDescriptor
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :labels, as: 'labels', class: Google::Apis::LoggingV2beta1::LabelDescriptor, decorator: Google::Apis::LoggingV2beta1::LabelDescriptor::Representation
property :name, as: 'name'
property :display_name, as: 'displayName'
property :description, as: 'description'
property :type, as: 'type'
collection :labels, as: 'labels', class: Google::Apis::LoggingV2beta1::LabelDescriptor, decorator: Google::Apis::LoggingV2beta1::LabelDescriptor::Representation
end
end
class LogEntrySourceLocation
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :file, as: 'file'
property :function, as: 'function'
property :line, as: 'line'
property :file, as: 'file'
end
end
@ -416,6 +306,116 @@ module Google
end
end
class LogLine
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :severity, as: 'severity'
property :log_message, as: 'logMessage'
property :source_location, as: 'sourceLocation', class: Google::Apis::LoggingV2beta1::SourceLocation, decorator: Google::Apis::LoggingV2beta1::SourceLocation::Representation
property :time, as: 'time'
end
end
class ListLogMetricsResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :metrics, as: 'metrics', class: Google::Apis::LoggingV2beta1::LogMetric, decorator: Google::Apis::LoggingV2beta1::LogMetric::Representation
property :next_page_token, as: 'nextPageToken'
end
end
class LogEntry
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :source_location, as: 'sourceLocation', class: Google::Apis::LoggingV2beta1::LogEntrySourceLocation, decorator: Google::Apis::LoggingV2beta1::LogEntrySourceLocation::Representation
property :timestamp, as: 'timestamp'
property :log_name, as: 'logName'
property :resource, as: 'resource', class: Google::Apis::LoggingV2beta1::MonitoredResource, decorator: Google::Apis::LoggingV2beta1::MonitoredResource::Representation
property :http_request, as: 'httpRequest', class: Google::Apis::LoggingV2beta1::HttpRequest, decorator: Google::Apis::LoggingV2beta1::HttpRequest::Representation
hash :json_payload, as: 'jsonPayload'
property :insert_id, as: 'insertId'
property :operation, as: 'operation', class: Google::Apis::LoggingV2beta1::LogEntryOperation, decorator: Google::Apis::LoggingV2beta1::LogEntryOperation::Representation
property :text_payload, as: 'textPayload'
hash :proto_payload, as: 'protoPayload'
property :trace, as: 'trace'
hash :labels, as: 'labels'
property :severity, as: 'severity'
end
end
class Empty
# @private
class Representation < Google::Apis::Core::JsonRepresentation
end
end
class SourceLocation
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :file, as: 'file'
property :function_name, as: 'functionName'
property :line, as: 'line'
end
end
class ListLogEntriesRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :order_by, as: 'orderBy'
collection :resource_names, as: 'resourceNames'
collection :project_ids, as: 'projectIds'
property :filter, as: 'filter'
property :page_token, as: 'pageToken'
property :page_size, as: 'pageSize'
end
end
class RequestLog
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :instance_id, as: 'instanceId'
property :mega_cycles, as: 'megaCycles'
property :first, as: 'first'
property :version_id, as: 'versionId'
property :module_id, as: 'moduleId'
property :end_time, as: 'endTime'
property :user_agent, as: 'userAgent'
property :was_loading_request, as: 'wasLoadingRequest'
collection :source_reference, as: 'sourceReference', class: Google::Apis::LoggingV2beta1::SourceReference, decorator: Google::Apis::LoggingV2beta1::SourceReference::Representation
property :response_size, as: 'responseSize'
property :trace_id, as: 'traceId'
collection :line, as: 'line', class: Google::Apis::LoggingV2beta1::LogLine, decorator: Google::Apis::LoggingV2beta1::LogLine::Representation
property :task_queue_name, as: 'taskQueueName'
property :referrer, as: 'referrer'
property :request_id, as: 'requestId'
property :nickname, as: 'nickname'
property :pending_time, as: 'pendingTime'
property :resource, as: 'resource'
property :status, as: 'status'
property :task_name, as: 'taskName'
property :url_map_entry, as: 'urlMapEntry'
property :instance_index, as: 'instanceIndex'
property :host, as: 'host'
property :finished, as: 'finished'
property :http_version, as: 'httpVersion'
property :start_time, as: 'startTime'
property :latency, as: 'latency'
property :ip, as: 'ip'
property :app_id, as: 'appId'
property :app_engine_release, as: 'appEngineRelease'
property :method_prop, as: 'method'
property :cost, as: 'cost'
end
end
end
end
end

476
generated/google/apis/logging_v2beta1/service.rb
View File

@ -49,11 +49,11 @@ module Google
# Lists log entries. Use this method to retrieve log entries from Stackdriver
# Logging. For ways to export log entries, see Exporting Logs.
# @param [Google::Apis::LoggingV2beta1::ListLogEntriesRequest] list_log_entries_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
@ -66,25 +66,25 @@ 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_entry_log_entries(list_log_entries_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
def list_entry_log_entries(list_log_entries_request_object = nil, quota_user: nil, fields: nil, options: nil, &block)
command = make_simple_command(:post, 'v2beta1/entries:list', options)
command.request_representation = Google::Apis::LoggingV2beta1::ListLogEntriesRequest::Representation
command.request_object = list_log_entries_request_object
command.response_representation = Google::Apis::LoggingV2beta1::ListLogEntriesResponse::Representation
command.response_class = Google::Apis::LoggingV2beta1::ListLogEntriesResponse
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['fields'] = fields unless fields.nil?
execute_or_queue_command(command, &block)
end
# Writes log entries to Stackdriver Logging. All log entries are written by this
# method.
# @param [Google::Apis::LoggingV2beta1::WriteLogEntriesRequest] write_log_entries_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
@ -97,80 +97,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 write_entry_log_entries(write_log_entries_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
def write_entry_log_entries(write_log_entries_request_object = nil, quota_user: nil, fields: nil, options: nil, &block)
command = make_simple_command(:post, 'v2beta1/entries:write', options)
command.request_representation = Google::Apis::LoggingV2beta1::WriteLogEntriesRequest::Representation
command.request_object = write_log_entries_request_object
command.response_representation = Google::Apis::LoggingV2beta1::WriteLogEntriesResponse::Representation
command.response_class = Google::Apis::LoggingV2beta1::WriteLogEntriesResponse
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Creates a logs-based metric.
# @param [String] parent
# The resource name of the project in which to create the metric:
# "projects/[PROJECT_ID]"
# The new metric must be provided in the request.
# @param [Google::Apis::LoggingV2beta1::LogMetric] log_metric_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::LoggingV2beta1::LogMetric] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::LoggingV2beta1::LogMetric]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def create_project_metric(parent, log_metric_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v2beta1/{+parent}/metrics', options)
command.request_representation = Google::Apis::LoggingV2beta1::LogMetric::Representation
command.request_object = log_metric_object
command.response_representation = Google::Apis::LoggingV2beta1::LogMetric::Representation
command.response_class = Google::Apis::LoggingV2beta1::LogMetric
command.params['parent'] = parent unless parent.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Deletes a logs-based metric.
# @param [String] metric_name
# The resource name of the metric to delete:
# "projects/[PROJECT_ID]/metrics/[METRIC_ID]"
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::LoggingV2beta1::Empty] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::LoggingV2beta1::Empty]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def delete_project_metric(metric_name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:delete, 'v2beta1/{+metricName}', options)
command.response_representation = Google::Apis::LoggingV2beta1::Empty::Representation
command.response_class = Google::Apis::LoggingV2beta1::Empty
command.params['metricName'] = metric_name unless metric_name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
@ -178,20 +112,20 @@ module Google
# @param [String] parent
# Required. The name of the project containing the metrics:
# "projects/[PROJECT_ID]"
# @param [Fixnum] page_size
# Optional. The maximum number of results to return from this request. Non-
# positive values are ignored. The presence of nextPageToken in the response
# indicates that more results might be available.
# @param [String] page_token
# Optional. If present, then retrieve the next batch of results from the
# preceding call to this method. pageToken must be the value of nextPageToken
# from the previous response. The values of other method parameters should be
# identical to those in the previous call.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [Fixnum] page_size
# Optional. The maximum number of results to return from this request. Non-
# positive values are ignored. The presence of nextPageToken in the response
# indicates that more results might be available.
# @param [String] quota_user
# Available to 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
#
@ -204,15 +138,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_project_metrics(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
def list_project_metrics(parent, page_token: nil, page_size: nil, quota_user: nil, fields: nil, options: nil, &block)
command = make_simple_command(:get, 'v2beta1/{+parent}/metrics', options)
command.response_representation = Google::Apis::LoggingV2beta1::ListLogMetricsResponse::Representation
command.response_class = Google::Apis::LoggingV2beta1::ListLogMetricsResponse
command.params['parent'] = parent unless parent.nil?
command.query['pageSize'] = page_size unless page_size.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['fields'] = fields unless fields.nil?
command.query['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
@ -220,11 +154,11 @@ module Google
# @param [String] metric_name
# The resource name of the desired metric:
# "projects/[PROJECT_ID]/metrics/[METRIC_ID]"
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
@ -237,13 +171,13 @@ module Google
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_project_metric(metric_name, fields: nil, quota_user: nil, options: nil, &block)
def get_project_metric(metric_name, quota_user: nil, fields: nil, options: nil, &block)
command = make_simple_command(:get, 'v2beta1/{+metricName}', options)
command.response_representation = Google::Apis::LoggingV2beta1::LogMetric::Representation
command.response_class = Google::Apis::LoggingV2beta1::LogMetric
command.params['metricName'] = metric_name unless metric_name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['fields'] = fields unless fields.nil?
execute_or_queue_command(command, &block)
end
@ -255,11 +189,11 @@ module Google
# the same as [METRIC_ID] If the metric does not exist in [PROJECT_ID], then a
# new metric is created.
# @param [Google::Apis::LoggingV2beta1::LogMetric] log_metric_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
@ -272,32 +206,62 @@ module Google
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def update_project_metric(metric_name, log_metric_object = nil, fields: nil, quota_user: nil, options: nil, &block)
def update_project_metric(metric_name, log_metric_object = nil, quota_user: nil, fields: nil, options: nil, &block)
command = make_simple_command(:put, 'v2beta1/{+metricName}', options)
command.request_representation = Google::Apis::LoggingV2beta1::LogMetric::Representation
command.request_object = log_metric_object
command.response_representation = Google::Apis::LoggingV2beta1::LogMetric::Representation
command.response_class = Google::Apis::LoggingV2beta1::LogMetric
command.params['metricName'] = metric_name unless metric_name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['fields'] = fields unless fields.nil?
execute_or_queue_command(command, &block)
end
# Deletes all the log entries in a log. The log reappears if it receives new
# entries.
# @param [String] log_name
# Required. The resource name of the log to delete:
# "projects/[PROJECT_ID]/logs/[LOG_ID]"
# "organizations/[ORGANIZATION_ID]/logs/[LOG_ID]"
# [LOG_ID] must be URL-encoded. For example, "projects/my-project-id/logs/syslog"
# , "organizations/1234567890/logs/cloudresourcemanager.googleapis.com%
# 2Factivity". For more information about log names, see LogEntry.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# Creates a logs-based metric.
# @param [String] parent
# The resource name of the project in which to create the metric:
# "projects/[PROJECT_ID]"
# The new metric must be provided in the request.
# @param [Google::Apis::LoggingV2beta1::LogMetric] log_metric_object
# @param [String] quota_user
# Available to 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::LoggingV2beta1::LogMetric] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::LoggingV2beta1::LogMetric]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def create_project_metric(parent, log_metric_object = nil, quota_user: nil, fields: nil, options: nil, &block)
command = make_simple_command(:post, 'v2beta1/{+parent}/metrics', options)
command.request_representation = Google::Apis::LoggingV2beta1::LogMetric::Representation
command.request_object = log_metric_object
command.response_representation = Google::Apis::LoggingV2beta1::LogMetric::Representation
command.response_class = Google::Apis::LoggingV2beta1::LogMetric
command.params['parent'] = parent unless parent.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['fields'] = fields unless fields.nil?
execute_or_queue_command(command, &block)
end
# Deletes a logs-based metric.
# @param [String] metric_name
# The resource name of the metric to delete:
# "projects/[PROJECT_ID]/metrics/[METRIC_ID]"
# @param [String] quota_user
# Available to 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
#
@ -310,13 +274,49 @@ 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 delete_log(log_name, fields: nil, quota_user: nil, options: nil, &block)
def delete_project_metric(metric_name, quota_user: nil, fields: nil, options: nil, &block)
command = make_simple_command(:delete, 'v2beta1/{+metricName}', options)
command.response_representation = Google::Apis::LoggingV2beta1::Empty::Representation
command.response_class = Google::Apis::LoggingV2beta1::Empty
command.params['metricName'] = metric_name unless metric_name.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['fields'] = fields unless fields.nil?
execute_or_queue_command(command, &block)
end
# Deletes all the log entries in a log. The log reappears if it receives new
# entries.
# @param [String] log_name
# Required. The resource name of the log to delete:
# "projects/[PROJECT_ID]/logs/[LOG_ID]"
# "organizations/[ORGANIZATION_ID]/logs/[LOG_ID]"
# [LOG_ID] must be URL-encoded. For example, "projects/my-project-id/logs/syslog"
# , "organizations/1234567890/logs/cloudresourcemanager.googleapis.com%
# 2Factivity". For more information about log names, see LogEntry.
# @param [String] quota_user
# Available to 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::LoggingV2beta1::Empty] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::LoggingV2beta1::Empty]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def delete_log(log_name, quota_user: nil, fields: nil, options: nil, &block)
command = make_simple_command(:delete, 'v2beta1/{+logName}', options)
command.response_representation = Google::Apis::LoggingV2beta1::Empty::Representation
command.response_class = Google::Apis::LoggingV2beta1::Empty
command.params['logName'] = log_name unless log_name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['fields'] = fields unless fields.nil?
execute_or_queue_command(command, &block)
end
@ -335,11 +335,11 @@ module Google
# Optional. The maximum number of results to return from this request. Non-
# positive values are ignored. The presence of nextPageToken in the response
# indicates that more results might be available.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to 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
#
@ -352,51 +352,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_logs(parent, page_token: nil, page_size: nil, fields: nil, quota_user: nil, options: nil, &block)
def list_logs(parent, page_token: nil, page_size: nil, quota_user: nil, fields: nil, options: nil, &block)
command = make_simple_command(:get, 'v2beta1/{+parent}/logs', options)
command.response_representation = Google::Apis::LoggingV2beta1::ListLogsResponse::Representation
command.response_class = Google::Apis::LoggingV2beta1::ListLogsResponse
command.params['parent'] = parent unless parent.nil?
command.query['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
# Deletes a sink. If the sink has a unique writer_identity, then that service
# account is also deleted.
# @param [String] sink_name
# Required. The full resource name of the sink to delete, including the parent
# resource and the sink identifier:
# "projects/[PROJECT_ID]/sinks/[SINK_ID]"
# "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]"
# It is an error if the sink does not exist. Example: "projects/my-project-id/
# sinks/my-sink-id". It is an error if the sink does not exist.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::LoggingV2beta1::Empty] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::LoggingV2beta1::Empty]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def delete_project_sink(sink_name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:delete, 'v2beta1/{+sinkName}', options)
command.response_representation = Google::Apis::LoggingV2beta1::Empty::Representation
command.response_class = Google::Apis::LoggingV2beta1::Empty
command.params['sinkName'] = sink_name unless sink_name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
@ -404,20 +368,20 @@ module Google
# @param [String] parent
# Required. The parent resource whose sinks are to be listed. Examples: "
# projects/my-logging-project", "organizations/123456789".
# @param [Fixnum] page_size
# Optional. The maximum number of results to return from this request. Non-
# positive values are ignored. The presence of nextPageToken in the response
# indicates that more results might be available.
# @param [String] page_token
# Optional. If present, then retrieve the next batch of results from the
# preceding call to this method. pageToken must be the value of nextPageToken
# from the previous response. The values of other method parameters should be
# identical to those in the previous call.
# @param [Fixnum] page_size
# Optional. The maximum number of results to return from this request. Non-
# positive values are ignored. The presence of nextPageToken in the response
# indicates that more results might be available.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to 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
#
@ -430,15 +394,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_project_sinks(parent, page_token: nil, page_size: nil, fields: nil, quota_user: nil, options: nil, &block)
def list_project_sinks(parent, page_size: nil, page_token: nil, quota_user: nil, fields: nil, options: nil, &block)
command = make_simple_command(:get, 'v2beta1/{+parent}/sinks', options)
command.response_representation = Google::Apis::LoggingV2beta1::ListSinksResponse::Representation
command.response_class = Google::Apis::LoggingV2beta1::ListSinksResponse
command.params['parent'] = parent unless parent.nil?
command.query['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['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
@ -448,11 +412,11 @@ module Google
# "projects/[PROJECT_ID]/sinks/[SINK_ID]"
# "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]"
# Example: "projects/my-project-id/sinks/my-sink-id".
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
@ -465,13 +429,13 @@ module Google
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_project_sink(sink_name, fields: nil, quota_user: nil, options: nil, &block)
def get_project_sink(sink_name, quota_user: nil, fields: nil, options: nil, &block)
command = make_simple_command(:get, 'v2beta1/{+sinkName}', options)
command.response_representation = Google::Apis::LoggingV2beta1::LogSink::Representation
command.response_class = Google::Apis::LoggingV2beta1::LogSink
command.params['sinkName'] = sink_name unless sink_name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['fields'] = fields unless fields.nil?
execute_or_queue_command(command, &block)
end
@ -497,11 +461,11 @@ module Google
# If the old value was false and the new value is true, then writer_identity is
# changed to a unique service account.
# It is an error if the old value was true and the new value is false.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
@ -514,7 +478,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 update_project_sink(sink_name, log_sink_object = nil, unique_writer_identity: nil, fields: nil, quota_user: nil, options: nil, &block)
def update_project_sink(sink_name, log_sink_object = nil, unique_writer_identity: nil, quota_user: nil, fields: nil, options: nil, &block)
command = make_simple_command(:put, 'v2beta1/{+sinkName}', options)
command.request_representation = Google::Apis::LoggingV2beta1::LogSink::Representation
command.request_object = log_sink_object
@ -522,8 +486,8 @@ module Google
command.response_class = Google::Apis::LoggingV2beta1::LogSink
command.params['sinkName'] = sink_name unless sink_name.nil?
command.query['uniqueWriterIdentity'] = unique_writer_identity unless unique_writer_identity.nil?
command.query['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
@ -548,11 +512,11 @@ module Google
# owned by a non-project resource such as an organization, then the value of
# writer_identity will be a unique service account used only for exports from
# the new sink. For more information, see writer_identity in LogSink.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
@ -565,7 +529,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 create_project_sink(parent, log_sink_object = nil, unique_writer_identity: nil, fields: nil, quota_user: nil, options: nil, &block)
def create_project_sink(parent, log_sink_object = nil, unique_writer_identity: nil, quota_user: nil, fields: nil, options: nil, &block)
command = make_simple_command(:post, 'v2beta1/{+parent}/sinks', options)
command.request_representation = Google::Apis::LoggingV2beta1::LogSink::Representation
command.request_object = log_sink_object
@ -573,25 +537,25 @@ module Google
command.response_class = Google::Apis::LoggingV2beta1::LogSink
command.params['parent'] = parent unless parent.nil?
command.query['uniqueWriterIdentity'] = unique_writer_identity unless unique_writer_identity.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['fields'] = fields unless fields.nil?
execute_or_queue_command(command, &block)
end
# Deletes all the log entries in a log. The log reappears if it receives new
# entries.
# @param [String] log_name
# Required. The resource name of the log to delete:
# "projects/[PROJECT_ID]/logs/[LOG_ID]"
# "organizations/[ORGANIZATION_ID]/logs/[LOG_ID]"
# [LOG_ID] must be URL-encoded. For example, "projects/my-project-id/logs/syslog"
# , "organizations/1234567890/logs/cloudresourcemanager.googleapis.com%
# 2Factivity". For more information about log names, see LogEntry.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# Deletes a sink. If the sink has a unique writer_identity, then that service
# account is also deleted.
# @param [String] sink_name
# Required. The full resource name of the sink to delete, including the parent
# resource and the sink identifier:
# "projects/[PROJECT_ID]/sinks/[SINK_ID]"
# "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]"
# It is an error if the sink does not exist. Example: "projects/my-project-id/
# sinks/my-sink-id". It is an error if the sink does not exist.
# @param [String] quota_user
# Available to 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
#
@ -604,13 +568,49 @@ 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 delete_billing_account_log(log_name, fields: nil, quota_user: nil, options: nil, &block)
def delete_project_sink(sink_name, quota_user: nil, fields: nil, options: nil, &block)
command = make_simple_command(:delete, 'v2beta1/{+sinkName}', options)
command.response_representation = Google::Apis::LoggingV2beta1::Empty::Representation
command.response_class = Google::Apis::LoggingV2beta1::Empty
command.params['sinkName'] = sink_name unless sink_name.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['fields'] = fields unless fields.nil?
execute_or_queue_command(command, &block)
end
# Deletes all the log entries in a log. The log reappears if it receives new
# entries.
# @param [String] log_name
# Required. The resource name of the log to delete:
# "projects/[PROJECT_ID]/logs/[LOG_ID]"
# "organizations/[ORGANIZATION_ID]/logs/[LOG_ID]"
# [LOG_ID] must be URL-encoded. For example, "projects/my-project-id/logs/syslog"
# , "organizations/1234567890/logs/cloudresourcemanager.googleapis.com%
# 2Factivity". For more information about log names, see LogEntry.
# @param [String] quota_user
# Available to 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::LoggingV2beta1::Empty] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::LoggingV2beta1::Empty]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def delete_billing_account_log(log_name, quota_user: nil, fields: nil, options: nil, &block)
command = make_simple_command(:delete, 'v2beta1/{+logName}', options)
command.response_representation = Google::Apis::LoggingV2beta1::Empty::Representation
command.response_class = Google::Apis::LoggingV2beta1::Empty
command.params['logName'] = log_name unless log_name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['fields'] = fields unless fields.nil?
execute_or_queue_command(command, &block)
end
@ -620,20 +620,20 @@ module Google
# Required. The resource name that owns the logs:
# "projects/[PROJECT_ID]"
# "organizations/[ORGANIZATION_ID]"
# @param [Fixnum] page_size
# Optional. The maximum number of results to return from this request. Non-
# positive values are ignored. The presence of nextPageToken in the response
# indicates that more results might be available.
# @param [String] page_token
# Optional. If present, then retrieve the next batch of results from the
# preceding call to this method. pageToken must be the value of nextPageToken
# from the previous response. The values of other method parameters should be
# identical to those in the previous call.
# @param [Fixnum] page_size
# Optional. The maximum number of results to return from this request. Non-
# positive values are ignored. The presence of nextPageToken in the response
# indicates that more results might be available.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to 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
#
@ -646,33 +646,33 @@ 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_logs(parent, page_token: nil, page_size: nil, fields: nil, quota_user: nil, options: nil, &block)
def list_billing_account_logs(parent, page_size: nil, page_token: nil, quota_user: nil, fields: nil, options: nil, &block)
command = make_simple_command(:get, 'v2beta1/{+parent}/logs', options)
command.response_representation = Google::Apis::LoggingV2beta1::ListLogsResponse::Representation
command.response_class = Google::Apis::LoggingV2beta1::ListLogsResponse
command.params['parent'] = parent unless parent.nil?
command.query['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['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
# Lists the descriptors for monitored resource types used by Stackdriver Logging.
# @param [Fixnum] page_size
# Optional. The maximum number of results to return from this request. Non-
# positive values are ignored. The presence of nextPageToken in the response
# indicates that more results might be available.
# @param [String] page_token
# Optional. If present, then retrieve the next batch of results from the
# preceding call to this method. pageToken must be the value of nextPageToken
# from the previous response. The values of other method parameters should be
# identical to those in the previous call.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [Fixnum] page_size
# Optional. The maximum number of results to return from this request. Non-
# positive values are ignored. The presence of nextPageToken in the response
# indicates that more results might be available.
# @param [String] quota_user
# Available to 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
#
@ -685,50 +685,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 list_monitored_resource_descriptors(page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
def list_monitored_resource_descriptors(page_token: nil, page_size: nil, quota_user: nil, fields: nil, options: nil, &block)
command = make_simple_command(:get, 'v2beta1/monitoredResourceDescriptors', options)
command.response_representation = Google::Apis::LoggingV2beta1::ListMonitoredResourceDescriptorsResponse::Representation
command.response_class = Google::Apis::LoggingV2beta1::ListMonitoredResourceDescriptorsResponse
command.query['pageSize'] = page_size unless page_size.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['fields'] = fields unless fields.nil?
command.query['pageSize'] = page_size unless page_size.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Deletes all the log entries in a log. The log reappears if it receives new
# entries.
# @param [String] log_name
# Required. The resource name of the log to delete:
# "projects/[PROJECT_ID]/logs/[LOG_ID]"
# "organizations/[ORGANIZATION_ID]/logs/[LOG_ID]"
# [LOG_ID] must be URL-encoded. For example, "projects/my-project-id/logs/syslog"
# , "organizations/1234567890/logs/cloudresourcemanager.googleapis.com%
# 2Factivity". For more information about log names, see LogEntry.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::LoggingV2beta1::Empty] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::LoggingV2beta1::Empty]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def delete_organization_log(log_name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:delete, 'v2beta1/{+logName}', options)
command.response_representation = Google::Apis::LoggingV2beta1::Empty::Representation
command.response_class = Google::Apis::LoggingV2beta1::Empty
command.params['logName'] = log_name unless log_name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
@ -738,20 +702,20 @@ module Google
# Required. The resource name that owns the logs:
# "projects/[PROJECT_ID]"
# "organizations/[ORGANIZATION_ID]"
# @param [Fixnum] page_size
# Optional. The maximum number of results to return from this request. Non-
# positive values are ignored. The presence of nextPageToken in the response
# indicates that more results might be available.
# @param [String] page_token
# Optional. If present, then retrieve the next batch of results from the
# preceding call to this method. pageToken must be the value of nextPageToken
# from the previous response. The values of other method parameters should be
# identical to those in the previous call.
# @param [Fixnum] page_size
# Optional. The maximum number of results to return from this request. Non-
# positive values are ignored. The presence of nextPageToken in the response
# indicates that more results might be available.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to 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
#
@ -764,15 +728,51 @@ 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_organization_logs(parent, page_token: nil, page_size: nil, fields: nil, quota_user: nil, options: nil, &block)
def list_organization_logs(parent, page_size: nil, page_token: nil, quota_user: nil, fields: nil, options: nil, &block)
command = make_simple_command(:get, 'v2beta1/{+parent}/logs', options)
command.response_representation = Google::Apis::LoggingV2beta1::ListLogsResponse::Representation
command.response_class = Google::Apis::LoggingV2beta1::ListLogsResponse
command.params['parent'] = parent unless parent.nil?
command.query['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['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
# Deletes all the log entries in a log. The log reappears if it receives new
# entries.
# @param [String] log_name
# Required. The resource name of the log to delete:
# "projects/[PROJECT_ID]/logs/[LOG_ID]"
# "organizations/[ORGANIZATION_ID]/logs/[LOG_ID]"
# [LOG_ID] must be URL-encoded. For example, "projects/my-project-id/logs/syslog"
# , "organizations/1234567890/logs/cloudresourcemanager.googleapis.com%
# 2Factivity". For more information about log names, see LogEntry.
# @param [String] quota_user
# Available to 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::LoggingV2beta1::Empty] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::LoggingV2beta1::Empty]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def delete_organization_log(log_name, quota_user: nil, fields: nil, options: nil, &block)
command = make_simple_command(:delete, 'v2beta1/{+logName}', options)
command.response_representation = Google::Apis::LoggingV2beta1::Empty::Representation
command.response_class = Google::Apis::LoggingV2beta1::Empty
command.params['logName'] = log_name unless log_name.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['fields'] = fields unless fields.nil?
execute_or_queue_command(command, &block)
end

8
generated/google/apis/monitoring_v3.rb
View File

@ -27,10 +27,7 @@ module Google
# @see https://cloud.google.com/monitoring/api/
module MonitoringV3
VERSION = 'V3'
REVISION = '20170126'
# View and write monitoring data for all of your Google and third-party Cloud and API projects
AUTH_MONITORING = 'https://www.googleapis.com/auth/monitoring'
REVISION = '20170203'
# Publish metric data to your Google Cloud projects
AUTH_MONITORING_WRITE = 'https://www.googleapis.com/auth/monitoring.write'
@ -40,6 +37,9 @@ module Google
# View monitoring data for all of your Google Cloud and third-party projects
AUTH_MONITORING_READ = 'https://www.googleapis.com/auth/monitoring.read'
# View and write monitoring data for all of your Google and third-party Cloud and API projects
AUTH_MONITORING = 'https://www.googleapis.com/auth/monitoring'
end
end
end

2178
generated/google/apis/monitoring_v3/classes.rb
View File

File diff suppressed because it is too large Load Diff

632
generated/google/apis/monitoring_v3/representations.rb
View File

@ -22,49 +22,19 @@ module Google
module Apis
module MonitoringV3
class BucketOptions
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class CollectdValue
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 MetricDescriptor
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class Range
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class ListGroupsResponse
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class CreateCollectdTimeSeriesRequest
class ListGroupMembersResponse
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class ListGroupMembersResponse
class CreateCollectdTimeSeriesRequest
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
@ -130,13 +100,13 @@ module Google
include Google::Apis::Core::JsonObjectSupport
end
class Empty
class Option
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class Option
class Empty
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
@ -166,19 +136,13 @@ module Google
include Google::Apis::Core::JsonObjectSupport
end
class Metric
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class Field
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class ListTimeSeriesResponse
class Metric
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
@ -190,7 +154,7 @@ module Google
include Google::Apis::Core::JsonObjectSupport
end
class Group
class ListTimeSeriesResponse
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
@ -202,6 +166,300 @@ module Google
include Google::Apis::Core::JsonObjectSupport
end
class Group
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class BucketOptions
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class CollectdValue
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class MetricDescriptor
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class SourceContext
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class Range
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class ListGroupsResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :next_page_token, as: 'nextPageToken'
collection :group, as: 'group', class: Google::Apis::MonitoringV3::Group, decorator: Google::Apis::MonitoringV3::Group::Representation
end
end
class ListGroupMembersResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :members, as: 'members', class: Google::Apis::MonitoringV3::MonitoredResource, decorator: Google::Apis::MonitoringV3::MonitoredResource::Representation
property :next_page_token, as: 'nextPageToken'
property :total_size, as: 'totalSize'
end
end
class CreateCollectdTimeSeriesRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :resource, as: 'resource', class: Google::Apis::MonitoringV3::MonitoredResource, decorator: Google::Apis::MonitoringV3::MonitoredResource::Representation
collection :collectd_payloads, as: 'collectdPayloads', class: Google::Apis::MonitoringV3::CollectdPayload, decorator: Google::Apis::MonitoringV3::CollectdPayload::Representation
property :collectd_version, as: 'collectdVersion'
end
end
class ListMonitoredResourceDescriptorsResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :resource_descriptors, as: 'resourceDescriptors', class: Google::Apis::MonitoringV3::MonitoredResourceDescriptor, decorator: Google::Apis::MonitoringV3::MonitoredResourceDescriptor::Representation
property :next_page_token, as: 'nextPageToken'
end
end
class TimeSeries
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :resource, as: 'resource', class: Google::Apis::MonitoringV3::MonitoredResource, decorator: Google::Apis::MonitoringV3::MonitoredResource::Representation
property :metric_kind, as: 'metricKind'
property :metric, as: 'metric', class: Google::Apis::MonitoringV3::Metric, decorator: Google::Apis::MonitoringV3::Metric::Representation
collection :points, as: 'points', class: Google::Apis::MonitoringV3::Point, decorator: Google::Apis::MonitoringV3::Point::Representation
property :value_type, as: 'valueType'
end
end
class CreateTimeSeriesRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :time_series, as: 'timeSeries', class: Google::Apis::MonitoringV3::TimeSeries, decorator: Google::Apis::MonitoringV3::TimeSeries::Representation
end
end
class Distribution
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :range, as: 'range', class: Google::Apis::MonitoringV3::Range, decorator: Google::Apis::MonitoringV3::Range::Representation
property :mean, as: 'mean'
property :count, as: 'count'
collection :bucket_counts, as: 'bucketCounts'
property :bucket_options, as: 'bucketOptions', class: Google::Apis::MonitoringV3::BucketOptions, decorator: Google::Apis::MonitoringV3::BucketOptions::Representation
property :sum_of_squared_deviation, as: 'sumOfSquaredDeviation'
end
end
class MonitoredResource
# @private
class Representation < Google::Apis::Core::JsonRepresentation
hash :labels, as: 'labels'
property :type, as: 'type'
end
end
class ListMetricDescriptorsResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :metric_descriptors, as: 'metricDescriptors', class: Google::Apis::MonitoringV3::MetricDescriptor, decorator: Google::Apis::MonitoringV3::MetricDescriptor::Representation
property :next_page_token, as: 'nextPageToken'
end
end
class MonitoredResourceDescriptor
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :type, as: 'type'
collection :labels, as: 'labels', class: Google::Apis::MonitoringV3::LabelDescriptor, decorator: Google::Apis::MonitoringV3::LabelDescriptor::Representation
property :name, as: 'name'
property :display_name, as: 'displayName'
property :description, as: 'description'
end
end
class TypedValue
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :double_value, as: 'doubleValue'
property :int64_value, as: 'int64Value'
property :distribution_value, as: 'distributionValue', class: Google::Apis::MonitoringV3::Distribution, decorator: Google::Apis::MonitoringV3::Distribution::Representation
property :bool_value, as: 'boolValue'
property :string_value, as: 'stringValue'
end
end
class CollectdPayload
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :values, as: 'values', class: Google::Apis::MonitoringV3::CollectdValue, decorator: Google::Apis::MonitoringV3::CollectdValue::Representation
property :type_instance, as: 'typeInstance'
property :type, as: 'type'
hash :metadata, as: 'metadata', class: Google::Apis::MonitoringV3::TypedValue, decorator: Google::Apis::MonitoringV3::TypedValue::Representation
property :plugin, as: 'plugin'
property :plugin_instance, as: 'pluginInstance'
property :end_time, as: 'endTime'
property :start_time, as: 'startTime'
end
end
class Linear
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :width, as: 'width'
property :offset, as: 'offset'
property :num_finite_buckets, as: 'numFiniteBuckets'
end
end
class Option
# @private
class Representation < Google::Apis::Core::JsonRepresentation
hash :value, as: 'value'
property :name, as: 'name'
end
end
class Empty
# @private
class Representation < Google::Apis::Core::JsonRepresentation
end
end
class TimeInterval
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :end_time, as: 'endTime'
property :start_time, as: 'startTime'
end
end
class Explicit
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :bounds, as: 'bounds'
end
end
class Exponential
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :scale, as: 'scale'
property :num_finite_buckets, as: 'numFiniteBuckets'
property :growth_factor, as: 'growthFactor'
end
end
class Point
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :interval, as: 'interval', class: Google::Apis::MonitoringV3::TimeInterval, decorator: Google::Apis::MonitoringV3::TimeInterval::Representation
property :value, as: 'value', class: Google::Apis::MonitoringV3::TypedValue, decorator: Google::Apis::MonitoringV3::TypedValue::Representation
end
end
class Field
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :type_url, as: 'typeUrl'
property :number, as: 'number'
property :kind, as: 'kind'
property :json_name, as: 'jsonName'
collection :options, as: 'options', class: Google::Apis::MonitoringV3::Option, decorator: Google::Apis::MonitoringV3::Option::Representation
property :oneof_index, as: 'oneofIndex'
property :packed, as: 'packed'
property :cardinality, as: 'cardinality'
property :default_value, as: 'defaultValue'
property :name, as: 'name'
end
end
class Metric
# @private
class Representation < Google::Apis::Core::JsonRepresentation
hash :labels, as: 'labels'
property :type, as: 'type'
end
end
class LabelDescriptor
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :key, as: 'key'
property :description, as: 'description'
property :value_type, as: 'valueType'
end
end
class ListTimeSeriesResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :time_series, as: 'timeSeries', class: Google::Apis::MonitoringV3::TimeSeries, decorator: Google::Apis::MonitoringV3::TimeSeries::Representation
property :next_page_token, as: 'nextPageToken'
end
end
class Type
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :options, as: 'options', class: Google::Apis::MonitoringV3::Option, decorator: Google::Apis::MonitoringV3::Option::Representation
collection :fields, as: 'fields', class: Google::Apis::MonitoringV3::Field, decorator: Google::Apis::MonitoringV3::Field::Representation
property :name, as: 'name'
collection :oneofs, as: 'oneofs'
property :syntax, as: 'syntax'
property :source_context, as: 'sourceContext', class: Google::Apis::MonitoringV3::SourceContext, decorator: Google::Apis::MonitoringV3::SourceContext::Representation
end
end
class Group
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :name, as: 'name'
property :parent_name, as: 'parentName'
property :display_name, as: 'displayName'
property :is_cluster, as: 'isCluster'
property :filter, as: 'filter'
end
end
class BucketOptions
# @private
class Representation < Google::Apis::Core::JsonRepresentation
@ -217,10 +475,25 @@ module Google
class CollectdValue
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :data_source_name, as: 'dataSourceName'
property :value, as: 'value', class: Google::Apis::MonitoringV3::TypedValue, decorator: Google::Apis::MonitoringV3::TypedValue::Representation
property :data_source_type, as: 'dataSourceType'
property :data_source_name, as: 'dataSourceName'
end
end
class MetricDescriptor
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :display_name, as: 'displayName'
property :description, as: 'description'
property :unit, as: 'unit'
collection :labels, as: 'labels', class: Google::Apis::MonitoringV3::LabelDescriptor, decorator: Google::Apis::MonitoringV3::LabelDescriptor::Representation
property :name, as: 'name'
property :type, as: 'type'
property :value_type, as: 'valueType'
property :metric_kind, as: 'metricKind'
end
end
@ -231,21 +504,6 @@ module Google
end
end
class MetricDescriptor
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :unit, as: 'unit'
collection :labels, as: 'labels', class: Google::Apis::MonitoringV3::LabelDescriptor, decorator: Google::Apis::MonitoringV3::LabelDescriptor::Representation
property :name, as: 'name'
property :type, as: 'type'
property :value_type, as: 'valueType'
property :metric_kind, as: 'metricKind'
property :display_name, as: 'displayName'
property :description, as: 'description'
end
end
class Range
# @private
class Representation < Google::Apis::Core::JsonRepresentation
@ -253,264 +511,6 @@ module Google
property :max, as: 'max'
end
end
class ListGroupsResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :group, as: 'group', class: Google::Apis::MonitoringV3::Group, decorator: Google::Apis::MonitoringV3::Group::Representation
property :next_page_token, as: 'nextPageToken'
end
end
class CreateCollectdTimeSeriesRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :resource, as: 'resource', class: Google::Apis::MonitoringV3::MonitoredResource, decorator: Google::Apis::MonitoringV3::MonitoredResource::Representation
collection :collectd_payloads, as: 'collectdPayloads', class: Google::Apis::MonitoringV3::CollectdPayload, decorator: Google::Apis::MonitoringV3::CollectdPayload::Representation
property :collectd_version, as: 'collectdVersion'
end
end
class ListGroupMembersResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :next_page_token, as: 'nextPageToken'
property :total_size, as: 'totalSize'
collection :members, as: 'members', class: Google::Apis::MonitoringV3::MonitoredResource, decorator: Google::Apis::MonitoringV3::MonitoredResource::Representation
end
end
class ListMonitoredResourceDescriptorsResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :next_page_token, as: 'nextPageToken'
collection :resource_descriptors, as: 'resourceDescriptors', class: Google::Apis::MonitoringV3::MonitoredResourceDescriptor, decorator: Google::Apis::MonitoringV3::MonitoredResourceDescriptor::Representation
end
end
class TimeSeries
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :metric_kind, as: 'metricKind'
property :metric, as: 'metric', class: Google::Apis::MonitoringV3::Metric, decorator: Google::Apis::MonitoringV3::Metric::Representation
collection :points, as: 'points', class: Google::Apis::MonitoringV3::Point, decorator: Google::Apis::MonitoringV3::Point::Representation
property :value_type, as: 'valueType'
property :resource, as: 'resource', class: Google::Apis::MonitoringV3::MonitoredResource, decorator: Google::Apis::MonitoringV3::MonitoredResource::Representation
end
end
class CreateTimeSeriesRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :time_series, as: 'timeSeries', class: Google::Apis::MonitoringV3::TimeSeries, decorator: Google::Apis::MonitoringV3::TimeSeries::Representation
end
end
class Distribution
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :bucket_options, as: 'bucketOptions', class: Google::Apis::MonitoringV3::BucketOptions, decorator: Google::Apis::MonitoringV3::BucketOptions::Representation
property :sum_of_squared_deviation, as: 'sumOfSquaredDeviation'
property :range, as: 'range', class: Google::Apis::MonitoringV3::Range, decorator: Google::Apis::MonitoringV3::Range::Representation
property :count, as: 'count'
property :mean, as: 'mean'
collection :bucket_counts, as: 'bucketCounts'
end
end
class MonitoredResource
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :type, as: 'type'
hash :labels, as: 'labels'
end
end
class ListMetricDescriptorsResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :metric_descriptors, as: 'metricDescriptors', class: Google::Apis::MonitoringV3::MetricDescriptor, decorator: Google::Apis::MonitoringV3::MetricDescriptor::Representation
property :next_page_token, as: 'nextPageToken'
end
end
class MonitoredResourceDescriptor
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :labels, as: 'labels', class: Google::Apis::MonitoringV3::LabelDescriptor, decorator: Google::Apis::MonitoringV3::LabelDescriptor::Representation
property :name, as: 'name'
property :display_name, as: 'displayName'
property :description, as: 'description'
property :type, as: 'type'
end
end
class TypedValue
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :int64_value, as: 'int64Value'
property :distribution_value, as: 'distributionValue', class: Google::Apis::MonitoringV3::Distribution, decorator: Google::Apis::MonitoringV3::Distribution::Representation
property :bool_value, as: 'boolValue'
property :string_value, as: 'stringValue'
property :double_value, as: 'doubleValue'
end
end
class CollectdPayload
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :type_instance, as: 'typeInstance'
hash :metadata, as: 'metadata', class: Google::Apis::MonitoringV3::TypedValue, decorator: Google::Apis::MonitoringV3::TypedValue::Representation
property :type, as: 'type'
property :plugin, as: 'plugin'
property :plugin_instance, as: 'pluginInstance'
property :end_time, as: 'endTime'
property :start_time, as: 'startTime'
collection :values, as: 'values', class: Google::Apis::MonitoringV3::CollectdValue, decorator: Google::Apis::MonitoringV3::CollectdValue::Representation
end
end
class Linear
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :width, as: 'width'
property :offset, as: 'offset'
property :num_finite_buckets, as: 'numFiniteBuckets'
end
end
class Empty
# @private
class Representation < Google::Apis::Core::JsonRepresentation
end
end
class Option
# @private
class Representation < Google::Apis::Core::JsonRepresentation
hash :value, as: 'value'
property :name, as: 'name'
end
end
class TimeInterval
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :start_time, as: 'startTime'
property :end_time, as: 'endTime'
end
end
class Explicit
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :bounds, as: 'bounds'
end
end
class Exponential
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :growth_factor, as: 'growthFactor'
property :scale, as: 'scale'
property :num_finite_buckets, as: 'numFiniteBuckets'
end
end
class Point
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :interval, as: 'interval', class: Google::Apis::MonitoringV3::TimeInterval, decorator: Google::Apis::MonitoringV3::TimeInterval::Representation
property :value, as: 'value', class: Google::Apis::MonitoringV3::TypedValue, decorator: Google::Apis::MonitoringV3::TypedValue::Representation
end
end
class Metric
# @private
class Representation < Google::Apis::Core::JsonRepresentation
hash :labels, as: 'labels'
property :type, as: 'type'
end
end
class Field
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :name, as: 'name'
property :type_url, as: 'typeUrl'
property :number, as: 'number'
property :kind, as: 'kind'
property :json_name, as: 'jsonName'
collection :options, as: 'options', class: Google::Apis::MonitoringV3::Option, decorator: Google::Apis::MonitoringV3::Option::Representation
property :oneof_index, as: 'oneofIndex'
property :packed, as: 'packed'
property :cardinality, as: 'cardinality'
property :default_value, as: 'defaultValue'
end
end
class ListTimeSeriesResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :time_series, as: 'timeSeries', class: Google::Apis::MonitoringV3::TimeSeries, decorator: Google::Apis::MonitoringV3::TimeSeries::Representation
property :next_page_token, as: 'nextPageToken'
end
end
class LabelDescriptor
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :key, as: 'key'
property :description, as: 'description'
property :value_type, as: 'valueType'
end
end
class Group
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :filter, as: 'filter'
property :name, as: 'name'
property :parent_name, as: 'parentName'
property :display_name, as: 'displayName'
property :is_cluster, as: 'isCluster'
end
end
class Type
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :fields, as: 'fields', class: Google::Apis::MonitoringV3::Field, decorator: Google::Apis::MonitoringV3::Field::Representation
property :name, as: 'name'
collection :oneofs, as: 'oneofs'
property :source_context, as: 'sourceContext', class: Google::Apis::MonitoringV3::SourceContext, decorator: Google::Apis::MonitoringV3::SourceContext::Representation
property :syntax, as: 'syntax'
collection :options, as: 'options', class: Google::Apis::MonitoringV3::Option, decorator: Google::Apis::MonitoringV3::Option::Representation
end
end
end
end
end

160
generated/google/apis/monitoring_v3/service.rb
View File

@ -84,11 +84,54 @@ module Google
execute_or_queue_command(command, &block)
end
# Creates or adds data to one or more time series. The response is empty if all
# time series in the request were written. If any time series could not be
# written, a corresponding failure message is included in the error response.
# @param [String] name
# The project on which to execute the request. The format is "projects/`
# project_id_or_number`".
# @param [Google::Apis::MonitoringV3::CreateTimeSeriesRequest] create_time_series_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::MonitoringV3::Empty] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::MonitoringV3::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_time_series(name, create_time_series_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v3/{+name}/timeSeries', options)
command.request_representation = Google::Apis::MonitoringV3::CreateTimeSeriesRequest::Representation
command.request_object = create_time_series_request_object
command.response_representation = Google::Apis::MonitoringV3::Empty::Representation
command.response_class = Google::Apis::MonitoringV3::Empty
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Lists time series that match a filter. This method does not require a
# Stackdriver account.
# @param [String] name
# The project on which to execute the request. The format is "projects/`
# project_id_or_number`".
# @param [Fixnum] page_size
# A positive number that is the maximum number of results to return. When view
# field sets to FULL, it limits the number of Points server will return; if view
# field is HEADERS, it limits the number of TimeSeries server will return.
# @param [String] order_by
# Specifies the order in which the points of the time series should be returned.
# By default, results are not ordered. Currently, this field must be left blank.
# @param [String] aggregation_cross_series_reducer
# The approach to be used to combine time series. Not all reducer functions may
# be applied to all time series, depending on the metric type and the value type
@ -141,13 +184,6 @@ module Google
# perSeriesAligner is not specified or equals ALIGN_NONE, then this field is
# ignored. If perSeriesAligner is specified and does not equal ALIGN_NONE, then
# this field must be defined; otherwise an error is returned.
# @param [Fixnum] page_size
# A positive number that is the maximum number of results to return. When view
# field sets to FULL, it limits the number of Points server will return; if view
# field is HEADERS, it limits the number of TimeSeries server will return.
# @param [String] order_by
# Specifies the order in which the points of the time series should be returned.
# By default, results are not ordered. Currently, this field must be left blank.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@ -165,11 +201,13 @@ module Google
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_project_time_series(name, aggregation_cross_series_reducer: nil, filter: nil, page_token: nil, aggregation_per_series_aligner: nil, interval_start_time: nil, view: nil, aggregation_group_by_fields: nil, interval_end_time: nil, aggregation_alignment_period: nil, page_size: nil, order_by: nil, fields: nil, quota_user: nil, options: nil, &block)
def list_project_time_series(name, page_size: nil, order_by: nil, aggregation_cross_series_reducer: nil, filter: nil, page_token: nil, aggregation_per_series_aligner: nil, interval_start_time: nil, view: nil, aggregation_group_by_fields: nil, interval_end_time: nil, aggregation_alignment_period: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v3/{+name}/timeSeries', options)
command.response_representation = Google::Apis::MonitoringV3::ListTimeSeriesResponse::Representation
command.response_class = Google::Apis::MonitoringV3::ListTimeSeriesResponse
command.params['name'] = name unless name.nil?
command.query['pageSize'] = page_size unless page_size.nil?
command.query['orderBy'] = order_by unless order_by.nil?
command.query['aggregation.crossSeriesReducer'] = aggregation_cross_series_reducer unless aggregation_cross_series_reducer.nil?
command.query['filter'] = filter unless filter.nil?
command.query['pageToken'] = page_token unless page_token.nil?
@ -179,44 +217,6 @@ module Google
command.query['aggregation.groupByFields'] = aggregation_group_by_fields unless aggregation_group_by_fields.nil?
command.query['interval.endTime'] = interval_end_time unless interval_end_time.nil?
command.query['aggregation.alignmentPeriod'] = aggregation_alignment_period unless aggregation_alignment_period.nil?
command.query['pageSize'] = page_size unless page_size.nil?
command.query['orderBy'] = order_by unless order_by.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Creates or adds data to one or more time series. The response is empty if all
# time series in the request were written. If any time series could not be
# written, a corresponding failure message is included in the error response.
# @param [String] name
# The project on which to execute the request. The format is "projects/`
# project_id_or_number`".
# @param [Google::Apis::MonitoringV3::CreateTimeSeriesRequest] create_time_series_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::MonitoringV3::Empty] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::MonitoringV3::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_time_series(name, create_time_series_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v3/{+name}/timeSeries', options)
command.request_representation = Google::Apis::MonitoringV3::CreateTimeSeriesRequest::Representation
command.request_object = create_time_series_request_object
command.response_representation = Google::Apis::MonitoringV3::Empty::Representation
command.response_class = Google::Apis::MonitoringV3::Empty
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
@ -259,10 +259,6 @@ module Google
# @param [String] name
# The project on which to execute the request. The format is "projects/`
# project_id_or_number`".
# @param [String] page_token
# If this field is not empty then it must contain the nextPageToken value
# returned by a previous call to this method. Using this field causes the method
# to return additional results from the previous method call.
# @param [Fixnum] page_size
# A positive number that is the maximum number of results to return.
# @param [String] filter
@ -270,6 +266,10 @@ module Google
# returned. Otherwise, the filter specifies which metric descriptors are to be
# returned. For example, the following filter matches all custom metrics:
# metric.type = starts_with("custom.googleapis.com/")
# @param [String] page_token
# If this field is not empty then it must contain the nextPageToken value
# returned by a previous call to this method. Using this field causes the method
# to return additional results from the previous method call.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@ -287,14 +287,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 list_project_metric_descriptors(name, page_token: nil, page_size: nil, filter: nil, fields: nil, quota_user: nil, options: nil, &block)
def list_project_metric_descriptors(name, page_size: nil, filter: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v3/{+name}/metricDescriptors', options)
command.response_representation = Google::Apis::MonitoringV3::ListMetricDescriptorsResponse::Representation
command.response_class = Google::Apis::MonitoringV3::ListMetricDescriptorsResponse
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['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)
@ -373,10 +373,6 @@ module Google
# @param [String] name
# The project on which to execute the request. The format is "projects/`
# project_id_or_number`".
# @param [String] page_token
# If this field is not empty then it must contain the nextPageToken value
# returned by a previous call to this method. Using this field causes the method
# to return additional results from the previous method call.
# @param [Fixnum] page_size
# A positive number that is the maximum number of results to return.
# @param [String] filter
@ -384,6 +380,10 @@ module Google
# reference the descriptor's type and labels. For example, the following filter
# returns only Google Compute Engine descriptors that have an id label:
# resource.type = starts_with("gce_") AND resource.label:id
# @param [String] page_token
# If this field is not empty then it must contain the nextPageToken value
# returned by a previous call to this method. Using this field causes the method
# to return additional results from the previous method call.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@ -401,14 +401,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 list_project_monitored_resource_descriptors(name, page_token: nil, page_size: nil, filter: nil, fields: nil, quota_user: nil, options: nil, &block)
def list_project_monitored_resource_descriptors(name, page_size: nil, filter: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v3/{+name}/monitoredResourceDescriptors', options)
command.response_representation = Google::Apis::MonitoringV3::ListMonitoredResourceDescriptorsResponse::Representation
command.response_class = Google::Apis::MonitoringV3::ListMonitoredResourceDescriptorsResponse
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['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)
@ -482,6 +482,14 @@ module Google
# @param [String] name
# The project whose groups are to be listed. The format is "projects/`
# project_id_or_number`".
# @param [Fixnum] page_size
# A positive number that is the maximum number of results to return.
# @param [String] ancestors_of_group
# A group name: "projects/`project_id_or_number`/groups/`group_id`". Returns
# groups that are ancestors of the specified group. The groups are returned in
# order, starting with the immediate parent and ending with the most distant
# ancestor. If the specified group has no immediate parent, the results are
# empty.
# @param [String] children_of_group
# A group name: "projects/`project_id_or_number`/groups/`group_id`". Returns
# groups whose parentName field contains the group name. If no groups have this
@ -494,14 +502,6 @@ module Google
# If this field is not empty then it must contain the nextPageToken value
# returned by a previous call to this method. Using this field causes the method
# to return additional results from the previous method call.
# @param [Fixnum] page_size
# A positive number that is the maximum number of results to return.
# @param [String] ancestors_of_group
# A group name: "projects/`project_id_or_number`/groups/`group_id`". Returns
# groups that are ancestors of the specified group. The groups are returned in
# order, starting with the immediate parent and ending with the most distant
# ancestor. If the specified group has no immediate parent, the results are
# empty.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@ -519,16 +519,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 list_project_groups(name, children_of_group: nil, descendants_of_group: nil, page_token: nil, page_size: nil, ancestors_of_group: nil, fields: nil, quota_user: nil, options: nil, &block)
def list_project_groups(name, page_size: nil, ancestors_of_group: nil, children_of_group: nil, descendants_of_group: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v3/{+name}/groups', options)
command.response_representation = Google::Apis::MonitoringV3::ListGroupsResponse::Representation
command.response_class = Google::Apis::MonitoringV3::ListGroupsResponse
command.params['name'] = name unless name.nil?
command.query['pageSize'] = page_size unless page_size.nil?
command.query['ancestorsOfGroup'] = ancestors_of_group unless ancestors_of_group.nil?
command.query['childrenOfGroup'] = children_of_group unless children_of_group.nil?
command.query['descendantsOfGroup'] = descendants_of_group unless descendants_of_group.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['pageSize'] = page_size unless page_size.nil?
command.query['ancestorsOfGroup'] = ancestors_of_group unless ancestors_of_group.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
@ -645,14 +645,6 @@ module Google
# @param [String] name
# The group whose members are listed. The format is "projects/`
# project_id_or_number`/groups/`group_id`".
# @param [String] interval_end_time
# Required. The end of the time interval.
# @param [String] filter
# An optional list filter describing the members to be returned. The filter may
# reference the type, labels, and metadata of monitored resources that comprise
# the group. For example, to return only resources representing Compute Engine
# VM instances, use this filter:
# resource.type = "gce_instance"
# @param [String] page_token
# If this field is not empty then it must contain the nextPageToken value
# returned by a previous call to this method. Using this field causes the method
@ -662,6 +654,14 @@ module Google
# time is the end time. The start time must not be later than the end time.
# @param [Fixnum] page_size
# A positive number that is the maximum number of results to return.
# @param [String] interval_end_time
# Required. The end of the time interval.
# @param [String] filter
# An optional list filter describing the members to be returned. The filter may
# reference the type, labels, and metadata of monitored resources that comprise
# the group. For example, to return only resources representing Compute Engine
# VM instances, use this filter:
# resource.type = "gce_instance"
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@ -679,16 +679,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 list_project_group_members(name, interval_end_time: nil, filter: nil, page_token: nil, interval_start_time: nil, page_size: nil, fields: nil, quota_user: nil, options: nil, &block)
def list_project_group_members(name, page_token: nil, interval_start_time: nil, page_size: nil, interval_end_time: nil, filter: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v3/{+name}/members', options)
command.response_representation = Google::Apis::MonitoringV3::ListGroupMembersResponse::Representation
command.response_class = Google::Apis::MonitoringV3::ListGroupMembersResponse
command.params['name'] = name unless name.nil?
command.query['interval.endTime'] = interval_end_time unless interval_end_time.nil?
command.query['filter'] = filter unless filter.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['interval.startTime'] = interval_start_time unless interval_start_time.nil?
command.query['pageSize'] = page_size unless page_size.nil?
command.query['interval.endTime'] = interval_end_time unless interval_end_time.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)

2
generated/google/apis/plus_domains_v1.rb
View File

@ -25,7 +25,7 @@ module Google
# @see https://developers.google.com/+/domains/
module PlusDomainsV1
VERSION = 'V1'
REVISION = '20170124'
REVISION = '20170201'
# View your circles and the people and pages in them
AUTH_PLUS_CIRCLES_READ = 'https://www.googleapis.com/auth/plus.circles.read'

2
generated/google/apis/plus_v1.rb
View File

@ -25,7 +25,7 @@ module Google
# @see https://developers.google.com/+/api/
module PlusV1
VERSION = 'V1'
REVISION = '20170124'
REVISION = '20170201'
# Know the list of people in your circles, your age range, and language
AUTH_PLUS_LOGIN = 'https://www.googleapis.com/auth/plus.login'

6
generated/google/apis/pubsub_v1.rb
View File

@ -27,11 +27,11 @@ module Google
VERSION = 'V1'
REVISION = '20170105'
# View and manage Pub/Sub topics and subscriptions
AUTH_PUBSUB = 'https://www.googleapis.com/auth/pubsub'
# View and manage your data across Google Cloud Platform services
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'
# View and manage Pub/Sub topics and subscriptions
AUTH_PUBSUB = 'https://www.googleapis.com/auth/pubsub'
end
end
end

678
generated/google/apis/pubsub_v1/classes.rb
View File

@ -22,338 +22,6 @@ module Google
module Apis
module PubsubV1
# A topic resource.
class Topic
include Google::Apis::Core::Hashable
# The name of the topic. It must have the format
# `"projects/`project`/topics/`topic`"`. ``topic`` must start with a letter,
# and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`),
# underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent
# signs (`%`). It must be between 3 and 255 characters in length, and it
# must not start with `"goog"`.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@name = args[:name] if args.key?(:name)
end
end
# Defines an Identity and Access Management (IAM) policy. It is used to
# specify access control policies for Cloud Platform resources.
# A `Policy` consists of a list of `bindings`. A `Binding` binds a list of
# `members` to a `role`, where the members can be user accounts, Google groups,
# Google domains, and service accounts. A `role` is a named list of permissions
# defined by IAM.
# **Example**
# `
# "bindings": [
# `
# "role": "roles/owner",
# "members": [
# "user:mike@example.com",
# "group:admins@example.com",
# "domain:google.com",
# "serviceAccount:my-other-app@appspot.gserviceaccount.com",
# ]
# `,
# `
# "role": "roles/viewer",
# "members": ["user:sean@example.com"]
# `
# ]
# `
# For a description of IAM and its features, see the
# [IAM developer's guide](https://cloud.google.com/iam).
class Policy
include Google::Apis::Core::Hashable
# Associates a list of `members` to a `role`.
# Multiple `bindings` must not be specified for the same `role`.
# `bindings` with no members will result in an error.
# Corresponds to the JSON property `bindings`
# @return [Array<Google::Apis::PubsubV1::Binding>]
attr_accessor :bindings
# `etag` is used for optimistic concurrency control as a way to help
# prevent simultaneous updates of a policy from overwriting each other.
# It is strongly suggested that systems make use of the `etag` in the
# read-modify-write cycle to perform policy updates in order to avoid race
# conditions: An `etag` is returned in the response to `getIamPolicy`, and
# systems are expected to put that etag in the request to `setIamPolicy` to
# ensure that their change will be applied to the same version of the policy.
# If no `etag` is provided in the call to `setIamPolicy`, then the existing
# policy is overwritten blindly.
# Corresponds to the JSON property `etag`
# @return [String]
attr_accessor :etag
# Version of the `Policy`. The default version is 0.
# Corresponds to the JSON property `version`
# @return [Fixnum]
attr_accessor :version
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@bindings = args[:bindings] if args.key?(:bindings)
@etag = args[:etag] if args.key?(:etag)
@version = args[:version] if args.key?(:version)
end
end
# Request for the ModifyAckDeadline method.
class ModifyAckDeadlineRequest
include Google::Apis::Core::Hashable
# The new ack deadline with respect to the time this request was sent to
# the Pub/Sub system. For example, if the value is 10, the new
# ack deadline will expire 10 seconds after the `ModifyAckDeadline` call
# was made. Specifying zero may immediately make the message available for
# another pull request.
# The minimum deadline you can specify is 0 seconds.
# The maximum deadline you can specify is 600 seconds (10 minutes).
# Corresponds to the JSON property `ackDeadlineSeconds`
# @return [Fixnum]
attr_accessor :ack_deadline_seconds
# List of acknowledgment IDs.
# Corresponds to the JSON property `ackIds`
# @return [Array<String>]
attr_accessor :ack_ids
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@ack_deadline_seconds = args[:ack_deadline_seconds] if args.key?(:ack_deadline_seconds)
@ack_ids = args[:ack_ids] if args.key?(:ack_ids)
end
end
# Request message for `SetIamPolicy` method.
class SetIamPolicyRequest
include Google::Apis::Core::Hashable
# Defines an Identity and Access Management (IAM) policy. It is used to
# specify access control policies for Cloud Platform resources.
# A `Policy` consists of a list of `bindings`. A `Binding` binds a list of
# `members` to a `role`, where the members can be user accounts, Google groups,
# Google domains, and service accounts. A `role` is a named list of permissions
# defined by IAM.
# **Example**
# `
# "bindings": [
# `
# "role": "roles/owner",
# "members": [
# "user:mike@example.com",
# "group:admins@example.com",
# "domain:google.com",
# "serviceAccount:my-other-app@appspot.gserviceaccount.com",
# ]
# `,
# `
# "role": "roles/viewer",
# "members": ["user:sean@example.com"]
# `
# ]
# `
# For a description of IAM and its features, see the
# [IAM developer's guide](https://cloud.google.com/iam).
# Corresponds to the JSON property `policy`
# @return [Google::Apis::PubsubV1::Policy]
attr_accessor :policy
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@policy = args[:policy] if args.key?(:policy)
end
end
# A message data and its attributes. The message payload must not be empty;
# it must contain either a non-empty data field, or at least one attribute.
class Message
include Google::Apis::Core::Hashable
# The message payload.
# Corresponds to the JSON property `data`
# @return [String]
attr_accessor :data
# Optional attributes for this message.
# Corresponds to the JSON property `attributes`
# @return [Hash<String,String>]
attr_accessor :attributes
# ID of this message, assigned by the server when the message is published.
# Guaranteed to be unique within the topic. This value may be read by a
# subscriber that receives a `PubsubMessage` via a `Pull` call or a push
# delivery. It must not be populated by the publisher in a `Publish` call.
# Corresponds to the JSON property `messageId`
# @return [String]
attr_accessor :message_id
# The time at which the message was published, populated by the server when
# it receives the `Publish` call. It must not be populated by the
# publisher in a `Publish` call.
# Corresponds to the JSON property `publishTime`
# @return [String]
attr_accessor :publish_time
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@data = args[:data] if args.key?(:data)
@attributes = args[:attributes] if args.key?(:attributes)
@message_id = args[:message_id] if args.key?(:message_id)
@publish_time = args[:publish_time] if args.key?(:publish_time)
end
end
# Request for the ModifyPushConfig method.
class ModifyPushConfigRequest
include Google::Apis::Core::Hashable
# Configuration for a push delivery endpoint.
# Corresponds to the JSON property `pushConfig`
# @return [Google::Apis::PubsubV1::PushConfig]
attr_accessor :push_config
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@push_config = args[:push_config] if args.key?(:push_config)
end
end
# Associates `members` with a `role`.
class Binding
include Google::Apis::Core::Hashable
# Specifies the identities requesting access for a Cloud Platform resource.
# `members` can have the following values:
# * `allUsers`: A special identifier that represents anyone who is
# on the internet; with or without a Google account.
# * `allAuthenticatedUsers`: A special identifier that represents anyone
# who is authenticated with a Google account or a service account.
# * `user:`emailid``: An email address that represents a specific Google
# account. For example, `alice@gmail.com` or `joe@example.com`.
# * `serviceAccount:`emailid``: An email address that represents a service
# account. For example, `my-other-app@appspot.gserviceaccount.com`.
# * `group:`emailid``: An email address that represents a Google group.
# For example, `admins@example.com`.
# * `domain:`domain``: A Google Apps domain name that represents all the
# users of that domain. For example, `google.com` or `example.com`.
# Corresponds to the JSON property `members`
# @return [Array<String>]
attr_accessor :members
# Role that is assigned to `members`.
# For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
# Required
# Corresponds to the JSON property `role`
# @return [String]
attr_accessor :role
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@members = args[:members] if args.key?(:members)
@role = args[:role] if args.key?(:role)
end
end
# Request for the Acknowledge method.
class AcknowledgeRequest
include Google::Apis::Core::Hashable
# The acknowledgment ID for the messages being acknowledged that was returned
# by the Pub/Sub system in the `Pull` response. Must not be empty.
# Corresponds to the JSON property `ackIds`
# @return [Array<String>]
attr_accessor :ack_ids
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@ack_ids = args[:ack_ids] if args.key?(:ack_ids)
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
# Response for the `ListTopics` method.
class ListTopicsResponse
include Google::Apis::Core::Hashable
# The resulting topics.
# Corresponds to the JSON property `topics`
# @return [Array<Google::Apis::PubsubV1::Topic>]
attr_accessor :topics
# If not empty, indicates that there may be more topics that match the
# request; this value should be passed in a new `ListTopicsRequest`.
# 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)
@topics = args[:topics] if args.key?(:topics)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
end
end
# Response for the `ListTopicSubscriptions` method.
class ListTopicSubscriptionsResponse
include Google::Apis::Core::Hashable
@ -495,6 +163,12 @@ module Google
class PullRequest
include Google::Apis::Core::Hashable
# The maximum number of messages returned for this request. The Pub/Sub
# system may return fewer than the number specified.
# Corresponds to the JSON property `maxMessages`
# @return [Fixnum]
attr_accessor :max_messages
# If this field set to true, the system will respond immediately even if
# it there are no messages available to return in the `Pull` response.
# Otherwise, the system may wait (for a bounded amount of time) until at
@ -506,20 +180,14 @@ module Google
attr_accessor :return_immediately
alias_method :return_immediately?, :return_immediately
# The maximum number of messages returned for this request. The Pub/Sub
# system may return fewer than the number specified.
# Corresponds to the JSON property `maxMessages`
# @return [Fixnum]
attr_accessor :max_messages
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@return_immediately = args[:return_immediately] if args.key?(:return_immediately)
@max_messages = args[:max_messages] if args.key?(:max_messages)
@return_immediately = args[:return_immediately] if args.key?(:return_immediately)
end
end
@ -671,6 +339,338 @@ module Google
@permissions = args[:permissions] if args.key?(:permissions)
end
end
# A topic resource.
class Topic
include Google::Apis::Core::Hashable
# The name of the topic. It must have the format
# `"projects/`project`/topics/`topic`"`. ``topic`` must start with a letter,
# and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`),
# underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent
# signs (`%`). It must be between 3 and 255 characters in length, and it
# must not start with `"goog"`.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@name = args[:name] if args.key?(:name)
end
end
# Defines an Identity and Access Management (IAM) policy. It is used to
# specify access control policies for Cloud Platform resources.
# A `Policy` consists of a list of `bindings`. A `Binding` binds a list of
# `members` to a `role`, where the members can be user accounts, Google groups,
# Google domains, and service accounts. A `role` is a named list of permissions
# defined by IAM.
# **Example**
# `
# "bindings": [
# `
# "role": "roles/owner",
# "members": [
# "user:mike@example.com",
# "group:admins@example.com",
# "domain:google.com",
# "serviceAccount:my-other-app@appspot.gserviceaccount.com",
# ]
# `,
# `
# "role": "roles/viewer",
# "members": ["user:sean@example.com"]
# `
# ]
# `
# For a description of IAM and its features, see the
# [IAM developer's guide](https://cloud.google.com/iam).
class Policy
include Google::Apis::Core::Hashable
# `etag` is used for optimistic concurrency control as a way to help
# prevent simultaneous updates of a policy from overwriting each other.
# It is strongly suggested that systems make use of the `etag` in the
# read-modify-write cycle to perform policy updates in order to avoid race
# conditions: An `etag` is returned in the response to `getIamPolicy`, and
# systems are expected to put that etag in the request to `setIamPolicy` to
# ensure that their change will be applied to the same version of the policy.
# If no `etag` is provided in the call to `setIamPolicy`, then the existing
# policy is overwritten blindly.
# Corresponds to the JSON property `etag`
# @return [String]
attr_accessor :etag
# Version of the `Policy`. The default version is 0.
# Corresponds to the JSON property `version`
# @return [Fixnum]
attr_accessor :version
# Associates a list of `members` to a `role`.
# Multiple `bindings` must not be specified for the same `role`.
# `bindings` with no members will result in an error.
# Corresponds to the JSON property `bindings`
# @return [Array<Google::Apis::PubsubV1::Binding>]
attr_accessor :bindings
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@etag = args[:etag] if args.key?(:etag)
@version = args[:version] if args.key?(:version)
@bindings = args[:bindings] if args.key?(:bindings)
end
end
# Request for the ModifyAckDeadline method.
class ModifyAckDeadlineRequest
include Google::Apis::Core::Hashable
# The new ack deadline with respect to the time this request was sent to
# the Pub/Sub system. For example, if the value is 10, the new
# ack deadline will expire 10 seconds after the `ModifyAckDeadline` call
# was made. Specifying zero may immediately make the message available for
# another pull request.
# The minimum deadline you can specify is 0 seconds.
# The maximum deadline you can specify is 600 seconds (10 minutes).
# Corresponds to the JSON property `ackDeadlineSeconds`
# @return [Fixnum]
attr_accessor :ack_deadline_seconds
# List of acknowledgment IDs.
# Corresponds to the JSON property `ackIds`
# @return [Array<String>]
attr_accessor :ack_ids
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@ack_deadline_seconds = args[:ack_deadline_seconds] if args.key?(:ack_deadline_seconds)
@ack_ids = args[:ack_ids] if args.key?(:ack_ids)
end
end
# Request message for `SetIamPolicy` method.
class SetIamPolicyRequest
include Google::Apis::Core::Hashable
# Defines an Identity and Access Management (IAM) policy. It is used to
# specify access control policies for Cloud Platform resources.
# A `Policy` consists of a list of `bindings`. A `Binding` binds a list of
# `members` to a `role`, where the members can be user accounts, Google groups,
# Google domains, and service accounts. A `role` is a named list of permissions
# defined by IAM.
# **Example**
# `
# "bindings": [
# `
# "role": "roles/owner",
# "members": [
# "user:mike@example.com",
# "group:admins@example.com",
# "domain:google.com",
# "serviceAccount:my-other-app@appspot.gserviceaccount.com",
# ]
# `,
# `
# "role": "roles/viewer",
# "members": ["user:sean@example.com"]
# `
# ]
# `
# For a description of IAM and its features, see the
# [IAM developer's guide](https://cloud.google.com/iam).
# Corresponds to the JSON property `policy`
# @return [Google::Apis::PubsubV1::Policy]
attr_accessor :policy
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@policy = args[:policy] if args.key?(:policy)
end
end
# A message data and its attributes. The message payload must not be empty;
# it must contain either a non-empty data field, or at least one attribute.
class Message
include Google::Apis::Core::Hashable
# Optional attributes for this message.
# Corresponds to the JSON property `attributes`
# @return [Hash<String,String>]
attr_accessor :attributes
# ID of this message, assigned by the server when the message is published.
# Guaranteed to be unique within the topic. This value may be read by a
# subscriber that receives a `PubsubMessage` via a `Pull` call or a push
# delivery. It must not be populated by the publisher in a `Publish` call.
# Corresponds to the JSON property `messageId`
# @return [String]
attr_accessor :message_id
# The time at which the message was published, populated by the server when
# it receives the `Publish` call. It must not be populated by the
# publisher in a `Publish` call.
# Corresponds to the JSON property `publishTime`
# @return [String]
attr_accessor :publish_time
# The message payload.
# Corresponds to the JSON property `data`
# @return [String]
attr_accessor :data
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@attributes = args[:attributes] if args.key?(:attributes)
@message_id = args[:message_id] if args.key?(:message_id)
@publish_time = args[:publish_time] if args.key?(:publish_time)
@data = args[:data] if args.key?(:data)
end
end
# Request for the ModifyPushConfig method.
class ModifyPushConfigRequest
include Google::Apis::Core::Hashable
# Configuration for a push delivery endpoint.
# Corresponds to the JSON property `pushConfig`
# @return [Google::Apis::PubsubV1::PushConfig]
attr_accessor :push_config
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@push_config = args[:push_config] if args.key?(:push_config)
end
end
# Associates `members` with a `role`.
class Binding
include Google::Apis::Core::Hashable
# Specifies the identities requesting access for a Cloud Platform resource.
# `members` can have the following values:
# * `allUsers`: A special identifier that represents anyone who is
# on the internet; with or without a Google account.
# * `allAuthenticatedUsers`: A special identifier that represents anyone
# who is authenticated with a Google account or a service account.
# * `user:`emailid``: An email address that represents a specific Google
# account. For example, `alice@gmail.com` or `joe@example.com`.
# * `serviceAccount:`emailid``: An email address that represents a service
# account. For example, `my-other-app@appspot.gserviceaccount.com`.
# * `group:`emailid``: An email address that represents a Google group.
# For example, `admins@example.com`.
# * `domain:`domain``: A Google Apps domain name that represents all the
# users of that domain. For example, `google.com` or `example.com`.
# Corresponds to the JSON property `members`
# @return [Array<String>]
attr_accessor :members
# Role that is assigned to `members`.
# For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
# Required
# Corresponds to the JSON property `role`
# @return [String]
attr_accessor :role
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@members = args[:members] if args.key?(:members)
@role = args[:role] if args.key?(:role)
end
end
# Request for the Acknowledge method.
class AcknowledgeRequest
include Google::Apis::Core::Hashable
# The acknowledgment ID for the messages being acknowledged that was returned
# by the Pub/Sub system in the `Pull` response. Must not be empty.
# Corresponds to the JSON property `ackIds`
# @return [Array<String>]
attr_accessor :ack_ids
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@ack_ids = args[:ack_ids] if args.key?(:ack_ids)
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
# Response for the `ListTopics` method.
class ListTopicsResponse
include Google::Apis::Core::Hashable
# If not empty, indicates that there may be more topics that match the
# request; this value should be passed in a new `ListTopicsRequest`.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# The resulting topics.
# Corresponds to the JSON property `topics`
# @return [Array<Google::Apis::PubsubV1::Topic>]
attr_accessor :topics
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)
@topics = args[:topics] if args.key?(:topics)
end
end
end
end
end

216
generated/google/apis/pubsub_v1/representations.rb
View File

@ -22,66 +22,6 @@ module Google
module Apis
module PubsubV1
class Topic
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 ModifyAckDeadlineRequest
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 Message
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class ModifyPushConfigRequest
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class Binding
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class AcknowledgeRequest
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class Empty
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class ListTopicsResponse
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class ListTopicSubscriptionsResponse
class Representation < Google::Apis::Core::JsonRepresentation; end
@ -149,84 +89,63 @@ module Google
end
class Topic
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :name, as: 'name'
end
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class Policy
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :bindings, as: 'bindings', class: Google::Apis::PubsubV1::Binding, decorator: Google::Apis::PubsubV1::Binding::Representation
class Representation < Google::Apis::Core::JsonRepresentation; end
property :etag, :base64 => true, as: 'etag'
property :version, as: 'version'
end
include Google::Apis::Core::JsonObjectSupport
end
class ModifyAckDeadlineRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :ack_deadline_seconds, as: 'ackDeadlineSeconds'
collection :ack_ids, as: 'ackIds'
end
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class SetIamPolicyRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :policy, as: 'policy', class: Google::Apis::PubsubV1::Policy, decorator: Google::Apis::PubsubV1::Policy::Representation
class Representation < Google::Apis::Core::JsonRepresentation; end
end
include Google::Apis::Core::JsonObjectSupport
end
class Message
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :data, :base64 => true, as: 'data'
hash :attributes, as: 'attributes'
property :message_id, as: 'messageId'
property :publish_time, as: 'publishTime'
end
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class ModifyPushConfigRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :push_config, as: 'pushConfig', class: Google::Apis::PubsubV1::PushConfig, decorator: Google::Apis::PubsubV1::PushConfig::Representation
class Representation < Google::Apis::Core::JsonRepresentation; end
end
include Google::Apis::Core::JsonObjectSupport
end
class Binding
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :members, as: 'members'
property :role, as: 'role'
end
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class AcknowledgeRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :ack_ids, as: 'ackIds'
end
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 ListTopicsResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :topics, as: 'topics', class: Google::Apis::PubsubV1::Topic, decorator: Google::Apis::PubsubV1::Topic::Representation
class Representation < Google::Apis::Core::JsonRepresentation; end
property :next_page_token, as: 'nextPageToken'
end
include Google::Apis::Core::JsonObjectSupport
end
class ListTopicSubscriptionsResponse
@ -272,8 +191,8 @@ module Google
class PullRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :return_immediately, as: 'returnImmediately'
property :max_messages, as: 'maxMessages'
property :return_immediately, as: 'returnImmediately'
end
end
@ -318,6 +237,87 @@ module Google
collection :permissions, as: 'permissions'
end
end
class Topic
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :name, as: 'name'
end
end
class Policy
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :etag, :base64 => true, as: 'etag'
property :version, as: 'version'
collection :bindings, as: 'bindings', class: Google::Apis::PubsubV1::Binding, decorator: Google::Apis::PubsubV1::Binding::Representation
end
end
class ModifyAckDeadlineRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :ack_deadline_seconds, as: 'ackDeadlineSeconds'
collection :ack_ids, as: 'ackIds'
end
end
class SetIamPolicyRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :policy, as: 'policy', class: Google::Apis::PubsubV1::Policy, decorator: Google::Apis::PubsubV1::Policy::Representation
end
end
class Message
# @private
class Representation < Google::Apis::Core::JsonRepresentation
hash :attributes, as: 'attributes'
property :message_id, as: 'messageId'
property :publish_time, as: 'publishTime'
property :data, :base64 => true, as: 'data'
end
end
class ModifyPushConfigRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :push_config, as: 'pushConfig', class: Google::Apis::PubsubV1::PushConfig, decorator: Google::Apis::PubsubV1::PushConfig::Representation
end
end
class Binding
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :members, as: 'members'
property :role, as: 'role'
end
end
class AcknowledgeRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :ack_ids, as: 'ackIds'
end
end
class Empty
# @private
class Representation < Google::Apis::Core::JsonRepresentation
end
end
class ListTopicsResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :next_page_token, as: 'nextPageToken'
collection :topics, as: 'topics', class: Google::Apis::PubsubV1::Topic, decorator: Google::Apis::PubsubV1::Topic::Representation
end
end
end
end
end

570
generated/google/apis/pubsub_v1/service.rb
View File

@ -46,6 +46,199 @@ module Google
super('https://pubsub.googleapis.com/', '')
end
# Creates a subscription to a given topic.
# If the subscription already exists, returns `ALREADY_EXISTS`.
# If the corresponding topic doesn't exist, returns `NOT_FOUND`.
# If the name is not provided in the request, the server will assign a random
# name for this subscription on the same project as the topic, conforming
# to the
# [resource name format](https://cloud.google.com/pubsub/docs/overview#names).
# The generated name is populated in the returned Subscription object.
# Note that for REST API requests, you must specify a name in the request.
# @param [String] name
# The name of the subscription. It must have the format
# `"projects/`project`/subscriptions/`subscription`"`. ``subscription`` must
# start with a letter, and contain only letters (`[A-Za-z]`), numbers
# (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`),
# plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters
# in length, and it must not start with `"goog"`.
# @param [Google::Apis::PubsubV1::Subscription] subscription_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::PubsubV1::Subscription] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::PubsubV1::Subscription]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def create_subscription(name, subscription_object = nil, quota_user: nil, fields: nil, options: nil, &block)
command = make_simple_command(:put, 'v1/{+name}', options)
command.request_representation = Google::Apis::PubsubV1::Subscription::Representation
command.request_object = subscription_object
command.response_representation = Google::Apis::PubsubV1::Subscription::Representation
command.response_class = Google::Apis::PubsubV1::Subscription
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
# 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.
# `resource` is usually specified as a path. For example, a Project
# resource is specified as `projects/`project``.
# @param [Google::Apis::PubsubV1::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::PubsubV1::Policy] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::PubsubV1::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_subscription_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::PubsubV1::SetIamPolicyRequest::Representation
command.request_object = set_iam_policy_request_object
command.response_representation = Google::Apis::PubsubV1::Policy::Representation
command.response_class = Google::Apis::PubsubV1::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
# Modifies the ack deadline for a specific message. This method is useful
# to indicate that more time is needed to process a message by the
# subscriber, or to make the message available for redelivery if the
# processing was interrupted. Note that this does not modify the
# subscription-level `ackDeadlineSeconds` used for subsequent messages.
# @param [String] subscription
# The name of the subscription.
# Format is `projects/`project`/subscriptions/`sub``.
# @param [Google::Apis::PubsubV1::ModifyAckDeadlineRequest] modify_ack_deadline_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::PubsubV1::Empty] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::PubsubV1::Empty]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def modify_subscription_ack_deadline(subscription, modify_ack_deadline_request_object = nil, quota_user: nil, fields: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+subscription}:modifyAckDeadline', options)
command.request_representation = Google::Apis::PubsubV1::ModifyAckDeadlineRequest::Representation
command.request_object = modify_ack_deadline_request_object
command.response_representation = Google::Apis::PubsubV1::Empty::Representation
command.response_class = Google::Apis::PubsubV1::Empty
command.params['subscription'] = subscription unless subscription.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['fields'] = fields unless fields.nil?
execute_or_queue_command(command, &block)
end
# Acknowledges the messages associated with the `ack_ids` in the
# `AcknowledgeRequest`. The Pub/Sub system can remove the relevant messages
# from the subscription.
# Acknowledging a message whose ack deadline has expired may succeed,
# but such a message may be redelivered later. Acknowledging a message more
# than once will not result in an error.
# @param [String] subscription
# The subscription whose message is being acknowledged.
# Format is `projects/`project`/subscriptions/`sub``.
# @param [Google::Apis::PubsubV1::AcknowledgeRequest] acknowledge_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::PubsubV1::Empty] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::PubsubV1::Empty]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def acknowledge_subscription(subscription, acknowledge_request_object = nil, quota_user: nil, fields: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+subscription}:acknowledge', options)
command.request_representation = Google::Apis::PubsubV1::AcknowledgeRequest::Representation
command.request_object = acknowledge_request_object
command.response_representation = Google::Apis::PubsubV1::Empty::Representation
command.response_class = Google::Apis::PubsubV1::Empty
command.params['subscription'] = subscription unless subscription.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.
# `resource` is usually specified as a path. For example, a Project
# resource is specified as `projects/`project``.
# @param [String] quota_user
# Available to 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::PubsubV1::Policy] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::PubsubV1::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_subscription_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::PubsubV1::Policy::Representation
command.response_class = Google::Apis::PubsubV1::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 configuration details of a subscription.
# @param [String] subscription
# The name of the subscription to get.
@ -263,52 +456,6 @@ module Google
execute_or_queue_command(command, &block)
end
# Creates a subscription to a given topic.
# If the subscription already exists, returns `ALREADY_EXISTS`.
# If the corresponding topic doesn't exist, returns `NOT_FOUND`.
# If the name is not provided in the request, the server will assign a random
# name for this subscription on the same project as the topic, conforming
# to the
# [resource name format](https://cloud.google.com/pubsub/docs/overview#names).
# The generated name is populated in the returned Subscription object.
# Note that for REST API requests, you must specify a name in the request.
# @param [String] name
# The name of the subscription. It must have the format
# `"projects/`project`/subscriptions/`subscription`"`. ``subscription`` must
# start with a letter, and contain only letters (`[A-Za-z]`), numbers
# (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`),
# plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters
# in length, and it must not start with `"goog"`.
# @param [Google::Apis::PubsubV1::Subscription] subscription_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::PubsubV1::Subscription] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::PubsubV1::Subscription]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def create_subscription(name, subscription_object = nil, quota_user: nil, fields: nil, options: nil, &block)
command = make_simple_command(:put, 'v1/{+name}', options)
command.request_representation = Google::Apis::PubsubV1::Subscription::Representation
command.request_object = subscription_object
command.response_representation = Google::Apis::PubsubV1::Subscription::Representation
command.response_class = Google::Apis::PubsubV1::Subscription
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
# Sets the access control policy on the specified resource. Replaces any
# existing policy.
# @param [String] resource
@ -333,7 +480,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 set_subscription_iam_policy(resource, set_iam_policy_request_object = nil, quota_user: nil, fields: nil, options: nil, &block)
def set_snapshot_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::PubsubV1::SetIamPolicyRequest::Representation
command.request_object = set_iam_policy_request_object
@ -345,117 +492,6 @@ module Google
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.
# `resource` is usually specified as a path. For example, a Project
# resource is specified as `projects/`project``.
# @param [String] quota_user
# Available to 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::PubsubV1::Policy] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::PubsubV1::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_subscription_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::PubsubV1::Policy::Representation
command.response_class = Google::Apis::PubsubV1::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
# Modifies the ack deadline for a specific message. This method is useful
# to indicate that more time is needed to process a message by the
# subscriber, or to make the message available for redelivery if the
# processing was interrupted. Note that this does not modify the
# subscription-level `ackDeadlineSeconds` used for subsequent messages.
# @param [String] subscription
# The name of the subscription.
# Format is `projects/`project`/subscriptions/`sub``.
# @param [Google::Apis::PubsubV1::ModifyAckDeadlineRequest] modify_ack_deadline_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::PubsubV1::Empty] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::PubsubV1::Empty]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def modify_subscription_ack_deadline(subscription, modify_ack_deadline_request_object = nil, quota_user: nil, fields: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+subscription}:modifyAckDeadline', options)
command.request_representation = Google::Apis::PubsubV1::ModifyAckDeadlineRequest::Representation
command.request_object = modify_ack_deadline_request_object
command.response_representation = Google::Apis::PubsubV1::Empty::Representation
command.response_class = Google::Apis::PubsubV1::Empty
command.params['subscription'] = subscription unless subscription.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['fields'] = fields unless fields.nil?
execute_or_queue_command(command, &block)
end
# Acknowledges the messages associated with the `ack_ids` in the
# `AcknowledgeRequest`. The Pub/Sub system can remove the relevant messages
# from the subscription.
# Acknowledging a message whose ack deadline has expired may succeed,
# but such a message may be redelivered later. Acknowledging a message more
# than once will not result in an error.
# @param [String] subscription
# The subscription whose message is being acknowledged.
# Format is `projects/`project`/subscriptions/`sub``.
# @param [Google::Apis::PubsubV1::AcknowledgeRequest] acknowledge_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::PubsubV1::Empty] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::PubsubV1::Empty]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def acknowledge_subscription(subscription, acknowledge_request_object = nil, quota_user: nil, fields: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+subscription}:acknowledge', options)
command.request_representation = Google::Apis::PubsubV1::AcknowledgeRequest::Representation
command.request_object = acknowledge_request_object
command.response_representation = Google::Apis::PubsubV1::Empty::Representation
command.response_class = Google::Apis::PubsubV1::Empty
command.params['subscription'] = subscription unless subscription.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.
@ -527,13 +563,13 @@ module Google
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.
# `resource` is usually specified as a path. For example, a Project
# resource is specified as `projects/`project``.
# @param [Google::Apis::PubsubV1::SetIamPolicyRequest] set_iam_policy_request_object
# Adds one or more messages to the topic. Returns `NOT_FOUND` if the topic
# does not exist. The message payload must not be empty; it must contain
# either a non-empty data field, or at least one attribute.
# @param [String] topic
# The messages in the request will be published on this topic.
# Format is `projects/`project`/topics/`topic``.
# @param [Google::Apis::PubsubV1::PublishRequest] publish_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.
@ -543,26 +579,98 @@ module Google
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::PubsubV1::Policy] parsed result object
# @yieldparam result [Google::Apis::PubsubV1::PublishResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::PubsubV1::Policy]
# @return [Google::Apis::PubsubV1::PublishResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def set_snapshot_iam_policy(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::PubsubV1::SetIamPolicyRequest::Representation
command.request_object = set_iam_policy_request_object
command.response_representation = Google::Apis::PubsubV1::Policy::Representation
command.response_class = Google::Apis::PubsubV1::Policy
def publish_topic(topic, publish_request_object = nil, quota_user: nil, fields: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+topic}:publish', options)
command.request_representation = Google::Apis::PubsubV1::PublishRequest::Representation
command.request_object = publish_request_object
command.response_representation = Google::Apis::PubsubV1::PublishResponse::Representation
command.response_class = Google::Apis::PubsubV1::PublishResponse
command.params['topic'] = topic unless topic.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.
# @param [String] resource
# REQUIRED: The resource for which the policy detail is being requested.
# `resource` is usually specified as a path. For example, a Project
# resource is specified as `projects/`project``.
# @param [Google::Apis::PubsubV1::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::PubsubV1::TestIamPermissionsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::PubsubV1::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_topic_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::PubsubV1::TestIamPermissionsRequest::Representation
command.request_object = test_iam_permissions_request_object
command.response_representation = Google::Apis::PubsubV1::TestIamPermissionsResponse::Representation
command.response_class = Google::Apis::PubsubV1::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
# Deletes the topic with the given name. Returns `NOT_FOUND` if the topic
# does not exist. After a topic is deleted, a new topic may be created with
# the same name; this is an entirely new topic with none of the old
# configuration or subscriptions. Existing subscriptions to this topic are
# not deleted, but their `topic` field is set to `_deleted-topic_`.
# @param [String] topic
# Name of the topic to delete.
# Format is `projects/`project`/topics/`topic``.
# @param [String] quota_user
# Available to 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::PubsubV1::Empty] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::PubsubV1::Empty]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def delete_topic(topic, quota_user: nil, fields: nil, options: nil, &block)
command = make_simple_command(:delete, 'v1/{+topic}', options)
command.response_representation = Google::Apis::PubsubV1::Empty::Representation
command.response_class = Google::Apis::PubsubV1::Empty
command.params['topic'] = topic unless topic.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 matching topics.
# @param [String] project
# The name of the cloud project that topics belong to.
@ -741,124 +849,16 @@ module Google
execute_or_queue_command(command, &block)
end
# Adds one or more messages to the topic. Returns `NOT_FOUND` if the topic
# does not exist. The message payload must not be empty; it must contain
# either a non-empty data field, or at least one attribute.
# @param [String] topic
# The messages in the request will be published on this topic.
# Format is `projects/`project`/topics/`topic``.
# @param [Google::Apis::PubsubV1::PublishRequest] publish_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::PubsubV1::PublishResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::PubsubV1::PublishResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def publish_topic(topic, publish_request_object = nil, quota_user: nil, fields: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+topic}:publish', options)
command.request_representation = Google::Apis::PubsubV1::PublishRequest::Representation
command.request_object = publish_request_object
command.response_representation = Google::Apis::PubsubV1::PublishResponse::Representation
command.response_class = Google::Apis::PubsubV1::PublishResponse
command.params['topic'] = topic unless topic.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.
# @param [String] resource
# REQUIRED: The resource for which the policy detail is being requested.
# `resource` is usually specified as a path. For example, a Project
# resource is specified as `projects/`project``.
# @param [Google::Apis::PubsubV1::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::PubsubV1::TestIamPermissionsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::PubsubV1::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_topic_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::PubsubV1::TestIamPermissionsRequest::Representation
command.request_object = test_iam_permissions_request_object
command.response_representation = Google::Apis::PubsubV1::TestIamPermissionsResponse::Representation
command.response_class = Google::Apis::PubsubV1::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
# Deletes the topic with the given name. Returns `NOT_FOUND` if the topic
# does not exist. After a topic is deleted, a new topic may be created with
# the same name; this is an entirely new topic with none of the old
# configuration or subscriptions. Existing subscriptions to this topic are
# not deleted, but their `topic` field is set to `_deleted-topic_`.
# @param [String] topic
# Name of the topic to delete.
# Format is `projects/`project`/topics/`topic``.
# @param [String] quota_user
# Available to 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::PubsubV1::Empty] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::PubsubV1::Empty]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def delete_topic(topic, quota_user: nil, fields: nil, options: nil, &block)
command = make_simple_command(:delete, 'v1/{+topic}', options)
command.response_representation = Google::Apis::PubsubV1::Empty::Representation
command.response_class = Google::Apis::PubsubV1::Empty
command.params['topic'] = topic unless topic.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 name of the subscriptions for this topic.
# @param [String] topic
# The name of the topic that subscriptions are attached to.
# Format is `projects/`project`/topics/`topic``.
# @param [Fixnum] page_size
# Maximum number of subscription names to return.
# @param [String] page_token
# The value returned by the last `ListTopicSubscriptionsResponse`; indicates
# that this is a continuation of a prior `ListTopicSubscriptions` call, and
# that the system should return the next page of data.
# @param [Fixnum] page_size
# Maximum number of subscription names to return.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
@ -876,13 +876,13 @@ 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_topic_subscriptions(topic, page_size: nil, page_token: nil, quota_user: nil, fields: nil, options: nil, &block)
def list_topic_subscriptions(topic, page_token: nil, page_size: nil, quota_user: nil, fields: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+topic}/subscriptions', options)
command.response_representation = Google::Apis::PubsubV1::ListTopicSubscriptionsResponse::Representation
command.response_class = Google::Apis::PubsubV1::ListTopicSubscriptionsResponse
command.params['topic'] = topic unless topic.nil?
command.query['pageSize'] = page_size unless page_size.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)

2
generated/google/apis/sheets_v4.rb
View File

@ -25,7 +25,7 @@ module Google
# @see https://developers.google.com/sheets/
module SheetsV4
VERSION = 'V4'
REVISION = '20170117'
REVISION = '20170126'
# View and manage the files in your Google Drive
AUTH_DRIVE = 'https://www.googleapis.com/auth/drive'

6284
generated/google/apis/sheets_v4/classes.rb
View File

File diff suppressed because it is too large Load Diff

2006
generated/google/apis/sheets_v4/representations.rb
View File

File diff suppressed because it is too large Load Diff

554
generated/google/apis/sheets_v4/service.rb
View File

@ -46,58 +46,6 @@ module Google
super('https://sheets.googleapis.com/', '')
end
# Returns the spreadsheet at the given ID.
# The caller must specify the spreadsheet ID.
# By default, data within grids will not be returned.
# You can include grid data one of two ways:
# * Specify a field mask listing your desired fields using the `fields` URL
# parameter in HTTP
# * Set the includeGridData
# URL parameter to true. If a field mask is set, the `includeGridData`
# parameter is ignored
# For large spreadsheets, it is recommended to retrieve only the specific
# fields of the spreadsheet that you want.
# To retrieve only subsets of the spreadsheet, use the
# ranges URL parameter.
# Multiple ranges can be specified. Limiting the range will
# return only the portions of the spreadsheet that intersect the requested
# ranges. Ranges are specified using A1 notation.
# @param [String] spreadsheet_id
# The spreadsheet to request.
# @param [Array<String>, String] ranges
# The ranges to retrieve from the spreadsheet.
# @param [Boolean] include_grid_data
# True if grid data should be returned.
# This parameter is ignored if a field mask was set in the request.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::SheetsV4::Spreadsheet] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::SheetsV4::Spreadsheet]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_spreadsheet(spreadsheet_id, ranges: nil, include_grid_data: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v4/spreadsheets/{spreadsheetId}', options)
command.response_representation = Google::Apis::SheetsV4::Spreadsheet::Representation
command.response_class = Google::Apis::SheetsV4::Spreadsheet
command.params['spreadsheetId'] = spreadsheet_id unless spreadsheet_id.nil?
command.query['ranges'] = ranges unless ranges.nil?
command.query['includeGridData'] = include_grid_data unless include_grid_data.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 spreadsheet, returning the newly created spreadsheet.
# @param [Google::Apis::SheetsV4::Spreadsheet] spreadsheet_object
# @param [String] fields
@ -176,161 +124,29 @@ module Google
execute_or_queue_command(command, &block)
end
# Sets values in a range of a spreadsheet.
# The caller must specify the spreadsheet ID, range, and
# a valueInputOption.
# Returns the spreadsheet at the given ID.
# The caller must specify the spreadsheet ID.
# By default, data within grids will not be returned.
# You can include grid data one of two ways:
# * Specify a field mask listing your desired fields using the `fields` URL
# parameter in HTTP
# * Set the includeGridData
# URL parameter to true. If a field mask is set, the `includeGridData`
# parameter is ignored
# For large spreadsheets, it is recommended to retrieve only the specific
# fields of the spreadsheet that you want.
# To retrieve only subsets of the spreadsheet, use the
# ranges URL parameter.
# Multiple ranges can be specified. Limiting the range will
# return only the portions of the spreadsheet that intersect the requested
# ranges. Ranges are specified using A1 notation.
# @param [String] spreadsheet_id
# The ID of the spreadsheet to update.
# @param [String] range
# The A1 notation of the values to update.
# @param [Google::Apis::SheetsV4::ValueRange] value_range_object
# @param [String] value_input_option
# How the input data should be interpreted.
# @param [String] response_date_time_render_option
# Determines how dates, times, and durations in the response should be
# rendered. This is ignored if response_value_render_option is
# FORMATTED_VALUE.
# The default dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER].
# @param [Boolean] include_values_in_response
# Determines if the update response should include the values
# of the cells that were updated. By default, responses
# do not include the updated values.
# If the range to write was larger than than the range actually written,
# the response will include all values in the requested range (excluding
# trailing empty rows and columns).
# @param [String] response_value_render_option
# Determines how values in the response should be rendered.
# The default render option is ValueRenderOption.FORMATTED_VALUE.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::SheetsV4::UpdateValuesResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::SheetsV4::UpdateValuesResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_spreadsheet_value(spreadsheet_id, range, value_range_object = nil, value_input_option: nil, response_date_time_render_option: nil, include_values_in_response: nil, response_value_render_option: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:put, 'v4/spreadsheets/{spreadsheetId}/values/{range}', options)
command.request_representation = Google::Apis::SheetsV4::ValueRange::Representation
command.request_object = value_range_object
command.response_representation = Google::Apis::SheetsV4::UpdateValuesResponse::Representation
command.response_class = Google::Apis::SheetsV4::UpdateValuesResponse
command.params['spreadsheetId'] = spreadsheet_id unless spreadsheet_id.nil?
command.params['range'] = range unless range.nil?
command.query['valueInputOption'] = value_input_option unless value_input_option.nil?
command.query['responseDateTimeRenderOption'] = response_date_time_render_option unless response_date_time_render_option.nil?
command.query['includeValuesInResponse'] = include_values_in_response unless include_values_in_response.nil?
command.query['responseValueRenderOption'] = response_value_render_option unless response_value_render_option.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 values in one or more ranges of a spreadsheet.
# The caller must specify the spreadsheet ID,
# a valueInputOption, and one or more
# ValueRanges.
# @param [String] spreadsheet_id
# The ID of the spreadsheet to update.
# @param [Google::Apis::SheetsV4::BatchUpdateValuesRequest] batch_update_values_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::SheetsV4::BatchUpdateValuesResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::SheetsV4::BatchUpdateValuesResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def batch_update_values(spreadsheet_id, batch_update_values_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v4/spreadsheets/{spreadsheetId}/values:batchUpdate', options)
command.request_representation = Google::Apis::SheetsV4::BatchUpdateValuesRequest::Representation
command.request_object = batch_update_values_request_object
command.response_representation = Google::Apis::SheetsV4::BatchUpdateValuesResponse::Representation
command.response_class = Google::Apis::SheetsV4::BatchUpdateValuesResponse
command.params['spreadsheetId'] = spreadsheet_id unless spreadsheet_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
# Clears values from a spreadsheet.
# The caller must specify the spreadsheet ID and range.
# Only values are cleared -- all other properties of the cell (such as
# formatting, data validation, etc..) are kept.
# @param [String] spreadsheet_id
# The ID of the spreadsheet to update.
# @param [String] range
# The A1 notation of the values to clear.
# @param [Google::Apis::SheetsV4::ClearValuesRequest] clear_values_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::SheetsV4::ClearValuesResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::SheetsV4::ClearValuesResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def clear_values(spreadsheet_id, range, clear_values_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v4/spreadsheets/{spreadsheetId}/values/{range}:clear', options)
command.request_representation = Google::Apis::SheetsV4::ClearValuesRequest::Representation
command.request_object = clear_values_request_object
command.response_representation = Google::Apis::SheetsV4::ClearValuesResponse::Representation
command.response_class = Google::Apis::SheetsV4::ClearValuesResponse
command.params['spreadsheetId'] = spreadsheet_id unless spreadsheet_id.nil?
command.params['range'] = range unless range.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 one or more ranges of values from a spreadsheet.
# The caller must specify the spreadsheet ID and one or more ranges.
# @param [String] spreadsheet_id
# The ID of the spreadsheet to retrieve data from.
# @param [String] value_render_option
# How values should be represented in the output.
# The default render option is ValueRenderOption.FORMATTED_VALUE.
# @param [String] date_time_render_option
# How dates, times, and durations should be represented in the output.
# This is ignored if value_render_option is
# FORMATTED_VALUE.
# The default dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER].
# The spreadsheet to request.
# @param [Array<String>, String] ranges
# The A1 notation of the values to retrieve.
# @param [String] major_dimension
# The major dimension that results should use.
# For example, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`,
# then requesting `range=A1:B2,majorDimension=ROWS` will return
# `[[1,2],[3,4]]`,
# whereas requesting `range=A1:B2,majorDimension=COLUMNS` will return
# `[[1,3],[2,4]]`.
# The ranges to retrieve from the spreadsheet.
# @param [Boolean] include_grid_data
# True if grid data should be returned.
# This parameter is ignored if a field mask was set in the request.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@ -340,63 +156,33 @@ module Google
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::SheetsV4::BatchGetValuesResponse] parsed result object
# @yieldparam result [Google::Apis::SheetsV4::Spreadsheet] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::SheetsV4::BatchGetValuesResponse]
# @return [Google::Apis::SheetsV4::Spreadsheet]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_spreadsheet_values(spreadsheet_id, value_render_option: nil, date_time_render_option: nil, ranges: nil, major_dimension: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v4/spreadsheets/{spreadsheetId}/values:batchGet', options)
command.response_representation = Google::Apis::SheetsV4::BatchGetValuesResponse::Representation
command.response_class = Google::Apis::SheetsV4::BatchGetValuesResponse
def get_spreadsheet(spreadsheet_id, ranges: nil, include_grid_data: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v4/spreadsheets/{spreadsheetId}', options)
command.response_representation = Google::Apis::SheetsV4::Spreadsheet::Representation
command.response_class = Google::Apis::SheetsV4::Spreadsheet
command.params['spreadsheetId'] = spreadsheet_id unless spreadsheet_id.nil?
command.query['valueRenderOption'] = value_render_option unless value_render_option.nil?
command.query['dateTimeRenderOption'] = date_time_render_option unless date_time_render_option.nil?
command.query['ranges'] = ranges unless ranges.nil?
command.query['majorDimension'] = major_dimension unless major_dimension.nil?
command.query['includeGridData'] = include_grid_data unless include_grid_data.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Appends values to a spreadsheet. The input range is used to search for
# existing data and find a "table" within that range. Values will be
# appended to the next row of the table, starting with the first column of
# the table. See the
# [guide](/sheets/guides/values#appending_values)
# and
# [sample code](/sheets/samples/writing#append_values)
# for specific details of how tables are detected and data is appended.
# The caller must specify the spreadsheet ID, range, and
# a valueInputOption. The `valueInputOption` only
# controls how the input data will be added to the sheet (column-wise or
# row-wise), it does not influence what cell the data starts being written
# to.
# Copies a single sheet from a spreadsheet to another spreadsheet.
# Returns the properties of the newly created sheet.
# @param [String] spreadsheet_id
# The ID of the spreadsheet to update.
# @param [String] range
# The A1 notation of a range to search for a logical table of data.
# Values will be appended after the last row of the table.
# @param [Google::Apis::SheetsV4::ValueRange] value_range_object
# @param [String] response_value_render_option
# Determines how values in the response should be rendered.
# The default render option is ValueRenderOption.FORMATTED_VALUE.
# @param [String] insert_data_option
# How the input data should be inserted.
# @param [String] value_input_option
# How the input data should be interpreted.
# @param [String] response_date_time_render_option
# Determines how dates, times, and durations in the response should be
# rendered. This is ignored if response_value_render_option is
# FORMATTED_VALUE.
# The default dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER].
# @param [Boolean] include_values_in_response
# Determines if the update response should include the values
# of the cells that were appended. By default, responses
# do not include the updated values.
# The ID of the spreadsheet containing the sheet to copy.
# @param [Fixnum] sheet_id
# The ID of the sheet to copy.
# @param [Google::Apis::SheetsV4::CopySheetToAnotherSpreadsheetRequest] copy_sheet_to_another_spreadsheet_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@ -406,27 +192,22 @@ module Google
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::SheetsV4::AppendValuesResponse] parsed result object
# @yieldparam result [Google::Apis::SheetsV4::SheetProperties] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::SheetsV4::AppendValuesResponse]
# @return [Google::Apis::SheetsV4::SheetProperties]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def append_spreadsheet_value(spreadsheet_id, range, value_range_object = nil, response_value_render_option: nil, insert_data_option: nil, value_input_option: nil, response_date_time_render_option: nil, include_values_in_response: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v4/spreadsheets/{spreadsheetId}/values/{range}:append', options)
command.request_representation = Google::Apis::SheetsV4::ValueRange::Representation
command.request_object = value_range_object
command.response_representation = Google::Apis::SheetsV4::AppendValuesResponse::Representation
command.response_class = Google::Apis::SheetsV4::AppendValuesResponse
def copy_spreadsheet(spreadsheet_id, sheet_id, copy_sheet_to_another_spreadsheet_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v4/spreadsheets/{spreadsheetId}/sheets/{sheetId}:copyTo', options)
command.request_representation = Google::Apis::SheetsV4::CopySheetToAnotherSpreadsheetRequest::Representation
command.request_object = copy_sheet_to_another_spreadsheet_request_object
command.response_representation = Google::Apis::SheetsV4::SheetProperties::Representation
command.response_class = Google::Apis::SheetsV4::SheetProperties
command.params['spreadsheetId'] = spreadsheet_id unless spreadsheet_id.nil?
command.params['range'] = range unless range.nil?
command.query['responseValueRenderOption'] = response_value_render_option unless response_value_render_option.nil?
command.query['insertDataOption'] = insert_data_option unless insert_data_option.nil?
command.query['valueInputOption'] = value_input_option unless value_input_option.nil?
command.query['responseDateTimeRenderOption'] = response_date_time_render_option unless response_date_time_render_option.nil?
command.query['includeValuesInResponse'] = include_values_in_response unless include_values_in_response.nil?
command.params['sheetId'] = sheet_id unless sheet_id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
@ -520,13 +301,31 @@ module Google
execute_or_queue_command(command, &block)
end
# Copies a single sheet from a spreadsheet to another spreadsheet.
# Returns the properties of the newly created sheet.
# Sets values in a range of a spreadsheet.
# The caller must specify the spreadsheet ID, range, and
# a valueInputOption.
# @param [String] spreadsheet_id
# The ID of the spreadsheet containing the sheet to copy.
# @param [Fixnum] sheet_id
# The ID of the sheet to copy.
# @param [Google::Apis::SheetsV4::CopySheetToAnotherSpreadsheetRequest] copy_sheet_to_another_spreadsheet_request_object
# The ID of the spreadsheet to update.
# @param [String] range
# The A1 notation of the values to update.
# @param [Google::Apis::SheetsV4::ValueRange] value_range_object
# @param [String] response_value_render_option
# Determines how values in the response should be rendered.
# The default render option is ValueRenderOption.FORMATTED_VALUE.
# @param [String] value_input_option
# How the input data should be interpreted.
# @param [String] response_date_time_render_option
# Determines how dates, times, and durations in the response should be
# rendered. This is ignored if response_value_render_option is
# FORMATTED_VALUE.
# The default dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER].
# @param [Boolean] include_values_in_response
# Determines if the update response should include the values
# of the cells that were updated. By default, responses
# do not include the updated values.
# If the range to write was larger than than the range actually written,
# the response will include all values in the requested range (excluding
# trailing empty rows and columns).
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@ -536,22 +335,223 @@ module Google
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::SheetsV4::SheetProperties] parsed result object
# @yieldparam result [Google::Apis::SheetsV4::UpdateValuesResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::SheetsV4::SheetProperties]
# @return [Google::Apis::SheetsV4::UpdateValuesResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def copy_spreadsheet(spreadsheet_id, sheet_id, copy_sheet_to_another_spreadsheet_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v4/spreadsheets/{spreadsheetId}/sheets/{sheetId}:copyTo', options)
command.request_representation = Google::Apis::SheetsV4::CopySheetToAnotherSpreadsheetRequest::Representation
command.request_object = copy_sheet_to_another_spreadsheet_request_object
command.response_representation = Google::Apis::SheetsV4::SheetProperties::Representation
command.response_class = Google::Apis::SheetsV4::SheetProperties
def update_spreadsheet_value(spreadsheet_id, range, value_range_object = nil, response_value_render_option: nil, value_input_option: nil, response_date_time_render_option: nil, include_values_in_response: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:put, 'v4/spreadsheets/{spreadsheetId}/values/{range}', options)
command.request_representation = Google::Apis::SheetsV4::ValueRange::Representation
command.request_object = value_range_object
command.response_representation = Google::Apis::SheetsV4::UpdateValuesResponse::Representation
command.response_class = Google::Apis::SheetsV4::UpdateValuesResponse
command.params['spreadsheetId'] = spreadsheet_id unless spreadsheet_id.nil?
command.params['sheetId'] = sheet_id unless sheet_id.nil?
command.params['range'] = range unless range.nil?
command.query['responseValueRenderOption'] = response_value_render_option unless response_value_render_option.nil?
command.query['valueInputOption'] = value_input_option unless value_input_option.nil?
command.query['responseDateTimeRenderOption'] = response_date_time_render_option unless response_date_time_render_option.nil?
command.query['includeValuesInResponse'] = include_values_in_response unless include_values_in_response.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 values in one or more ranges of a spreadsheet.
# The caller must specify the spreadsheet ID,
# a valueInputOption, and one or more
# ValueRanges.
# @param [String] spreadsheet_id
# The ID of the spreadsheet to update.
# @param [Google::Apis::SheetsV4::BatchUpdateValuesRequest] batch_update_values_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::SheetsV4::BatchUpdateValuesResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::SheetsV4::BatchUpdateValuesResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def batch_update_values(spreadsheet_id, batch_update_values_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v4/spreadsheets/{spreadsheetId}/values:batchUpdate', options)
command.request_representation = Google::Apis::SheetsV4::BatchUpdateValuesRequest::Representation
command.request_object = batch_update_values_request_object
command.response_representation = Google::Apis::SheetsV4::BatchUpdateValuesResponse::Representation
command.response_class = Google::Apis::SheetsV4::BatchUpdateValuesResponse
command.params['spreadsheetId'] = spreadsheet_id unless spreadsheet_id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Returns one or more ranges of values from a spreadsheet.
# The caller must specify the spreadsheet ID and one or more ranges.
# @param [String] spreadsheet_id
# The ID of the spreadsheet to retrieve data from.
# @param [String] value_render_option
# How values should be represented in the output.
# The default render option is ValueRenderOption.FORMATTED_VALUE.
# @param [String] date_time_render_option
# How dates, times, and durations should be represented in the output.
# This is ignored if value_render_option is
# FORMATTED_VALUE.
# The default dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER].
# @param [Array<String>, String] ranges
# The A1 notation of the values to retrieve.
# @param [String] major_dimension
# The major dimension that results should use.
# For example, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`,
# then requesting `range=A1:B2,majorDimension=ROWS` will return
# `[[1,2],[3,4]]`,
# whereas requesting `range=A1:B2,majorDimension=COLUMNS` will return
# `[[1,3],[2,4]]`.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::SheetsV4::BatchGetValuesResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::SheetsV4::BatchGetValuesResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_spreadsheet_values(spreadsheet_id, value_render_option: nil, date_time_render_option: nil, ranges: nil, major_dimension: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v4/spreadsheets/{spreadsheetId}/values:batchGet', options)
command.response_representation = Google::Apis::SheetsV4::BatchGetValuesResponse::Representation
command.response_class = Google::Apis::SheetsV4::BatchGetValuesResponse
command.params['spreadsheetId'] = spreadsheet_id unless spreadsheet_id.nil?
command.query['valueRenderOption'] = value_render_option unless value_render_option.nil?
command.query['dateTimeRenderOption'] = date_time_render_option unless date_time_render_option.nil?
command.query['ranges'] = ranges unless ranges.nil?
command.query['majorDimension'] = major_dimension unless major_dimension.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Clears values from a spreadsheet.
# The caller must specify the spreadsheet ID and range.
# Only values are cleared -- all other properties of the cell (such as
# formatting, data validation, etc..) are kept.
# @param [String] spreadsheet_id
# The ID of the spreadsheet to update.
# @param [String] range
# The A1 notation of the values to clear.
# @param [Google::Apis::SheetsV4::ClearValuesRequest] clear_values_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::SheetsV4::ClearValuesResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::SheetsV4::ClearValuesResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def clear_values(spreadsheet_id, range, clear_values_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v4/spreadsheets/{spreadsheetId}/values/{range}:clear', options)
command.request_representation = Google::Apis::SheetsV4::ClearValuesRequest::Representation
command.request_object = clear_values_request_object
command.response_representation = Google::Apis::SheetsV4::ClearValuesResponse::Representation
command.response_class = Google::Apis::SheetsV4::ClearValuesResponse
command.params['spreadsheetId'] = spreadsheet_id unless spreadsheet_id.nil?
command.params['range'] = range unless range.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Appends values to a spreadsheet. The input range is used to search for
# existing data and find a "table" within that range. Values will be
# appended to the next row of the table, starting with the first column of
# the table. See the
# [guide](/sheets/guides/values#appending_values)
# and
# [sample code](/sheets/samples/writing#append_values)
# for specific details of how tables are detected and data is appended.
# The caller must specify the spreadsheet ID, range, and
# a valueInputOption. The `valueInputOption` only
# controls how the input data will be added to the sheet (column-wise or
# row-wise), it does not influence what cell the data starts being written
# to.
# @param [String] spreadsheet_id
# The ID of the spreadsheet to update.
# @param [String] range
# The A1 notation of a range to search for a logical table of data.
# Values will be appended after the last row of the table.
# @param [Google::Apis::SheetsV4::ValueRange] value_range_object
# @param [String] value_input_option
# How the input data should be interpreted.
# @param [String] response_date_time_render_option
# Determines how dates, times, and durations in the response should be
# rendered. This is ignored if response_value_render_option is
# FORMATTED_VALUE.
# The default dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER].
# @param [Boolean] include_values_in_response
# Determines if the update response should include the values
# of the cells that were appended. By default, responses
# do not include the updated values.
# @param [String] response_value_render_option
# Determines how values in the response should be rendered.
# The default render option is ValueRenderOption.FORMATTED_VALUE.
# @param [String] insert_data_option
# How the input data should be inserted.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::SheetsV4::AppendValuesResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::SheetsV4::AppendValuesResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def append_spreadsheet_value(spreadsheet_id, range, value_range_object = nil, value_input_option: nil, response_date_time_render_option: nil, include_values_in_response: nil, response_value_render_option: nil, insert_data_option: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v4/spreadsheets/{spreadsheetId}/values/{range}:append', options)
command.request_representation = Google::Apis::SheetsV4::ValueRange::Representation
command.request_object = value_range_object
command.response_representation = Google::Apis::SheetsV4::AppendValuesResponse::Representation
command.response_class = Google::Apis::SheetsV4::AppendValuesResponse
command.params['spreadsheetId'] = spreadsheet_id unless spreadsheet_id.nil?
command.params['range'] = range unless range.nil?
command.query['valueInputOption'] = value_input_option unless value_input_option.nil?
command.query['responseDateTimeRenderOption'] = response_date_time_render_option unless response_date_time_render_option.nil?
command.query['includeValuesInResponse'] = include_values_in_response unless include_values_in_response.nil?
command.query['responseValueRenderOption'] = response_value_render_option unless response_value_render_option.nil?
command.query['insertDataOption'] = insert_data_option unless insert_data_option.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)

14
generated/google/apis/slides_v1.rb
View File

@ -25,13 +25,7 @@ module Google
# @see https://developers.google.com/slides/
module SlidesV1
VERSION = 'V1'
REVISION = '20170118'
# View and manage the files in your Google Drive
AUTH_DRIVE = 'https://www.googleapis.com/auth/drive'
# View your Google Spreadsheets
AUTH_SPREADSHEETS_READONLY = 'https://www.googleapis.com/auth/spreadsheets.readonly'
REVISION = '20170201'
# View and manage your Google Slides presentations
AUTH_PRESENTATIONS = 'https://www.googleapis.com/auth/presentations'
@ -39,6 +33,12 @@ module Google
# View your Google Slides presentations
AUTH_PRESENTATIONS_READONLY = 'https://www.googleapis.com/auth/presentations.readonly'
# View your Google Spreadsheets
AUTH_SPREADSHEETS_READONLY = 'https://www.googleapis.com/auth/spreadsheets.readonly'
# View and manage the files in your Google Drive
AUTH_DRIVE = 'https://www.googleapis.com/auth/drive'
# View the files in your Google Drive
AUTH_DRIVE_READONLY = 'https://www.googleapis.com/auth/drive.readonly'

6813
generated/google/apis/slides_v1/classes.rb
View File

File diff suppressed because it is too large Load Diff

2913
generated/google/apis/slides_v1/representations.rb
View File

File diff suppressed because it is too large Load Diff

32
generated/google/apis/slides_v1/service.rb
View File

@ -49,11 +49,11 @@ module Google
# Gets the latest version of the specified presentation.
# @param [String] presentation_id
# The ID of the presentation to retrieve.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
@ -66,13 +66,13 @@ 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_presentation(presentation_id, quota_user: nil, fields: nil, options: nil, &block)
def get_presentation(presentation_id, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/presentations/{+presentationId}', options)
command.response_representation = Google::Apis::SlidesV1::Presentation::Representation
command.response_class = Google::Apis::SlidesV1::Presentation
command.params['presentationId'] = presentation_id unless presentation_id.nil?
command.query['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
@ -80,11 +80,11 @@ module Google
# fields in the request are ignored.
# Returns the created presentation.
# @param [Google::Apis::SlidesV1::Presentation] presentation_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
@ -97,14 +97,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 create_presentation(presentation_object = nil, quota_user: nil, fields: nil, options: nil, &block)
def create_presentation(presentation_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/presentations', options)
command.request_representation = Google::Apis::SlidesV1::Presentation::Representation
command.request_object = presentation_object
command.response_representation = Google::Apis::SlidesV1::Presentation::Representation
command.response_class = Google::Apis::SlidesV1::Presentation
command.query['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
@ -128,11 +128,11 @@ module Google
# @param [String] presentation_id
# The presentation to apply the updates to.
# @param [Google::Apis::SlidesV1::BatchUpdatePresentationRequest] batch_update_presentation_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
@ -145,15 +145,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 batch_update_presentation(presentation_id, batch_update_presentation_request_object = nil, quota_user: nil, fields: nil, options: nil, &block)
def batch_update_presentation(presentation_id, batch_update_presentation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/presentations/{presentationId}:batchUpdate', options)
command.request_representation = Google::Apis::SlidesV1::BatchUpdatePresentationRequest::Representation
command.request_object = batch_update_presentation_request_object
command.response_representation = Google::Apis::SlidesV1::BatchUpdatePresentationResponse::Representation
command.response_class = Google::Apis::SlidesV1::BatchUpdatePresentationResponse
command.params['presentationId'] = presentation_id unless presentation_id.nil?
command.query['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
@ -162,11 +162,11 @@ module Google
# The ID of the presentation to retrieve.
# @param [String] page_object_id
# The object ID of the page to retrieve.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
@ -179,14 +179,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_presentation_page(presentation_id, page_object_id, quota_user: nil, fields: nil, options: nil, &block)
def get_presentation_page(presentation_id, page_object_id, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/presentations/{presentationId}/pages/{pageObjectId}', options)
command.response_representation = Google::Apis::SlidesV1::Page::Representation
command.response_class = Google::Apis::SlidesV1::Page
command.params['presentationId'] = presentation_id unless presentation_id.nil?
command.params['pageObjectId'] = page_object_id unless page_object_id.nil?
command.query['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

2
generated/google/apis/speech_v1beta1.rb
View File

@ -25,7 +25,7 @@ module Google
# @see https://cloud.google.com/speech/
module SpeechV1beta1
VERSION = 'V1beta1'
REVISION = '20170125'
REVISION = '20170201'
# View and manage your data across Google Cloud Platform services
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'

116
generated/google/apis/speech_v1beta1/classes.rb
View File

@ -132,12 +132,12 @@ module Google
end
end
# The `RecognitionConfig` message provides information to the recognizer
# that specifies how to process the request.
# Provides information to the recognizer that specifies how to process the
# request.
class RecognitionConfig
include Google::Apis::Core::Hashable
# [Optional] Maximum number of recognition hypotheses to be returned.
# *Optional* Maximum number of recognition hypotheses to be returned.
# Specifically, the maximum number of `SpeechRecognitionAlternative` messages
# within each `SpeechRecognitionResult`.
# The server may return fewer than `max_alternatives`.
@ -147,7 +147,7 @@ module Google
# @return [Fixnum]
attr_accessor :max_alternatives
# [Required] Sample rate in Hertz of the audio data sent in all
# *Required* Sample rate in Hertz of the audio data sent in all
# `RecognitionAudio` messages. Valid values are: 8000-48000.
# 16000 is optimal. For best results, set the sampling rate of the audio
# source to 16000 Hz. If that's not possible, use the native sample rate of
@ -156,7 +156,7 @@ module Google
# @return [Fixnum]
attr_accessor :sample_rate
# [Optional] The language of the supplied audio as a BCP-47 language tag.
# *Optional* The language of the supplied audio as a BCP-47 language tag.
# Example: "en-GB" https://www.rfc-editor.org/rfc/bcp/bcp47.txt
# If omitted, defaults to "en-US". See
# [Language Support](https://cloud.google.com/speech/docs/languages)
@ -165,18 +165,12 @@ module Google
# @return [String]
attr_accessor :language_code
# Provides "hints" to the speech recognizer to favor specific words and phrases
# in the results.
# Corresponds to the JSON property `speechContext`
# @return [Google::Apis::SpeechV1beta1::SpeechContext]
attr_accessor :speech_context
# [Required] Encoding of audio data sent in all `RecognitionAudio` messages.
# *Required* Encoding of audio data sent in all `RecognitionAudio` messages.
# Corresponds to the JSON property `encoding`
# @return [String]
attr_accessor :encoding
# [Optional] If set to `true`, the server will attempt to filter out
# *Optional* If set to `true`, the server will attempt to filter out
# profanities, replacing all but the initial character in each filtered word
# with asterisks, e.g. "f***". If set to `false` or omitted, profanities
# won't be filtered out.
@ -185,6 +179,12 @@ module Google
attr_accessor :profanity_filter
alias_method :profanity_filter?, :profanity_filter
# Provides "hints" to the speech recognizer to favor specific words and phrases
# in the results.
# Corresponds to the JSON property `speechContext`
# @return [Google::Apis::SpeechV1beta1::SpeechContext]
attr_accessor :speech_context
def initialize(**args)
update!(**args)
end
@ -194,19 +194,18 @@ module Google
@max_alternatives = args[:max_alternatives] if args.key?(:max_alternatives)
@sample_rate = args[:sample_rate] if args.key?(:sample_rate)
@language_code = args[:language_code] if args.key?(:language_code)
@speech_context = args[:speech_context] if args.key?(:speech_context)
@encoding = args[:encoding] if args.key?(:encoding)
@profanity_filter = args[:profanity_filter] if args.key?(:profanity_filter)
@speech_context = args[:speech_context] if args.key?(:speech_context)
end
end
# `SyncRecognizeRequest` is the top-level message sent by the client for
# the `SyncRecognize` method.
# The top-level message sent by the client for the `SyncRecognize` method.
class SyncRecognizeRequest
include Google::Apis::Core::Hashable
# The `RecognitionConfig` message provides information to the recognizer
# that specifies how to process the request.
# Provides information to the recognizer that specifies how to process the
# request.
# Corresponds to the JSON property `config`
# @return [Google::Apis::SpeechV1beta1::RecognitionConfig]
attr_accessor :config
@ -302,13 +301,13 @@ module Google
end
end
# `SyncRecognizeResponse` is the only message returned to the client by
# `SyncRecognize`. It contains the result as zero or more sequential
# `SpeechRecognitionResult` messages.
# The only message returned to the client by `SyncRecognize`. method. It
# contains the result as zero or more sequential `SpeechRecognitionResult`
# messages.
class SyncRecognizeResponse
include Google::Apis::Core::Hashable
# [Output-only] Sequential list of transcription results corresponding to
# *Output-only* Sequential list of transcription results corresponding to
# sequential portions of audio.
# Corresponds to the JSON property `results`
# @return [Array<Google::Apis::SpeechV1beta1::SpeechRecognitionResult>]
@ -343,20 +342,25 @@ module Google
end
end
# Provides "hints" to the speech recognizer to favor specific words and phrases
# in the results.
class SpeechContext
# Alternative hypotheses (a.k.a. n-best list).
class SpeechRecognitionAlternative
include Google::Apis::Core::Hashable
# [Optional] A list of strings containing words and phrases "hints" so that
# the speech recognition is more likely to recognize them. This can be used
# to improve the accuracy for specific words and phrases, for example, if
# specific commands are typically spoken by the user. This can also be used
# to add additional words to the vocabulary of the recognizer. See
# [usage limits](https://cloud.google.com/speech/limits#content).
# Corresponds to the JSON property `phrases`
# @return [Array<String>]
attr_accessor :phrases
# *Output-only* The confidence estimate between 0.0 and 1.0. A higher number
# indicates an estimated greater likelihood that the recognized words are
# correct. This field is typically provided only for the top hypothesis, and
# only for `is_final=true` results. Clients should not rely on the
# `confidence` field as it is not guaranteed to be accurate, or even set, in
# any of the results.
# The default of 0.0 is a sentinel value indicating `confidence` was not set.
# Corresponds to the JSON property `confidence`
# @return [Float]
attr_accessor :confidence
# *Output-only* Transcript text representing the words that the user spoke.
# Corresponds to the JSON property `transcript`
# @return [String]
attr_accessor :transcript
def initialize(**args)
update!(**args)
@ -364,7 +368,8 @@ module Google
# Update properties of this object
def update!(**args)
@phrases = args[:phrases] if args.key?(:phrases)
@confidence = args[:confidence] if args.key?(:confidence)
@transcript = args[:transcript] if args.key?(:transcript)
end
end
@ -393,25 +398,20 @@ module Google
end
end
# Alternative hypotheses (a.k.a. n-best list).
class SpeechRecognitionAlternative
# Provides "hints" to the speech recognizer to favor specific words and phrases
# in the results.
class SpeechContext
include Google::Apis::Core::Hashable
# [Output-only] The confidence estimate between 0.0 and 1.0. A higher number
# indicates an estimated greater likelihood that the recognized words are
# correct. This field is typically provided only for the top hypothesis, and
# only for `is_final=true` results. Clients should not rely on the
# `confidence` field as it is not guaranteed to be accurate, or even set, in
# any of the results.
# The default of 0.0 is a sentinel value indicating `confidence` was not set.
# Corresponds to the JSON property `confidence`
# @return [Float]
attr_accessor :confidence
# [Output-only] Transcript text representing the words that the user spoke.
# Corresponds to the JSON property `transcript`
# @return [String]
attr_accessor :transcript
# *Optional* A list of strings containing words and phrases "hints" so that
# the speech recognition is more likely to recognize them. This can be used
# to improve the accuracy for specific words and phrases, for example, if
# specific commands are typically spoken by the user. This can also be used
# to add additional words to the vocabulary of the recognizer. See
# [usage limits](https://cloud.google.com/speech/limits#content).
# Corresponds to the JSON property `phrases`
# @return [Array<String>]
attr_accessor :phrases
def initialize(**args)
update!(**args)
@ -419,8 +419,7 @@ module Google
# Update properties of this object
def update!(**args)
@confidence = args[:confidence] if args.key?(:confidence)
@transcript = args[:transcript] if args.key?(:transcript)
@phrases = args[:phrases] if args.key?(:phrases)
end
end
@ -428,7 +427,7 @@ module Google
class SpeechRecognitionResult
include Google::Apis::Core::Hashable
# [Output-only] May contain one or more recognition hypotheses (up to the
# *Output-only* May contain one or more recognition hypotheses (up to the
# maximum specified in `max_alternatives`).
# Corresponds to the JSON property `alternatives`
# @return [Array<Google::Apis::SpeechV1beta1::SpeechRecognitionAlternative>]
@ -479,13 +478,12 @@ module Google
end
end
# `AsyncRecognizeRequest` is the top-level message sent by the client for
# the `AsyncRecognize` method.
# The top-level message sent by the client for the `AsyncRecognize` method.
class AsyncRecognizeRequest
include Google::Apis::Core::Hashable
# The `RecognitionConfig` message provides information to the recognizer
# that specifies how to process the request.
# Provides information to the recognizer that specifies how to process the
# request.
# Corresponds to the JSON property `config`
# @return [Google::Apis::SpeechV1beta1::RecognitionConfig]
attr_accessor :config

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