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

Autogenerated update (2020-08-11) 

Update:
- admin_directory_v1
- admin_reports_v1
- androidmanagement_v1
- clouderrorreporting_v1beta1
- docs_v1
- indexing_v3
- manufacturers_v1
- playablelocations_v3
- securitycenter_v1
- securitycenter_v1beta1
- securitycenter_v1p1alpha1
- securitycenter_v1p1beta1
- slides_v1
- streetviewpublish_v1
- tasks_v1
- translate_v3
- translate_v3beta1
- vectortile_v1
- youtube_partner_v1
This commit is contained in:
Google APIs 2020-08-11 00:38:09 +00:00
parent c6029e32ba
commit f087c37dbe
56 changed files with 4251 additions and 5936 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
api_names_out.yaml
View File

@ -7687,6 +7687,7 @@
"/androidmanagement:v1/ApplicationPolicy": application_policy "/androidmanagement:v1/ApplicationPolicy": application_policy
"/androidmanagement:v1/ApplicationPolicy/accessibleTrackIds": accessible_track_ids "/androidmanagement:v1/ApplicationPolicy/accessibleTrackIds": accessible_track_ids
"/androidmanagement:v1/ApplicationPolicy/accessibleTrackIds/accessible_track_id": accessible_track_id "/androidmanagement:v1/ApplicationPolicy/accessibleTrackIds/accessible_track_id": accessible_track_id
"/androidmanagement:v1/ApplicationPolicy/connectedWorkAndPersonalApp": connected_work_and_personal_app
"/androidmanagement:v1/ApplicationPolicy/defaultPermissionPolicy": default_permission_policy "/androidmanagement:v1/ApplicationPolicy/defaultPermissionPolicy": default_permission_policy
"/androidmanagement:v1/ApplicationPolicy/delegatedScopes": delegated_scopes "/androidmanagement:v1/ApplicationPolicy/delegatedScopes": delegated_scopes
"/androidmanagement:v1/ApplicationPolicy/delegatedScopes/delegated_scope": delegated_scope "/androidmanagement:v1/ApplicationPolicy/delegatedScopes/delegated_scope": delegated_scope
@ -121150,6 +121151,7 @@
"/securitycenter:v1/GoogleCloudSecuritycenterV1p1beta1Finding/parent": parent "/securitycenter:v1/GoogleCloudSecuritycenterV1p1beta1Finding/parent": parent
"/securitycenter:v1/GoogleCloudSecuritycenterV1p1beta1Finding/resourceName": resource_name "/securitycenter:v1/GoogleCloudSecuritycenterV1p1beta1Finding/resourceName": resource_name
"/securitycenter:v1/GoogleCloudSecuritycenterV1p1beta1Finding/securityMarks": security_marks "/securitycenter:v1/GoogleCloudSecuritycenterV1p1beta1Finding/securityMarks": security_marks
"/securitycenter:v1/GoogleCloudSecuritycenterV1p1beta1Finding/severity": severity
"/securitycenter:v1/GoogleCloudSecuritycenterV1p1beta1Finding/sourceProperties": source_properties "/securitycenter:v1/GoogleCloudSecuritycenterV1p1beta1Finding/sourceProperties": source_properties
"/securitycenter:v1/GoogleCloudSecuritycenterV1p1beta1Finding/sourceProperties/source_property": source_property "/securitycenter:v1/GoogleCloudSecuritycenterV1p1beta1Finding/sourceProperties/source_property": source_property
"/securitycenter:v1/GoogleCloudSecuritycenterV1p1beta1Finding/state": state "/securitycenter:v1/GoogleCloudSecuritycenterV1p1beta1Finding/state": state
@ -121507,6 +121509,7 @@
"/securitycenter:v1beta1/GoogleCloudSecuritycenterV1p1beta1Finding/parent": parent "/securitycenter:v1beta1/GoogleCloudSecuritycenterV1p1beta1Finding/parent": parent
"/securitycenter:v1beta1/GoogleCloudSecuritycenterV1p1beta1Finding/resourceName": resource_name "/securitycenter:v1beta1/GoogleCloudSecuritycenterV1p1beta1Finding/resourceName": resource_name
"/securitycenter:v1beta1/GoogleCloudSecuritycenterV1p1beta1Finding/securityMarks": security_marks "/securitycenter:v1beta1/GoogleCloudSecuritycenterV1p1beta1Finding/securityMarks": security_marks
"/securitycenter:v1beta1/GoogleCloudSecuritycenterV1p1beta1Finding/severity": severity
"/securitycenter:v1beta1/GoogleCloudSecuritycenterV1p1beta1Finding/sourceProperties": source_properties "/securitycenter:v1beta1/GoogleCloudSecuritycenterV1p1beta1Finding/sourceProperties": source_properties
"/securitycenter:v1beta1/GoogleCloudSecuritycenterV1p1beta1Finding/sourceProperties/source_property": source_property "/securitycenter:v1beta1/GoogleCloudSecuritycenterV1p1beta1Finding/sourceProperties/source_property": source_property
"/securitycenter:v1beta1/GoogleCloudSecuritycenterV1p1beta1Finding/state": state "/securitycenter:v1beta1/GoogleCloudSecuritycenterV1p1beta1Finding/state": state
@ -121768,6 +121771,7 @@
"/securitycenter:v1p1alpha1/GoogleCloudSecuritycenterV1p1beta1Finding/parent": parent "/securitycenter:v1p1alpha1/GoogleCloudSecuritycenterV1p1beta1Finding/parent": parent
"/securitycenter:v1p1alpha1/GoogleCloudSecuritycenterV1p1beta1Finding/resourceName": resource_name "/securitycenter:v1p1alpha1/GoogleCloudSecuritycenterV1p1beta1Finding/resourceName": resource_name
"/securitycenter:v1p1alpha1/GoogleCloudSecuritycenterV1p1beta1Finding/securityMarks": security_marks "/securitycenter:v1p1alpha1/GoogleCloudSecuritycenterV1p1beta1Finding/securityMarks": security_marks
"/securitycenter:v1p1alpha1/GoogleCloudSecuritycenterV1p1beta1Finding/severity": severity
"/securitycenter:v1p1alpha1/GoogleCloudSecuritycenterV1p1beta1Finding/sourceProperties": source_properties "/securitycenter:v1p1alpha1/GoogleCloudSecuritycenterV1p1beta1Finding/sourceProperties": source_properties
"/securitycenter:v1p1alpha1/GoogleCloudSecuritycenterV1p1beta1Finding/sourceProperties/source_property": source_property "/securitycenter:v1p1alpha1/GoogleCloudSecuritycenterV1p1beta1Finding/sourceProperties/source_property": source_property
"/securitycenter:v1p1alpha1/GoogleCloudSecuritycenterV1p1beta1Finding/state": state "/securitycenter:v1p1alpha1/GoogleCloudSecuritycenterV1p1beta1Finding/state": state
@ -121913,6 +121917,7 @@
"/securitycenter:v1p1beta1/GoogleCloudSecuritycenterV1p1beta1Finding/parent": parent "/securitycenter:v1p1beta1/GoogleCloudSecuritycenterV1p1beta1Finding/parent": parent
"/securitycenter:v1p1beta1/GoogleCloudSecuritycenterV1p1beta1Finding/resourceName": resource_name "/securitycenter:v1p1beta1/GoogleCloudSecuritycenterV1p1beta1Finding/resourceName": resource_name
"/securitycenter:v1p1beta1/GoogleCloudSecuritycenterV1p1beta1Finding/securityMarks": security_marks "/securitycenter:v1p1beta1/GoogleCloudSecuritycenterV1p1beta1Finding/securityMarks": security_marks
"/securitycenter:v1p1beta1/GoogleCloudSecuritycenterV1p1beta1Finding/severity": severity
"/securitycenter:v1p1beta1/GoogleCloudSecuritycenterV1p1beta1Finding/sourceProperties": source_properties "/securitycenter:v1p1beta1/GoogleCloudSecuritycenterV1p1beta1Finding/sourceProperties": source_properties
"/securitycenter:v1p1beta1/GoogleCloudSecuritycenterV1p1beta1Finding/sourceProperties/source_property": source_property "/securitycenter:v1p1beta1/GoogleCloudSecuritycenterV1p1beta1Finding/sourceProperties/source_property": source_property
"/securitycenter:v1p1beta1/GoogleCloudSecuritycenterV1p1beta1Finding/state": state "/securitycenter:v1p1beta1/GoogleCloudSecuritycenterV1p1beta1Finding/state": state

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

@ -18,15 +18,16 @@ require 'google/apis/admin_directory_v1/representations.rb'
module Google module Google
module Apis module Apis
# Admin Directory API # Admin SDK
# #
# Manages enterprise resources such as users and groups, administrative # Admin SDK lets administrators of enterprise domains to view and manage
# notifications, security features, and more. # resources like user, groups etc. It also provides audit and usage reports of
# domain.
# #
# @see https://developers.google.com/admin-sdk/directory/ # @see http://developers.google.com/admin-sdk/
module AdminDirectoryV1 module AdminDirectoryV1
VERSION = 'DirectoryV1' VERSION = 'DirectoryV1'
REVISION = '20200605' REVISION = '20200810'
# View and manage customer related information # View and manage customer related information
AUTH_ADMIN_DIRECTORY_CUSTOMER = 'https://www.googleapis.com/auth/admin.directory.customer' AUTH_ADMIN_DIRECTORY_CUSTOMER = 'https://www.googleapis.com/auth/admin.directory.customer'
@ -67,9 +68,6 @@ module Google
# View groups on your domain # View groups on your domain
AUTH_ADMIN_DIRECTORY_GROUP_READONLY = 'https://www.googleapis.com/auth/admin.directory.group.readonly' AUTH_ADMIN_DIRECTORY_GROUP_READONLY = 'https://www.googleapis.com/auth/admin.directory.group.readonly'
# View and manage notifications received on your domain
AUTH_ADMIN_DIRECTORY_NOTIFICATIONS = 'https://www.googleapis.com/auth/admin.directory.notifications'
# View and manage organization units on your domain # View and manage organization units on your domain
AUTH_ADMIN_DIRECTORY_ORGUNIT = 'https://www.googleapis.com/auth/admin.directory.orgunit' AUTH_ADMIN_DIRECTORY_ORGUNIT = 'https://www.googleapis.com/auth/admin.directory.orgunit'

463
generated/google/apis/admin_directory_v1/classes.rb
View File

File diff suppressed because it is too large Load Diff

54
generated/google/apis/admin_directory_v1/representations.rb
View File

@ -286,18 +286,6 @@ module Google
include Google::Apis::Core::JsonObjectSupport include Google::Apis::Core::JsonObjectSupport
end end
class Notification
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class Notifications
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class OrgUnit class OrgUnit
class Representation < Google::Apis::Core::JsonRepresentation; end class Representation < Google::Apis::Core::JsonRepresentation; end
@ -406,6 +394,12 @@ module Google
include Google::Apis::Core::JsonObjectSupport include Google::Apis::Core::JsonObjectSupport
end end
class UserCustomProperties
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class UserEmail class UserEmail
class Representation < Google::Apis::Core::JsonRepresentation; end class Representation < Google::Apis::Core::JsonRepresentation; end
@ -1087,33 +1081,6 @@ module Google
end end
end end
class Notification
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :body, as: 'body'
property :etag, as: 'etag'
property :from_address, as: 'fromAddress'
property :is_unread, as: 'isUnread'
property :kind, as: 'kind'
property :notification_id, as: 'notificationId'
property :send_time, as: 'sendTime', type: DateTime
property :subject, as: 'subject'
end
end
class Notifications
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :etag, as: 'etag'
collection :items, as: 'items', class: Google::Apis::AdminDirectoryV1::Notification, decorator: Google::Apis::AdminDirectoryV1::Notification::Representation
property :kind, as: 'kind'
property :next_page_token, as: 'nextPageToken'
property :unread_notifications_count, as: 'unreadNotificationsCount'
end
end
class OrgUnit class OrgUnit
# @private # @private
class Representation < Google::Apis::Core::JsonRepresentation class Representation < Google::Apis::Core::JsonRepresentation
@ -1303,7 +1270,8 @@ module Google
property :change_password_at_next_login, as: 'changePasswordAtNextLogin' property :change_password_at_next_login, as: 'changePasswordAtNextLogin'
property :creation_time, as: 'creationTime', type: DateTime property :creation_time, as: 'creationTime', type: DateTime
hash :custom_schemas, as: 'customSchemas' hash :custom_schemas, as: 'customSchemas', class: Google::Apis::AdminDirectoryV1::UserCustomProperties, decorator: Google::Apis::AdminDirectoryV1::UserCustomProperties::Representation
property :customer_id, as: 'customerId' property :customer_id, as: 'customerId'
property :deletion_time, as: 'deletionTime', type: DateTime property :deletion_time, as: 'deletionTime', type: DateTime
@ -1376,6 +1344,12 @@ module Google
end end
end end
class UserCustomProperties
# @private
class Representation < Google::Apis::Core::JsonRepresentation
end
end
class UserEmail class UserEmail
# @private # @private
class Representation < Google::Apis::Core::JsonRepresentation class Representation < Google::Apis::Core::JsonRepresentation

1497
generated/google/apis/admin_directory_v1/service.rb
View File

File diff suppressed because it is too large Load Diff

11
generated/google/apis/admin_reports_v1.rb
View File

@ -18,15 +18,16 @@ require 'google/apis/admin_reports_v1/representations.rb'
module Google module Google
module Apis module Apis
# Admin Reports API # Admin SDK
# #
# Fetches reports for the administrators of G Suite customers about the usage, # Admin SDK lets administrators of enterprise domains to view and manage
# collaboration, security, and risk for their users. # resources like user, groups etc. It also provides audit and usage reports of
# domain.
# #
# @see /admin-sdk/reports/ # @see http://developers.google.com/admin-sdk/
module AdminReportsV1 module AdminReportsV1
VERSION = 'ReportsV1' VERSION = 'ReportsV1'
REVISION = '20191014' REVISION = '20200810'
# View audit reports for your G Suite domain # View audit reports for your G Suite domain
AUTH_ADMIN_REPORTS_AUDIT_READONLY = 'https://www.googleapis.com/auth/admin.reports.audit.readonly' AUTH_ADMIN_REPORTS_AUDIT_READONLY = 'https://www.googleapis.com/auth/admin.reports.audit.readonly'

64
generated/google/apis/admin_reports_v1/classes.rb
View File

@ -22,7 +22,7 @@ module Google
module Apis module Apis
module AdminReportsV1 module AdminReportsV1
# JSON template for a collection of activites. # JSON template for a collection of activities.
class Activities class Activities
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
@ -166,15 +166,13 @@ module Google
# Name of the event. This is the specific name of the activity reported by the # Name of the event. This is the specific name of the activity reported by the
# API. And each eventName is related to a specific G Suite service or feature # API. And each eventName is related to a specific G Suite service or feature
# which the API organizes into types of events. # which the API organizes into types of events. For eventName request parameters
# For eventName request parameters in general: # in general: - If no eventName is given, the report returns all possible
# - If no eventName is given, the report returns all possible instances of an # instances of an eventName. - When you request an eventName, the API's response
# eventName. # returns all activities which contain that eventName. It is possible that the
# - When you request an eventName, the API's response returns all activities # returned activities will have other eventName properties in addition to the
# which contain that eventName. It is possible that the returned activities will # one requested. For more information about eventName properties, see the list
# have other eventName properties in addition to the one requested. # of event names for various applications above in applicationName.
# For more information about eventName properties, see the list of event names
# for various applications above in applicationName.
# Corresponds to the JSON property `name` # Corresponds to the JSON property `name`
# @return [String] # @return [String]
attr_accessor :name attr_accessor :name
@ -351,7 +349,7 @@ module Google
end end
end end
# An notification channel used to watch for resource changes. # A notification channel used to watch for resource changes.
class Channel class Channel
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
@ -489,12 +487,12 @@ module Google
class UsageReport class UsageReport
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
# The date of the report request. # Output only. The date of the report request.
# Corresponds to the JSON property `date` # Corresponds to the JSON property `date`
# @return [String] # @return [String]
attr_accessor :date attr_accessor :date
# Information about the type of the item. # Output only. Information about the type of the item.
# Corresponds to the JSON property `entity` # Corresponds to the JSON property `entity`
# @return [Google::Apis::AdminReportsV1::UsageReport::Entity] # @return [Google::Apis::AdminReportsV1::UsageReport::Entity]
attr_accessor :entity attr_accessor :entity
@ -510,8 +508,9 @@ module Google
# @return [String] # @return [String]
attr_accessor :kind attr_accessor :kind
# Parameter value pairs for various applications. For the Customers usage report # Output only. Parameter value pairs for various applications. For the Customers
# parameters and values, see the customer usage parameters reference. # usage report parameters and values, see the customer usage parameters
# reference.
# Corresponds to the JSON property `parameters` # Corresponds to the JSON property `parameters`
# @return [Array<Google::Apis::AdminReportsV1::UsageReport::Parameter>] # @return [Array<Google::Apis::AdminReportsV1::UsageReport::Parameter>]
attr_accessor :parameters attr_accessor :parameters
@ -529,32 +528,32 @@ module Google
@parameters = args[:parameters] if args.key?(:parameters) @parameters = args[:parameters] if args.key?(:parameters)
end end
# Information about the type of the item. # Output only. Information about the type of the item.
class Entity class Entity
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
# The unique identifier of the customer's account. # Output only. The unique identifier of the customer's account.
# Corresponds to the JSON property `customerId` # Corresponds to the JSON property `customerId`
# @return [String] # @return [String]
attr_accessor :customer_id attr_accessor :customer_id
# Object key. Only relevant if entity.type = "OBJECT" Note: external-facing name # Output only. Object key. Only relevant if entity.type = "OBJECT" Note:
# of report is "Entities" rather than "Objects". # external-facing name of report is "Entities" rather than "Objects".
# Corresponds to the JSON property `entityId` # Corresponds to the JSON property `entityId`
# @return [String] # @return [String]
attr_accessor :entity_id attr_accessor :entity_id
# The user's immutable G Suite profile identifier. # Output only. The user's immutable G Suite profile identifier.
# Corresponds to the JSON property `profileId` # Corresponds to the JSON property `profileId`
# @return [String] # @return [String]
attr_accessor :profile_id attr_accessor :profile_id
# The type of item. The value is customer. # Output only. The type of item. The value is customer.
# Corresponds to the JSON property `type` # Corresponds to the JSON property `type`
# @return [String] # @return [String]
attr_accessor :type attr_accessor :type
# The user's email address. Only relevant if entity.type = "USER" # Output only. The user's email address. Only relevant if entity.type = "USER"
# Corresponds to the JSON property `userEmail` # Corresponds to the JSON property `userEmail`
# @return [String] # @return [String]
attr_accessor :user_email attr_accessor :user_email
@ -577,7 +576,7 @@ module Google
class Parameter class Parameter
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
# Boolean value of the parameter. # Output only. Boolean value of the parameter.
# Corresponds to the JSON property `boolValue` # Corresponds to the JSON property `boolValue`
# @return [Boolean] # @return [Boolean]
attr_accessor :bool_value attr_accessor :bool_value
@ -589,22 +588,22 @@ module Google
# @return [DateTime] # @return [DateTime]
attr_accessor :datetime_value attr_accessor :datetime_value
# Integer value of the parameter. # Output only. Integer value of the parameter.
# Corresponds to the JSON property `intValue` # Corresponds to the JSON property `intValue`
# @return [Fixnum] # @return [Fixnum]
attr_accessor :int_value attr_accessor :int_value
# Nested message value of the parameter. # Output only. Nested message value of the parameter.
# Corresponds to the JSON property `msgValue` # Corresponds to the JSON property `msgValue`
# @return [Array<Hash<String,Object>>] # @return [Array<Hash<String,Object>>]
attr_accessor :msg_value attr_accessor :msg_value
# # Name of the parameter.
# Corresponds to the JSON property `name` # Corresponds to the JSON property `name`
# @return [String] # @return [String]
attr_accessor :name attr_accessor :name
# String value of the parameter. # Output only. String value of the parameter.
# Corresponds to the JSON property `stringValue` # Corresponds to the JSON property `stringValue`
# @return [String] # @return [String]
attr_accessor :string_value attr_accessor :string_value
@ -684,12 +683,11 @@ module Google
# @return [Array<Google::Apis::AdminReportsV1::UsageReports::Warning::Datum>] # @return [Array<Google::Apis::AdminReportsV1::UsageReports::Warning::Datum>]
attr_accessor :data attr_accessor :data
# The human readable messages for a warning are: # The human readable messages for a warning are: - Data is not available warning
# - Data is not available warning - Sorry, data for date yyyy-mm-dd for # - Sorry, data for date yyyy-mm-dd for application "application name" is not
# application "application name" is not available. # available. - Partial data is available warning - Data for date yyyy-mm-dd for
# - Partial data is available warning - Data for date yyyy-mm-dd for application # application "application name" is not available right now, please try again
# "application name" is not available right now, please try again after a few # after a few hours.
# hours.
# Corresponds to the JSON property `message` # Corresponds to the JSON property `message`
# @return [String] # @return [String]
attr_accessor :message attr_accessor :message

314
generated/google/apis/admin_reports_v1/service.rb
View File

@ -20,10 +20,11 @@ require 'google/apis/errors'
module Google module Google
module Apis module Apis
module AdminReportsV1 module AdminReportsV1
# Admin Reports API # Admin SDK
# #
# Fetches reports for the administrators of G Suite customers about the usage, # Admin SDK lets administrators of enterprise domains to view and manage
# collaboration, security, and risk for their users. # resources like user, groups etc. It also provides audit and usage reports of
# domain.
# #
# @example # @example
# require 'google/apis/admin_reports_v1' # require 'google/apis/admin_reports_v1'
@ -31,7 +32,7 @@ module Google
# Admin = Google::Apis::AdminReportsV1 # Alias the module # Admin = Google::Apis::AdminReportsV1 # Alias the module
# service = Admin::ReportsService.new # service = Admin::ReportsService.new
# #
# @see /admin-sdk/reports/ # @see http://developers.google.com/admin-sdk/
class ReportsService < Google::Apis::Core::BaseService class ReportsService < Google::Apis::Core::BaseService
# @return [String] # @return [String]
# API key. Your API key identifies your project and provides you with API access, # API key. Your API key identifies your project and provides you with API access,
@ -39,16 +40,12 @@ module Google
attr_accessor :key attr_accessor :key
# @return [String] # @return [String]
# An opaque string that represents a user for quota purposes. Must not exceed 40 # Available to use for quota purposes for server-side applications. Can be any
# characters. # arbitrary string assigned to a user, but should not exceed 40 characters.
attr_accessor :quota_user attr_accessor :quota_user
# @return [String]
# Deprecated. Please use quotaUser instead.
attr_accessor :user_ip
def initialize def initialize
super('https://www.googleapis.com/', 'admin/reports/v1/') super('https://www.googleapis.com/', '')
@batch_path = 'batch/admin/reports_v1' @batch_path = 'batch/admin/reports_v1'
end end
@ -76,13 +73,11 @@ module Google
# Sets the end of the range of time shown in the report. The date is in the RFC # Sets the end of the range of time shown in the report. The date is in the RFC
# 3339 format, for example 2010-10-28T10:26:35.000Z. The default value is the # 3339 format, for example 2010-10-28T10:26:35.000Z. The default value is the
# approximate time of the API request. An API report has three basic time # approximate time of the API request. An API report has three basic time
# concepts: # concepts: - *Date of the API's request for a report*: When the API created and
# - Date of the API's request for a report: When the API created and retrieved # retrieved the report. - *Report's start time*: The beginning of the timespan
# the report. # shown in the report. The startTime must be before the endTime (if specified)
# - Report's start time: The beginning of the timespan shown in the report. The # and the current time when the request is made, or the API returns an error. - *
# startTime must be before the endTime (if specified) and the current time when # Report's end time*: The end of the timespan shown in the report. For example,
# the request is made, or the API returns an error.
# - Report's end time: The end of the timespan shown in the report. For example,
# the timespan of events summarized in a report can start in April and end in # the timespan of events summarized in a report can start in April and end in
# May. The report itself can be requested in August. If the endTime is not # May. The report itself can be requested in August. If the endTime is not
# specified, the report returns all activities from the startTime until the # specified, the report returns all activities from the startTime until the
@ -101,39 +96,33 @@ module Google
# @param [String] filters # @param [String] filters
# The filters query string is a comma-separated list. The list is composed of # The filters query string is a comma-separated list. The list is composed of
# event parameters that are manipulated by relational operators. Event # event parameters that are manipulated by relational operators. Event
# parameters are in the form [parameter1 name][relational operator][parameter1 # parameters are in the form parameter1 name[parameter1 value],parameter2 name[
# value],[parameter2 name][relational operator][parameter2 value],... # parameter2 value],... These event parameters are associated with a specific
# These event parameters are associated with a specific eventName. An empty # eventName. An empty report is returned if the filtered request's parameter
# report is returned if the filtered request's parameter does not belong to the # does not belong to the eventName. For more information about eventName
# eventName. For more information about eventName parameters, see the list of # parameters, see the list of event names for various applications above in
# event names for various applications above in applicationName. # applicationName. In the following Admin Activity example, the <> operator is
# In the following Admin Activity example, the <> operator is URL-encoded in the # URL-encoded in the request's query string (%3C%3E): GET...&eventName=
# request's query string (%3C%3E): # CHANGE_CALENDAR_SETTING &filters=NEW_VALUE%3C%3EREAD_ONLY_ACCESS In the
# GET...&eventName=CHANGE_CALENDAR_SETTING &filters=NEW_VALUE%3C% # following Drive example, the list can be a view or edit event's doc_id
# 3EREAD_ONLY_ACCESS
# In the following Drive example, the list can be a view or edit event's doc_id
# parameter with a value that is manipulated by an 'equal to' (==) or 'not equal # parameter with a value that is manipulated by an 'equal to' (==) or 'not equal
# to' (<>) relational operator. In the first example, the report returns each # to' (<>) relational operator. In the first example, the report returns each
# edited document's doc_id. In the second example, the report returns each # edited document's doc_id. In the second example, the report returns each
# viewed document's doc_id that equals the value 12345 and does not return any # viewed document's doc_id that equals the value 12345 and does not return any
# viewed document's which have a doc_id value of 98765. The <> operator is URL- # viewed document's which have a doc_id value of 98765. The <> operator is URL-
# encoded in the request's query string (%3C%3E): # encoded in the request's query string (%3C%3E): GET...&eventName=edit&filters=
# GET...&eventName=edit&filters=doc_id GET...&eventName=view&filters=doc_id== # doc_id GET...&eventName=view&filters=doc_id==12345,doc_id%3C%3E98765 The
# 12345,doc_id%3C%3E98765 # relational operators include: - == - 'equal to'. - <> - 'not equal to'. It is
# The relational operators include: # URL-encoded (%3C%3E). - < - 'less than'. It is URL-encoded (%3C). - <= - 'less
# - == - 'equal to'. # than or equal to'. It is URL-encoded (%3C=). - > - 'greater than'. It is URL-
# - <> - 'not equal to'. It is URL-encoded (%3C%3E). # encoded (%3E). - >= - 'greater than or equal to'. It is URL-encoded (%3E=). *
# - < - 'less than'. It is URL-encoded (%3C). # Note:* The API doesn't accept multiple values of a parameter. If a particular
# - <= - 'less than or equal to'. It is URL-encoded (%3C=).
# - > - 'greater than'. It is URL-encoded (%3E).
# - >= - 'greater than or equal to'. It is URL-encoded (%3E=).
# Note: The API doesn't accept multiple values of a parameter. If a particular
# parameter is supplied more than once in the API request, the API only accepts # parameter is supplied more than once in the API request, the API only accepts
# the last value of that request parameter. # the last value of that request parameter. In addition, if an invalid request
# In addition, if an invalid request parameter is supplied in the API request, # parameter is supplied in the API request, the API ignores that request
# the API ignores that request parameter and returns the response corresponding # parameter and returns the response corresponding to the remaining valid
# to the remaining valid request parameters. If no parameters are requested, all # request parameters. If no parameters are requested, all parameters are
# parameters are returned. # returned.
# @param [Fixnum] max_results # @param [Fixnum] max_results
# Determines how many activity records are shown on each response page. For # Determines how many activity records are shown on each response page. For
# example, if the request sets maxResults=1 and the report has two activities, # example, if the request sets maxResults=1 and the report has two activities,
@ -158,10 +147,8 @@ module Google
# @param [String] fields # @param [String] fields
# Selector specifying which fields to include in a partial response. # Selector specifying which fields to include in a partial response.
# @param [String] quota_user # @param [String] quota_user
# An opaque string that represents a user for quota purposes. Must not exceed 40 # Available to use for quota purposes for server-side applications. Can be any
# characters. # arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [String] user_ip
# Deprecated. Please use quotaUser instead.
# @param [Google::Apis::RequestOptions] options # @param [Google::Apis::RequestOptions] options
# Request-specific options # Request-specific options
# #
@ -174,8 +161,8 @@ module Google
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required # @raise [Google::Apis::AuthorizationError] Authorization is required
def list_activities(user_key, application_name, actor_ip_address: nil, customer_id: nil, end_time: nil, event_name: nil, filters: nil, max_results: nil, org_unit_id: nil, page_token: nil, start_time: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) def list_activities(user_key, application_name, actor_ip_address: nil, customer_id: nil, end_time: nil, event_name: nil, filters: nil, max_results: nil, org_unit_id: nil, page_token: nil, start_time: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'activity/users/{userKey}/applications/{applicationName}', options) command = make_simple_command(:get, 'admin/reports/v1/activity/users/{userKey}/applications/{applicationName}', options)
command.response_representation = Google::Apis::AdminReportsV1::Activities::Representation command.response_representation = Google::Apis::AdminReportsV1::Activities::Representation
command.response_class = Google::Apis::AdminReportsV1::Activities command.response_class = Google::Apis::AdminReportsV1::Activities
command.params['userKey'] = user_key unless user_key.nil? command.params['userKey'] = user_key unless user_key.nil?
@ -191,7 +178,6 @@ module Google
command.query['startTime'] = start_time unless start_time.nil? command.query['startTime'] = start_time unless start_time.nil?
command.query['fields'] = fields unless fields.nil? command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['userIp'] = user_ip unless user_ip.nil?
execute_or_queue_command(command, &block) execute_or_queue_command(command, &block)
end end
@ -217,13 +203,11 @@ module Google
# Sets the end of the range of time shown in the report. The date is in the RFC # Sets the end of the range of time shown in the report. The date is in the RFC
# 3339 format, for example 2010-10-28T10:26:35.000Z. The default value is the # 3339 format, for example 2010-10-28T10:26:35.000Z. The default value is the
# approximate time of the API request. An API report has three basic time # approximate time of the API request. An API report has three basic time
# concepts: # concepts: - *Date of the API's request for a report*: When the API created and
# - Date of the API's request for a report: When the API created and retrieved # retrieved the report. - *Report's start time*: The beginning of the timespan
# the report. # shown in the report. The startTime must be before the endTime (if specified)
# - Report's start time: The beginning of the timespan shown in the report. The # and the current time when the request is made, or the API returns an error. - *
# startTime must be before the endTime (if specified) and the current time when # Report's end time*: The end of the timespan shown in the report. For example,
# the request is made, or the API returns an error.
# - Report's end time: The end of the timespan shown in the report. For example,
# the timespan of events summarized in a report can start in April and end in # the timespan of events summarized in a report can start in April and end in
# May. The report itself can be requested in August. If the endTime is not # May. The report itself can be requested in August. If the endTime is not
# specified, the report returns all activities from the startTime until the # specified, the report returns all activities from the startTime until the
@ -242,39 +226,33 @@ module Google
# @param [String] filters # @param [String] filters
# The filters query string is a comma-separated list. The list is composed of # The filters query string is a comma-separated list. The list is composed of
# event parameters that are manipulated by relational operators. Event # event parameters that are manipulated by relational operators. Event
# parameters are in the form [parameter1 name][relational operator][parameter1 # parameters are in the form parameter1 name[parameter1 value],parameter2 name[
# value],[parameter2 name][relational operator][parameter2 value],... # parameter2 value],... These event parameters are associated with a specific
# These event parameters are associated with a specific eventName. An empty # eventName. An empty report is returned if the filtered request's parameter
# report is returned if the filtered request's parameter does not belong to the # does not belong to the eventName. For more information about eventName
# eventName. For more information about eventName parameters, see the list of # parameters, see the list of event names for various applications above in
# event names for various applications above in applicationName. # applicationName. In the following Admin Activity example, the <> operator is
# In the following Admin Activity example, the <> operator is URL-encoded in the # URL-encoded in the request's query string (%3C%3E): GET...&eventName=
# request's query string (%3C%3E): # CHANGE_CALENDAR_SETTING &filters=NEW_VALUE%3C%3EREAD_ONLY_ACCESS In the
# GET...&eventName=CHANGE_CALENDAR_SETTING &filters=NEW_VALUE%3C% # following Drive example, the list can be a view or edit event's doc_id
# 3EREAD_ONLY_ACCESS
# In the following Drive example, the list can be a view or edit event's doc_id
# parameter with a value that is manipulated by an 'equal to' (==) or 'not equal # parameter with a value that is manipulated by an 'equal to' (==) or 'not equal
# to' (<>) relational operator. In the first example, the report returns each # to' (<>) relational operator. In the first example, the report returns each
# edited document's doc_id. In the second example, the report returns each # edited document's doc_id. In the second example, the report returns each
# viewed document's doc_id that equals the value 12345 and does not return any # viewed document's doc_id that equals the value 12345 and does not return any
# viewed document's which have a doc_id value of 98765. The <> operator is URL- # viewed document's which have a doc_id value of 98765. The <> operator is URL-
# encoded in the request's query string (%3C%3E): # encoded in the request's query string (%3C%3E): GET...&eventName=edit&filters=
# GET...&eventName=edit&filters=doc_id GET...&eventName=view&filters=doc_id== # doc_id GET...&eventName=view&filters=doc_id==12345,doc_id%3C%3E98765 The
# 12345,doc_id%3C%3E98765 # relational operators include: - == - 'equal to'. - <> - 'not equal to'. It is
# The relational operators include: # URL-encoded (%3C%3E). - < - 'less than'. It is URL-encoded (%3C). - <= - 'less
# - == - 'equal to'. # than or equal to'. It is URL-encoded (%3C=). - > - 'greater than'. It is URL-
# - <> - 'not equal to'. It is URL-encoded (%3C%3E). # encoded (%3E). - >= - 'greater than or equal to'. It is URL-encoded (%3E=). *
# - < - 'less than'. It is URL-encoded (%3C). # Note:* The API doesn't accept multiple values of a parameter. If a particular
# - <= - 'less than or equal to'. It is URL-encoded (%3C=).
# - > - 'greater than'. It is URL-encoded (%3E).
# - >= - 'greater than or equal to'. It is URL-encoded (%3E=).
# Note: The API doesn't accept multiple values of a parameter. If a particular
# parameter is supplied more than once in the API request, the API only accepts # parameter is supplied more than once in the API request, the API only accepts
# the last value of that request parameter. # the last value of that request parameter. In addition, if an invalid request
# In addition, if an invalid request parameter is supplied in the API request, # parameter is supplied in the API request, the API ignores that request
# the API ignores that request parameter and returns the response corresponding # parameter and returns the response corresponding to the remaining valid
# to the remaining valid request parameters. If no parameters are requested, all # request parameters. If no parameters are requested, all parameters are
# parameters are returned. # returned.
# @param [Fixnum] max_results # @param [Fixnum] max_results
# Determines how many activity records are shown on each response page. For # Determines how many activity records are shown on each response page. For
# example, if the request sets maxResults=1 and the report has two activities, # example, if the request sets maxResults=1 and the report has two activities,
@ -299,10 +277,8 @@ module Google
# @param [String] fields # @param [String] fields
# Selector specifying which fields to include in a partial response. # Selector specifying which fields to include in a partial response.
# @param [String] quota_user # @param [String] quota_user
# An opaque string that represents a user for quota purposes. Must not exceed 40 # Available to use for quota purposes for server-side applications. Can be any
# characters. # arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [String] user_ip
# Deprecated. Please use quotaUser instead.
# @param [Google::Apis::RequestOptions] options # @param [Google::Apis::RequestOptions] options
# Request-specific options # Request-specific options
# #
@ -315,8 +291,8 @@ module Google
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required # @raise [Google::Apis::AuthorizationError] Authorization is required
def watch_activity(user_key, application_name, channel_object = nil, actor_ip_address: nil, customer_id: nil, end_time: nil, event_name: nil, filters: nil, max_results: nil, org_unit_id: nil, page_token: nil, start_time: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) def watch_activity(user_key, application_name, channel_object = nil, actor_ip_address: nil, customer_id: nil, end_time: nil, event_name: nil, filters: nil, max_results: nil, org_unit_id: nil, page_token: nil, start_time: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'activity/users/{userKey}/applications/{applicationName}/watch', options) command = make_simple_command(:post, 'admin/reports/v1/activity/users/{userKey}/applications/{applicationName}/watch', options)
command.request_representation = Google::Apis::AdminReportsV1::Channel::Representation command.request_representation = Google::Apis::AdminReportsV1::Channel::Representation
command.request_object = channel_object command.request_object = channel_object
command.response_representation = Google::Apis::AdminReportsV1::Channel::Representation command.response_representation = Google::Apis::AdminReportsV1::Channel::Representation
@ -334,19 +310,16 @@ module Google
command.query['startTime'] = start_time unless start_time.nil? command.query['startTime'] = start_time unless start_time.nil?
command.query['fields'] = fields unless fields.nil? command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['userIp'] = user_ip unless user_ip.nil?
execute_or_queue_command(command, &block) execute_or_queue_command(command, &block)
end end
# Stop watching resources through this channel # Stop watching resources through this channel.
# @param [Google::Apis::AdminReportsV1::Channel] channel_object # @param [Google::Apis::AdminReportsV1::Channel] channel_object
# @param [String] fields # @param [String] fields
# Selector specifying which fields to include in a partial response. # Selector specifying which fields to include in a partial response.
# @param [String] quota_user # @param [String] quota_user
# An opaque string that represents a user for quota purposes. Must not exceed 40 # Available to use for quota purposes for server-side applications. Can be any
# characters. # arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [String] user_ip
# Deprecated. Please use quotaUser instead.
# @param [Google::Apis::RequestOptions] options # @param [Google::Apis::RequestOptions] options
# Request-specific options # Request-specific options
# #
@ -359,13 +332,12 @@ module Google
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required # @raise [Google::Apis::AuthorizationError] Authorization is required
def stop_channel(channel_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) def stop_channel(channel_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, '/admin/reports_v1/channels/stop', options) command = make_simple_command(:post, 'admin/reports_v1/channels/stop', options)
command.request_representation = Google::Apis::AdminReportsV1::Channel::Representation command.request_representation = Google::Apis::AdminReportsV1::Channel::Representation
command.request_object = channel_object command.request_object = channel_object
command.query['fields'] = fields unless fields.nil? command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['userIp'] = user_ip unless user_ip.nil?
execute_or_queue_command(command, &block) execute_or_queue_command(command, &block)
end end
@ -387,24 +359,20 @@ module Google
# refine a report's results. The parameter is associated with a specific # refine a report's results. The parameter is associated with a specific
# application. The application values for the Customers usage report include # application. The application values for the Customers usage report include
# accounts, app_maker, apps_scripts, calendar, classroom, cros, docs, gmail, # accounts, app_maker, apps_scripts, calendar, classroom, cros, docs, gmail,
# gplus, device_management, meet, and sites. # gplus, device_management, meet, and sites. A parameters query string is in the
# A parameters query string is in the CSV form of app_name1:param_name1, # CSV form of app_name1:param_name1, app_name2:param_name2. *Note:* The API
# app_name2:param_name2. # doesn't accept multiple values of a parameter. If a particular parameter is
# Note: The API doesn't accept multiple values of a parameter. If a particular # supplied more than once in the API request, the API only accepts the last
# parameter is supplied more than once in the API request, the API only accepts # value of that request parameter. In addition, if an invalid request parameter
# the last value of that request parameter. # is supplied in the API request, the API ignores that request parameter and
# In addition, if an invalid request parameter is supplied in the API request, # returns the response corresponding to the remaining valid request parameters.
# the API ignores that request parameter and returns the response corresponding
# to the remaining valid request parameters.
# An example of an invalid request parameter is one that does not belong to the # An example of an invalid request parameter is one that does not belong to the
# application. If no parameters are requested, all parameters are returned. # application. If no parameters are requested, all parameters are returned.
# @param [String] fields # @param [String] fields
# Selector specifying which fields to include in a partial response. # Selector specifying which fields to include in a partial response.
# @param [String] quota_user # @param [String] quota_user
# An opaque string that represents a user for quota purposes. Must not exceed 40 # Available to use for quota purposes for server-side applications. Can be any
# characters. # arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [String] user_ip
# Deprecated. Please use quotaUser instead.
# @param [Google::Apis::RequestOptions] options # @param [Google::Apis::RequestOptions] options
# Request-specific options # Request-specific options
# #
@ -417,8 +385,8 @@ module Google
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required # @raise [Google::Apis::AuthorizationError] Authorization is required
def get_customer_usage_report(date, customer_id: nil, page_token: nil, parameters: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) def get_customer_usage_report(date, customer_id: nil, page_token: nil, parameters: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'usage/dates/{date}', options) command = make_simple_command(:get, 'admin/reports/v1/usage/dates/{date}', options)
command.response_representation = Google::Apis::AdminReportsV1::UsageReports::Representation command.response_representation = Google::Apis::AdminReportsV1::UsageReports::Representation
command.response_class = Google::Apis::AdminReportsV1::UsageReports command.response_class = Google::Apis::AdminReportsV1::UsageReports
command.params['date'] = date unless date.nil? command.params['date'] = date unless date.nil?
@ -427,7 +395,6 @@ module Google
command.query['parameters'] = parameters unless parameters.nil? command.query['parameters'] = parameters unless parameters.nil?
command.query['fields'] = fields unless fields.nil? command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['userIp'] = user_ip unless user_ip.nil?
execute_or_queue_command(command, &block) execute_or_queue_command(command, &block)
end end
@ -449,22 +416,16 @@ module Google
# parameters where the parameter's value is manipulated by a relational operator. # parameters where the parameter's value is manipulated by a relational operator.
# The filters query string includes the name of the application whose usage is # The filters query string includes the name of the application whose usage is
# returned in the report. The application values for the Entities usage report # returned in the report. The application values for the Entities usage report
# include accounts, docs, and gmail. # include accounts, docs, and gmail. Filters are in the form [application name]:
# Filters are in the form [application name]:[parameter name][relational # parameter name[parameter value],.... In this example, the <> 'not equal to'
# operator][parameter value],.... # operator is URL-encoded in the request's query string (%3C%3E): GET https://
# In this example, the <> 'not equal to' operator is URL-encoded in the request' # www.googleapis.com/admin/reports/v1/usage/gplus_communities/all/dates/2017-12-
# s query string (%3C%3E): # 01 ?parameters=gplus:community_name,gplus:num_total_members &filters=gplus:
# GET https://www.googleapis.com/admin/reports/v1/usage/gplus_communities/all/ # num_total_members>0 The relational operators include: - == - 'equal to'. - <> -
# dates/2017-12-01 ?parameters=gplus:community_name,gplus:num_total_members & # 'not equal to'. It is URL-encoded (%3C%3E). - < - 'less than'. It is URL-
# filters=gplus:num_total_members>0 # encoded (%3C). - <= - 'less than or equal to'. It is URL-encoded (%3C=). - > -
# The relational operators include: # 'greater than'. It is URL-encoded (%3E). - >= - 'greater than or equal to'. It
# - == - 'equal to'. # is URL-encoded (%3E=). Filters can only be applied to numeric parameters.
# - <> - 'not equal to'. It is URL-encoded (%3C%3E).
# - < - 'less than'. It is URL-encoded (%3C).
# - <= - 'less than or equal to'. It is URL-encoded (%3C=).
# - > - 'greater than'. It is URL-encoded (%3E).
# - >= - 'greater than or equal to'. It is URL-encoded (%3E=). Filters can only
# be applied to numeric parameters.
# @param [Fixnum] max_results # @param [Fixnum] max_results
# Determines how many activity records are shown on each response page. For # Determines how many activity records are shown on each response page. For
# example, if the request sets maxResults=1 and the report has two activities, # example, if the request sets maxResults=1 and the report has two activities,
@ -478,24 +439,20 @@ module Google
# The parameters query string is a comma-separated list of event parameters that # The parameters query string is a comma-separated list of event parameters that
# refine a report's results. The parameter is associated with a specific # refine a report's results. The parameter is associated with a specific
# application. The application values for the Entities usage report are only # application. The application values for the Entities usage report are only
# gplus. # gplus. A parameter query string is in the CSV form of [app_name1:param_name1],
# A parameter query string is in the CSV form of [app_name1:param_name1], [ # [app_name2:param_name2].... *Note:* The API doesn't accept multiple values of
# app_name2:param_name2].... # a parameter. If a particular parameter is supplied more than once in the API
# Note: The API doesn't accept multiple values of a parameter. If a particular # request, the API only accepts the last value of that request parameter. In
# parameter is supplied more than once in the API request, the API only accepts # addition, if an invalid request parameter is supplied in the API request, the
# the last value of that request parameter. # API ignores that request parameter and returns the response corresponding to
# In addition, if an invalid request parameter is supplied in the API request, # the remaining valid request parameters. An example of an invalid request
# the API ignores that request parameter and returns the response corresponding # parameter is one that does not belong to the application. If no parameters are
# to the remaining valid request parameters. # requested, all parameters are returned.
# An example of an invalid request parameter is one that does not belong to the
# application. If no parameters are requested, all parameters are returned.
# @param [String] fields # @param [String] fields
# Selector specifying which fields to include in a partial response. # Selector specifying which fields to include in a partial response.
# @param [String] quota_user # @param [String] quota_user
# An opaque string that represents a user for quota purposes. Must not exceed 40 # Available to use for quota purposes for server-side applications. Can be any
# characters. # arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [String] user_ip
# Deprecated. Please use quotaUser instead.
# @param [Google::Apis::RequestOptions] options # @param [Google::Apis::RequestOptions] options
# Request-specific options # Request-specific options
# #
@ -508,8 +465,8 @@ module Google
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required # @raise [Google::Apis::AuthorizationError] Authorization is required
def get_entity_usage_report(entity_type, entity_key, date, customer_id: nil, filters: nil, max_results: nil, page_token: nil, parameters: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) def get_entity_usage_report(entity_type, entity_key, date, customer_id: nil, filters: nil, max_results: nil, page_token: nil, parameters: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'usage/{entityType}/{entityKey}/dates/{date}', options) command = make_simple_command(:get, 'admin/reports/v1/usage/{entityType}/{entityKey}/dates/{date}', options)
command.response_representation = Google::Apis::AdminReportsV1::UsageReports::Representation command.response_representation = Google::Apis::AdminReportsV1::UsageReports::Representation
command.response_class = Google::Apis::AdminReportsV1::UsageReports command.response_class = Google::Apis::AdminReportsV1::UsageReports
command.params['entityType'] = entity_type unless entity_type.nil? command.params['entityType'] = entity_type unless entity_type.nil?
@ -522,7 +479,6 @@ module Google
command.query['parameters'] = parameters unless parameters.nil? command.query['parameters'] = parameters unless parameters.nil?
command.query['fields'] = fields unless fields.nil? command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['userIp'] = user_ip unless user_ip.nil?
execute_or_queue_command(command, &block) execute_or_queue_command(command, &block)
end end
@ -544,27 +500,21 @@ module Google
# parameters where the parameter's value is manipulated by a relational operator. # parameters where the parameter's value is manipulated by a relational operator.
# The filters query string includes the name of the application whose usage is # The filters query string includes the name of the application whose usage is
# returned in the report. The application values for the Users Usage Report # returned in the report. The application values for the Users Usage Report
# include accounts, docs, and gmail. # include accounts, docs, and gmail. Filters are in the form [application name]:
# Filters are in the form [application name]:[parameter name][relational # parameter name[parameter value],.... In this example, the <> 'not equal to'
# operator][parameter value],.... # operator is URL-encoded in the request's query string (%3C%3E): GET https://
# In this example, the <> 'not equal to' operator is URL-encoded in the request' # www.googleapis.com/admin/reports/v1/usage/users/all/dates/2013-03-03 ?
# s query string (%3C%3E): # parameters=accounts:last_login_time &filters=accounts:last_login_time>2010-10-
# GET https://www.googleapis.com/admin/reports/v1/usage/users/all/dates/2013-03- # 28T10:26:35.000Z The relational operators include: - == - 'equal to'. - <> - '
# 03 ?parameters=accounts:last_login_time &filters=accounts:last_login_time>2010- # not equal to'. It is URL-encoded (%3C%3E). - < - 'less than'. It is URL-
# 10-28T10:26:35.000Z # encoded (%3C). - <= - 'less than or equal to'. It is URL-encoded (%3C=). - > -
# The relational operators include: # 'greater than'. It is URL-encoded (%3E). - >= - 'greater than or equal to'. It
# - == - 'equal to'. # is URL-encoded (%3E=).
# - <> - 'not equal to'. It is URL-encoded (%3C%3E).
# - < - 'less than'. It is URL-encoded (%3C).
# - <= - 'less than or equal to'. It is URL-encoded (%3C=).
# - > - 'greater than'. It is URL-encoded (%3E).
# - >= - 'greater than or equal to'. It is URL-encoded (%3E=).
# @param [Fixnum] max_results # @param [Fixnum] max_results
# Determines how many activity records are shown on each response page. For # Determines how many activity records are shown on each response page. For
# example, if the request sets maxResults=1 and the report has two activities, # example, if the request sets maxResults=1 and the report has two activities,
# the report has two pages. The response's nextPageToken property has the token # the report has two pages. The response's nextPageToken property has the token
# to the second page. # to the second page. The maxResults query string is optional.
# The maxResults query string is optional.
# @param [String] org_unit_id # @param [String] org_unit_id
# ID of the organizational unit to report on. User activity will be shown only # ID of the organizational unit to report on. User activity will be shown only
# for users who belong to the specified organizational unit. Data before Dec 17, # for users who belong to the specified organizational unit. Data before Dec 17,
@ -578,24 +528,20 @@ module Google
# refine a report's results. The parameter is associated with a specific # refine a report's results. The parameter is associated with a specific
# application. The application values for the Customers usage report include # application. The application values for the Customers usage report include
# accounts, app_maker, apps_scripts, calendar, classroom, cros, docs, gmail, # accounts, app_maker, apps_scripts, calendar, classroom, cros, docs, gmail,
# gplus, device_management, meet, and sites. # gplus, device_management, meet, and sites. A parameters query string is in the
# A parameters query string is in the CSV form of app_name1:param_name1, # CSV form of app_name1:param_name1, app_name2:param_name2. *Note:* The API
# app_name2:param_name2. # doesn't accept multiple values of a parameter. If a particular parameter is
# Note: The API doesn't accept multiple values of a parameter. # supplied more than once in the API request, the API only accepts the last
# If a particular parameter is supplied more than once in the API request, the # value of that request parameter. In addition, if an invalid request parameter
# API only accepts the last value of that request parameter. In addition, if an # is supplied in the API request, the API ignores that request parameter and
# invalid request parameter is supplied in the API request, the API ignores that # returns the response corresponding to the remaining valid request parameters.
# request parameter and returns the response corresponding to the remaining
# valid request parameters.
# An example of an invalid request parameter is one that does not belong to the # An example of an invalid request parameter is one that does not belong to the
# application. If no parameters are requested, all parameters are returned. # application. If no parameters are requested, all parameters are returned.
# @param [String] fields # @param [String] fields
# Selector specifying which fields to include in a partial response. # Selector specifying which fields to include in a partial response.
# @param [String] quota_user # @param [String] quota_user
# An opaque string that represents a user for quota purposes. Must not exceed 40 # Available to use for quota purposes for server-side applications. Can be any
# characters. # arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [String] user_ip
# Deprecated. Please use quotaUser instead.
# @param [Google::Apis::RequestOptions] options # @param [Google::Apis::RequestOptions] options
# Request-specific options # Request-specific options
# #
@ -608,8 +554,8 @@ module Google
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required # @raise [Google::Apis::AuthorizationError] Authorization is required
def get_user_usage_report(user_key, date, customer_id: nil, filters: nil, max_results: nil, org_unit_id: nil, page_token: nil, parameters: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) def get_user_usage_report(user_key, date, customer_id: nil, filters: nil, max_results: nil, org_unit_id: nil, page_token: nil, parameters: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'usage/users/{userKey}/dates/{date}', options) command = make_simple_command(:get, 'admin/reports/v1/usage/users/{userKey}/dates/{date}', options)
command.response_representation = Google::Apis::AdminReportsV1::UsageReports::Representation command.response_representation = Google::Apis::AdminReportsV1::UsageReports::Representation
command.response_class = Google::Apis::AdminReportsV1::UsageReports command.response_class = Google::Apis::AdminReportsV1::UsageReports
command.params['userKey'] = user_key unless user_key.nil? command.params['userKey'] = user_key unless user_key.nil?
@ -622,7 +568,6 @@ module Google
command.query['parameters'] = parameters unless parameters.nil? command.query['parameters'] = parameters unless parameters.nil?
command.query['fields'] = fields unless fields.nil? command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['userIp'] = user_ip unless user_ip.nil?
execute_or_queue_command(command, &block) execute_or_queue_command(command, &block)
end end
@ -631,7 +576,6 @@ module Google
def apply_command_defaults(command) def apply_command_defaults(command)
command.query['key'] = key unless key.nil? command.query['key'] = key unless key.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['userIp'] = user_ip unless user_ip.nil?
end end
end end
end end

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

@ -26,7 +26,7 @@ module Google
# @see https://developers.google.com/android/management # @see https://developers.google.com/android/management
module AndroidmanagementV1 module AndroidmanagementV1
VERSION = 'V1' VERSION = 'V1'
REVISION = '20200803' REVISION = '20200807'
# Manage Android devices and apps for your customers # Manage Android devices and apps for your customers
AUTH_ANDROIDMANAGEMENT = 'https://www.googleapis.com/auth/androidmanagement' AUTH_ANDROIDMANAGEMENT = 'https://www.googleapis.com/auth/androidmanagement'

95
generated/google/apis/androidmanagement_v1/classes.rb
View File

@ -234,6 +234,12 @@ module Google
# @return [Array<String>] # @return [Array<String>]
attr_accessor :accessible_track_ids attr_accessor :accessible_track_ids
# Controls whether the app can communicate with itself across a device’s work
# and personal profiles, subject to user consent.
# Corresponds to the JSON property `connectedWorkAndPersonalApp`
# @return [String]
attr_accessor :connected_work_and_personal_app
# The default policy for all permissions requested by the app. If specified, # The default policy for all permissions requested by the app. If specified,
# this overrides the policy-level default_permission_policy which applies to all # this overrides the policy-level default_permission_policy which applies to all
# apps. It does not override the permission_grants which applies to all apps. # apps. It does not override the permission_grants which applies to all apps.
@ -268,13 +274,9 @@ module Google
# Managed configuration applied to the app. The format for the configuration is # Managed configuration applied to the app. The format for the configuration is
# dictated by the ManagedProperty values supported by the app. Each field name # dictated by the ManagedProperty values supported by the app. Each field name
# in the managed configuration must match the key field of the ManagedProperty. # in the managed configuration must match the key field of the ManagedProperty.
# The field value must be compatible with the type of the ManagedProperty: < # The field value must be compatible with the type of the ManagedProperty: *type*
# table> <tr><td><i>type</i></td><td><i>JSON value</i></td></tr> <tr><td>BOOL</ # *JSON value* BOOL true or false STRING string INTEGER number CHOICE string
# td><td>true or false</td></tr> <tr><td>STRING</td><td>string</td></tr> <tr><td> # MULTISELECT array of strings HIDDEN string BUNDLE_ARRAY array of objects
# INTEGER</td><td>number</td></tr> <tr><td>CHOICE</td><td>string</td></tr> <tr><
# td>MULTISELECT</td><td>array of strings</td></tr> <tr><td>HIDDEN</td><td>
# string</td></tr> <tr><td>BUNDLE_ARRAY</td><td>array of objects</td></tr> </
# table>
# Corresponds to the JSON property `managedConfiguration` # Corresponds to the JSON property `managedConfiguration`
# @return [Hash<String,Object>] # @return [Hash<String,Object>]
attr_accessor :managed_configuration attr_accessor :managed_configuration
@ -314,6 +316,7 @@ module Google
# Update properties of this object # Update properties of this object
def update!(**args) def update!(**args)
@accessible_track_ids = args[:accessible_track_ids] if args.key?(:accessible_track_ids) @accessible_track_ids = args[:accessible_track_ids] if args.key?(:accessible_track_ids)
@connected_work_and_personal_app = args[:connected_work_and_personal_app] if args.key?(:connected_work_and_personal_app)
@default_permission_policy = args[:default_permission_policy] if args.key?(:default_permission_policy) @default_permission_policy = args[:default_permission_policy] if args.key?(:default_permission_policy)
@delegated_scopes = args[:delegated_scopes] if args.key?(:delegated_scopes) @delegated_scopes = args[:delegated_scopes] if args.key?(:delegated_scopes)
@disabled = args[:disabled] if args.key?(:disabled) @disabled = args[:disabled] if args.key?(:disabled)
@ -617,11 +620,10 @@ module Google
# Represents a whole or partial calendar date, e.g. a birthday. The time of day # Represents a whole or partial calendar date, e.g. a birthday. The time of day
# and time zone are either specified elsewhere or are not significant. The date # and time zone are either specified elsewhere or are not significant. The date
# is relative to the Proleptic Gregorian Calendar. This can represent: # is relative to the Proleptic Gregorian Calendar. This can represent: A full
# A full date, with non-zero year, month and day values # date, with non-zero year, month and day values A month and day value, with a
# A month and day value, with a zero year, e.g. an anniversary # zero year, e.g. an anniversary A year on its own, with zero month and day
# A year on its own, with zero month and day values # values A year and month value, with a zero day, e.g. a credit card expiration
# A year and month value, with a zero day, e.g. a credit card expiration
# dateRelated types are google.type.TimeOfDay and google.protobuf.Timestamp. # dateRelated types are google.type.TimeOfDay and google.protobuf.Timestamp.
class Date class Date
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
@ -1018,11 +1020,9 @@ module Google
# A generic empty message that you can re-use to avoid defining duplicated empty # 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 # messages in your APIs. A typical example is to use it as the request or the
# response type of an API method. For instance: # response type of an API method. For instance: service Foo ` rpc Bar(google.
# service Foo ` # protobuf.Empty) returns (google.protobuf.Empty); ` The JSON representation for
# rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); # Empty is empty JSON object ``.
# `
# The JSON representation for Empty is empty JSON object ``.
class Empty class Empty
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
@ -1248,11 +1248,10 @@ module Google
# Represents a whole or partial calendar date, e.g. a birthday. The time of day # Represents a whole or partial calendar date, e.g. a birthday. The time of day
# and time zone are either specified elsewhere or are not significant. The date # and time zone are either specified elsewhere or are not significant. The date
# is relative to the Proleptic Gregorian Calendar. This can represent: # is relative to the Proleptic Gregorian Calendar. This can represent: A full
# A full date, with non-zero year, month and day values # date, with non-zero year, month and day values A month and day value, with a
# A month and day value, with a zero year, e.g. an anniversary # zero year, e.g. an anniversary A year on its own, with zero month and day
# A year on its own, with zero month and day values # values A year and month value, with a zero day, e.g. a credit card expiration
# A year and month value, with a zero day, e.g. a credit card expiration
# dateRelated types are google.type.TimeOfDay and google.protobuf.Timestamp. # dateRelated types are google.type.TimeOfDay and google.protobuf.Timestamp.
# Corresponds to the JSON property `endDate` # Corresponds to the JSON property `endDate`
# @return [Google::Apis::AndroidmanagementV1::Date] # @return [Google::Apis::AndroidmanagementV1::Date]
@ -1260,11 +1259,10 @@ module Google
# Represents a whole or partial calendar date, e.g. a birthday. The time of day # Represents a whole or partial calendar date, e.g. a birthday. The time of day
# and time zone are either specified elsewhere or are not significant. The date # and time zone are either specified elsewhere or are not significant. The date
# is relative to the Proleptic Gregorian Calendar. This can represent: # is relative to the Proleptic Gregorian Calendar. This can represent: A full
# A full date, with non-zero year, month and day values # date, with non-zero year, month and day values A month and day value, with a
# A month and day value, with a zero year, e.g. an anniversary # zero year, e.g. an anniversary A year on its own, with zero month and day
# A year on its own, with zero month and day values # values A year and month value, with a zero day, e.g. a credit card expiration
# A year and month value, with a zero day, e.g. a credit card expiration
# dateRelated types are google.type.TimeOfDay and google.protobuf.Timestamp. # dateRelated types are google.type.TimeOfDay and google.protobuf.Timestamp.
# Corresponds to the JSON property `startDate` # Corresponds to the JSON property `startDate`
# @return [Google::Apis::AndroidmanagementV1::Date] # @return [Google::Apis::AndroidmanagementV1::Date]
@ -1669,8 +1667,8 @@ module Google
class ManagedConfigurationTemplate class ManagedConfigurationTemplate
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
# Optional, a map containing <key, value> configuration variables defined for # Optional, a map containing configuration variables defined for the
# the configuration. # configuration.
# Corresponds to the JSON property `configurationVariables` # Corresponds to the JSON property `configurationVariables`
# @return [Hash<String,String>] # @return [Hash<String,String>]
attr_accessor :configuration_variables attr_accessor :configuration_variables
@ -3098,13 +3096,12 @@ module Google
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
# Controls whether personal usage is allowed on a device provisioned with this # Controls whether personal usage is allowed on a device provisioned with this
# enrollment token.For company-owned devices: # enrollment token.For company-owned devices: Enabling personal usage allows the
# Enabling personal usage allows the user to set up a work profile on the device. # user to set up a work profile on the device. Disabling personal usage requires
# Disabling personal usage requires the user provision the device as a fully # the user provision the device as a fully managed device.For personally-owned
# managed device.For personally-owned devices: # devices: Enabling personal usage allows the user to set up a work profile on
# Enabling personal usage allows the user to set up a work profile on the device. # the device. Disabling personal usage will prevent the device from provisioning.
# Disabling personal usage will prevent the device from provisioning. Personal # Personal usage cannot be disabled on personally-owned device.
# usage cannot be disabled on personally-owned device.
# Corresponds to the JSON property `allowPersonalUsage` # Corresponds to the JSON property `allowPersonalUsage`
# @return [String] # @return [String]
attr_accessor :allow_personal_usage attr_accessor :allow_personal_usage
@ -3125,9 +3122,9 @@ module Google
# Sign-in URL for authentication when device is provisioned with a sign-in # Sign-in URL for authentication when device is provisioned with a sign-in
# enrollment token. The sign-in endpoint should finish authentication flow with # enrollment token. The sign-in endpoint should finish authentication flow with
# a URL in the form of https://enterprise.google.com/android/enroll?et=<token> # a URL in the form of https://enterprise.google.com/android/enroll?et= for a
# for a successful login, or https://enterprise.google.com/android/enroll/ # successful login, or https://enterprise.google.com/android/enroll/invalid for
# invalid for a failed login. # a failed login.
# Corresponds to the JSON property `signinUrl` # Corresponds to the JSON property `signinUrl`
# @return [String] # @return [String]
attr_accessor :signin_url attr_accessor :signin_url
@ -3482,9 +3479,9 @@ module Google
# @return [String] # @return [String]
attr_accessor :default_message attr_accessor :default_message
# A map containing <locale, message> pairs, where locale is a well-formed BCP 47 # A map containing pairs, where locale is a well-formed BCP 47 language (https://
# language (https://www.w3.org/International/articles/language-tags/) code, such # www.w3.org/International/articles/language-tags/) code, such as en-US, es-ES,
# as en-US, es-ES, or fr. # or fr.
# Corresponds to the JSON property `localizedMessages` # Corresponds to the JSON property `localizedMessages`
# @return [Hash<String,String>] # @return [Hash<String,String>]
attr_accessor :localized_messages attr_accessor :localized_messages
@ -3559,9 +3556,9 @@ module Google
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
# The actual bytes of the image in a base64url encoded string (c.f. RFC4648, # The actual bytes of the image in a base64url encoded string (c.f. RFC4648,
# section 5 "Base 64 Encoding with URL and Filename Safe Alphabet"). <ul> <li> # section 5 "Base 64 Encoding with URL and Filename Safe Alphabet"). - The image
# The image type can be png or jpg. <li>The image should ideally be square. <li> # type can be png or jpg. - The image should ideally be square. - The image
# The image should ideally have a size of 512x512. </ul> # should ideally have a size of 512x512.
# Corresponds to the JSON property `imageData` # Corresponds to the JSON property `imageData`
# @return [String] # @return [String]
attr_accessor :image_data attr_accessor :image_data
@ -3582,10 +3579,10 @@ module Google
# The features to enable. Use this if you want to control exactly which feature( # The features to enable. Use this if you want to control exactly which feature(
# s) will be activated; leave empty to allow all features.Restrictions / things # s) will be activated; leave empty to allow all features.Restrictions / things
# to note: <ul> <li> If no features are listed here, all features are enabled — # to note: - If no features are listed here, all features are enabled — this is
# this is the default behavior where you give access to all features to your # the default behavior where you give access to all features to your admins. -
# admins. <li> This must not contain any FEATURE_UNSPECIFIED values. <li> # This must not contain any FEATURE_UNSPECIFIED values. - Repeated values are
# Repeated values are ignored </ul> # ignored
# Corresponds to the JSON property `enabledFeatures` # Corresponds to the JSON property `enabledFeatures`
# @return [Array<String>] # @return [Array<String>]
attr_accessor :enabled_features attr_accessor :enabled_features

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

@ -489,6 +489,7 @@ module Google
# @private # @private
class Representation < Google::Apis::Core::JsonRepresentation class Representation < Google::Apis::Core::JsonRepresentation
collection :accessible_track_ids, as: 'accessibleTrackIds' collection :accessible_track_ids, as: 'accessibleTrackIds'
property :connected_work_and_personal_app, as: 'connectedWorkAndPersonalApp'
property :default_permission_policy, as: 'defaultPermissionPolicy' property :default_permission_policy, as: 'defaultPermissionPolicy'
collection :delegated_scopes, as: 'delegatedScopes' collection :delegated_scopes, as: 'delegatedScopes'
property :disabled, as: 'disabled' property :disabled, as: 'disabled'

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

@ -26,7 +26,7 @@ module Google
# @see https://cloud.google.com/error-reporting/ # @see https://cloud.google.com/error-reporting/
module ClouderrorreportingV1beta1 module ClouderrorreportingV1beta1
VERSION = 'V1beta1' VERSION = 'V1beta1'
REVISION = '20200723' REVISION = '20200806'
# View and manage your data across Google Cloud Platform services # View and manage your data across Google Cloud Platform services
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'

283
generated/google/apis/clouderrorreporting_v1beta1/classes.rb
View File

@ -35,43 +35,39 @@ module Google
end end
end end
# A description of the context in which an error occurred. # A description of the context in which an error occurred. This data should be
# This data should be provided by the application when reporting an error, # provided by the application when reporting an error, unless the error report
# unless the # has been generated automatically from Google App Engine logs.
# error report has been generated automatically from Google App Engine logs.
class ErrorContext class ErrorContext
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
# HTTP request data that is related to a reported error. # HTTP request data that is related to a reported error. This data should be
# This data should be provided by the application when reporting an error, # provided by the application when reporting an error, unless the error report
# unless the # has been generated automatically from Google App Engine logs.
# error report has been generated automatically from Google App Engine logs.
# Corresponds to the JSON property `httpRequest` # Corresponds to the JSON property `httpRequest`
# @return [Google::Apis::ClouderrorreportingV1beta1::HttpRequestContext] # @return [Google::Apis::ClouderrorreportingV1beta1::HttpRequestContext]
attr_accessor :http_request attr_accessor :http_request
# Indicates a location in the source code of the service for which errors are # Indicates a location in the source code of the service for which errors are
# reported. `functionName` must be provided by the application when reporting # reported. `functionName` must be provided by the application when reporting an
# an error, unless the error report contains a `message` with a supported # error, unless the error report contains a `message` with a supported exception
# exception stack trace. All fields are optional for the later case. # stack trace. All fields are optional for the later case.
# Corresponds to the JSON property `reportLocation` # Corresponds to the JSON property `reportLocation`
# @return [Google::Apis::ClouderrorreportingV1beta1::SourceLocation] # @return [Google::Apis::ClouderrorreportingV1beta1::SourceLocation]
attr_accessor :report_location attr_accessor :report_location
# Source code that was used to build the executable which has # Source code that was used to build the executable which has caused the given
# caused the given error message. # error message.
# Corresponds to the JSON property `sourceReferences` # Corresponds to the JSON property `sourceReferences`
# @return [Array<Google::Apis::ClouderrorreportingV1beta1::SourceReference>] # @return [Array<Google::Apis::ClouderrorreportingV1beta1::SourceReference>]
attr_accessor :source_references attr_accessor :source_references
# The user who caused or was affected by the crash. # The user who caused or was affected by the crash. This can be a user ID, an
# This can be a user ID, an email address, or an arbitrary token that # email address, or an arbitrary token that uniquely identifies the user. When
# uniquely identifies the user. # sending an error report, leave this field empty if the user was not logged in.
# When sending an error report, leave this field empty if the user was not # In this case the Error Reporting system will use other data, such as remote IP
# logged in. In this case the # address, to distinguish affected users. See `affected_users_count` in `
# Error Reporting system will use other data, such as remote IP address, to # ErrorGroupStats`.
# distinguish affected users. See `affected_users_count` in
# `ErrorGroupStats`.
# Corresponds to the JSON property `user` # Corresponds to the JSON property `user`
# @return [String] # @return [String]
attr_accessor :user attr_accessor :user
@ -93,17 +89,16 @@ module Google
class ErrorEvent class ErrorEvent
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
# A description of the context in which an error occurred. # A description of the context in which an error occurred. This data should be
# This data should be provided by the application when reporting an error, # provided by the application when reporting an error, unless the error report
# unless the # has been generated automatically from Google App Engine logs.
# error report has been generated automatically from Google App Engine logs.
# Corresponds to the JSON property `context` # Corresponds to the JSON property `context`
# @return [Google::Apis::ClouderrorreportingV1beta1::ErrorContext] # @return [Google::Apis::ClouderrorreportingV1beta1::ErrorContext]
attr_accessor :context attr_accessor :context
# Time when the event occurred as provided in the error report. # Time when the event occurred as provided in the error report. If the report
# If the report did not contain a timestamp, the time the error was received # did not contain a timestamp, the time the error was received by the Error
# by the Error Reporting system is used. # Reporting system is used.
# Corresponds to the JSON property `eventTime` # Corresponds to the JSON property `eventTime`
# @return [String] # @return [String]
attr_accessor :event_time attr_accessor :event_time
@ -113,8 +108,8 @@ module Google
# @return [String] # @return [String]
attr_accessor :message attr_accessor :message
# Describes a running service that sends errors. # Describes a running service that sends errors. Its version changes over time
# Its version changes over time and multiple versions can run in parallel. # and multiple versions can run in parallel.
# Corresponds to the JSON property `serviceContext` # Corresponds to the JSON property `serviceContext`
# @return [Google::Apis::ClouderrorreportingV1beta1::ServiceContext] # @return [Google::Apis::ClouderrorreportingV1beta1::ServiceContext]
attr_accessor :service_context attr_accessor :service_context
@ -136,20 +131,20 @@ module Google
class ErrorGroup class ErrorGroup
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
# Group IDs are unique for a given project. If the same kind of error # Group IDs are unique for a given project. If the same kind of error occurs in
# occurs in different service contexts, it will receive the same group ID. # different service contexts, it will receive the same group ID.
# Corresponds to the JSON property `groupId` # Corresponds to the JSON property `groupId`
# @return [String] # @return [String]
attr_accessor :group_id attr_accessor :group_id
# The group resource name. # The group resource name. Example: projects/my-project-123/groups/
# Example: <code>projects/my-project-123/groups/CNSgkpnppqKCUw</code> # CNSgkpnppqKCUw
# Corresponds to the JSON property `name` # Corresponds to the JSON property `name`
# @return [String] # @return [String]
attr_accessor :name attr_accessor :name
# Error group's resolution status. # Error group's resolution status. An unspecified resolution status will be
# An unspecified resolution status will be interpreted as OPEN # interpreted as OPEN
# Corresponds to the JSON property `resolutionStatus` # Corresponds to the JSON property `resolutionStatus`
# @return [String] # @return [String]
attr_accessor :resolution_status attr_accessor :resolution_status
@ -172,43 +167,39 @@ module Google
end end
end end
# Data extracted for a specific group based on certain filter criteria, # Data extracted for a specific group based on certain filter criteria, such as
# such as a given time period and/or service filter. # a given time period and/or service filter.
class ErrorGroupStats class ErrorGroupStats
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
# Service contexts with a non-zero error count for the given filter # Service contexts with a non-zero error count for the given filter criteria.
# criteria. This list can be truncated if multiple services are affected. # This list can be truncated if multiple services are affected. Refer to `
# Refer to `num_affected_services` for the total count. # num_affected_services` for the total count.
# Corresponds to the JSON property `affectedServices` # Corresponds to the JSON property `affectedServices`
# @return [Array<Google::Apis::ClouderrorreportingV1beta1::ServiceContext>] # @return [Array<Google::Apis::ClouderrorreportingV1beta1::ServiceContext>]
attr_accessor :affected_services attr_accessor :affected_services
# Approximate number of affected users in the given group that # Approximate number of affected users in the given group that match the filter
# match the filter criteria. # criteria. Users are distinguished by data in the `ErrorContext` of the
# Users are distinguished by data in the `ErrorContext` of the # individual error events, such as their login name or their remote IP address
# individual error events, such as their login name or their remote # in case of HTTP requests. The number of affected users can be zero even if the
# IP address in case of HTTP requests. # number of errors is non-zero if no data was provided from which the affected
# The number of affected users can be zero even if the number of # user could be deduced. Users are counted based on data in the request context
# errors is non-zero if no data was provided from which the # that was provided in the error report. If more users are implicitly affected,
# affected user could be deduced. # such as due to a crash of the whole service, this is not reflected here.
# Users are counted based on data in the request
# context that was provided in the error report. If more users are
# implicitly affected, such as due to a crash of the whole service,
# this is not reflected here.
# Corresponds to the JSON property `affectedUsersCount` # Corresponds to the JSON property `affectedUsersCount`
# @return [Fixnum] # @return [Fixnum]
attr_accessor :affected_users_count attr_accessor :affected_users_count
# Approximate total number of events in the given group that match # Approximate total number of events in the given group that match the filter
# the filter criteria. # criteria.
# Corresponds to the JSON property `count` # Corresponds to the JSON property `count`
# @return [Fixnum] # @return [Fixnum]
attr_accessor :count attr_accessor :count
# Approximate first occurrence that was ever seen for this group # Approximate first occurrence that was ever seen for this group and which
# and which matches the given filter criteria, ignoring the # matches the given filter criteria, ignoring the time_range that was specified
# time_range that was specified in the request. # in the request.
# Corresponds to the JSON property `firstSeenTime` # Corresponds to the JSON property `firstSeenTime`
# @return [String] # @return [String]
attr_accessor :first_seen_time attr_accessor :first_seen_time
@ -218,15 +209,15 @@ module Google
# @return [Google::Apis::ClouderrorreportingV1beta1::ErrorGroup] # @return [Google::Apis::ClouderrorreportingV1beta1::ErrorGroup]
attr_accessor :group attr_accessor :group
# Approximate last occurrence that was ever seen for this group and # Approximate last occurrence that was ever seen for this group and which
# which matches the given filter criteria, ignoring the time_range # matches the given filter criteria, ignoring the time_range that was specified
# that was specified in the request. # in the request.
# Corresponds to the JSON property `lastSeenTime` # Corresponds to the JSON property `lastSeenTime`
# @return [String] # @return [String]
attr_accessor :last_seen_time attr_accessor :last_seen_time
# The total number of services with a non-zero error count for the given # The total number of services with a non-zero error count for the given filter
# filter criteria. # criteria.
# Corresponds to the JSON property `numAffectedServices` # Corresponds to the JSON property `numAffectedServices`
# @return [Fixnum] # @return [Fixnum]
attr_accessor :num_affected_services attr_accessor :num_affected_services
@ -236,11 +227,9 @@ module Google
# @return [Google::Apis::ClouderrorreportingV1beta1::ErrorEvent] # @return [Google::Apis::ClouderrorreportingV1beta1::ErrorEvent]
attr_accessor :representative attr_accessor :representative
# Approximate number of occurrences over time. # Approximate number of occurrences over time. Timed counts returned by
# Timed counts returned by ListGroups are guaranteed to be: # ListGroups are guaranteed to be: - Inside the requested time interval - Non-
# - Inside the requested time interval # overlapping, and - Ordered by ascending time.
# - Non-overlapping, and
# - Ordered by ascending time.
# Corresponds to the JSON property `timedCounts` # Corresponds to the JSON property `timedCounts`
# @return [Array<Google::Apis::ClouderrorreportingV1beta1::TimedCount>] # @return [Array<Google::Apis::ClouderrorreportingV1beta1::TimedCount>]
attr_accessor :timed_counts attr_accessor :timed_counts
@ -263,10 +252,9 @@ module Google
end end
end end
# HTTP request data that is related to a reported error. # HTTP request data that is related to a reported error. This data should be
# This data should be provided by the application when reporting an error, # provided by the application when reporting an error, unless the error report
# unless the # has been generated automatically from Google App Engine logs.
# error report has been generated automatically from Google App Engine logs.
class HttpRequestContext class HttpRequestContext
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
@ -280,10 +268,9 @@ module Google
# @return [String] # @return [String]
attr_accessor :referrer attr_accessor :referrer
# The IP address from which the request originated. # The IP address from which the request originated. This can be IPv4, IPv6, or a
# This can be IPv4, IPv6, or a token which is derived from the # token which is derived from the IP address, depending on the data that has
# IP address, depending on the data that has been provided # been provided in the error report.
# in the error report.
# Corresponds to the JSON property `remoteIp` # Corresponds to the JSON property `remoteIp`
# @return [String] # @return [String]
attr_accessor :remote_ip attr_accessor :remote_ip
@ -327,9 +314,8 @@ module Google
# @return [Array<Google::Apis::ClouderrorreportingV1beta1::ErrorEvent>] # @return [Array<Google::Apis::ClouderrorreportingV1beta1::ErrorEvent>]
attr_accessor :error_events attr_accessor :error_events
# If non-empty, more results are available. # If non-empty, more results are available. Pass this token, along with the same
# Pass this token, along with the same query parameters as the first # query parameters as the first request, to view the next page of results.
# request, to view the next page of results.
# Corresponds to the JSON property `nextPageToken` # Corresponds to the JSON property `nextPageToken`
# @return [String] # @return [String]
attr_accessor :next_page_token attr_accessor :next_page_token
@ -360,17 +346,16 @@ module Google
# @return [Array<Google::Apis::ClouderrorreportingV1beta1::ErrorGroupStats>] # @return [Array<Google::Apis::ClouderrorreportingV1beta1::ErrorGroupStats>]
attr_accessor :error_group_stats attr_accessor :error_group_stats
# If non-empty, more results are available. # If non-empty, more results are available. Pass this token, along with the same
# Pass this token, along with the same query parameters as the first # query parameters as the first request, to view the next page of results.
# request, to view the next page of results.
# Corresponds to the JSON property `nextPageToken` # Corresponds to the JSON property `nextPageToken`
# @return [String] # @return [String]
attr_accessor :next_page_token attr_accessor :next_page_token
# The timestamp specifies the start time to which the request was restricted. # The timestamp specifies the start time to which the request was restricted.
# The start time is set based on the requested time range. It may be adjusted # The start time is set based on the requested time range. It may be adjusted to
# to a later time if a project has exceeded the storage quota and older data # a later time if a project has exceeded the storage quota and older data has
# has been deleted. # been deleted.
# Corresponds to the JSON property `timeRangeBegin` # Corresponds to the JSON property `timeRangeBegin`
# @return [String] # @return [String]
attr_accessor :time_range_begin attr_accessor :time_range_begin
@ -387,8 +372,8 @@ module Google
end end
end end
# Response for reporting an individual error event. # Response for reporting an individual error event. Data may be added to this
# Data may be added to this message in the future. # message in the future.
class ReportErrorEventResponse class ReportErrorEventResponse
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
@ -405,54 +390,43 @@ module Google
class ReportedErrorEvent class ReportedErrorEvent
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
# A description of the context in which an error occurred. # A description of the context in which an error occurred. This data should be
# This data should be provided by the application when reporting an error, # provided by the application when reporting an error, unless the error report
# unless the # has been generated automatically from Google App Engine logs.
# error report has been generated automatically from Google App Engine logs.
# Corresponds to the JSON property `context` # Corresponds to the JSON property `context`
# @return [Google::Apis::ClouderrorreportingV1beta1::ErrorContext] # @return [Google::Apis::ClouderrorreportingV1beta1::ErrorContext]
attr_accessor :context attr_accessor :context
# Optional. Time when the event occurred. # Optional. Time when the event occurred. If not provided, the time when the
# If not provided, the time when the event was received by the # event was received by the Error Reporting system will be used.
# Error Reporting system will be used.
# Corresponds to the JSON property `eventTime` # Corresponds to the JSON property `eventTime`
# @return [String] # @return [String]
attr_accessor :event_time attr_accessor :event_time
# Required. The error message. # Required. The error message. If no `context.reportLocation` is provided, the
# If no `context.reportLocation` is provided, the message must contain a # message must contain a header (typically consisting of the exception type name
# header (typically consisting of the exception type name and an error # and an error message) and an exception stack trace in one of the supported
# message) and an exception stack trace in one of the supported programming # programming languages and formats. Supported languages are Java, Python,
# languages and formats. # JavaScript, Ruby, C#, PHP, and Go. Supported stack trace formats are: * **Java*
# Supported languages are Java, Python, JavaScript, Ruby, C#, PHP, and Go. # *: Must be the return value of [`Throwable.printStackTrace()`](https://docs.
# Supported stack trace formats are: # oracle.com/javase/7/docs/api/java/lang/Throwable.html#printStackTrace%28%29). *
# * **Java**: Must be the return value of # **Python**: Must be the return value of [`traceback.format_exc()`](https://
# [`Throwable.printStackTrace()`](https://docs.oracle.com/javase/7/docs/api/java/ # docs.python.org/2/library/traceback.html#traceback.format_exc). * **JavaScript*
# lang/Throwable.html#printStackTrace%28%29). # *: Must be the value of [`error.stack`](https://github.com/v8/v8/wiki/Stack-
# * **Python**: Must be the return value of # Trace-API) as returned by V8. * **Ruby**: Must contain frames returned by [`
# [`traceback.format_exc()`](https://docs.python.org/2/library/traceback.html# # Exception.backtrace`](https://ruby-doc.org/core-2.2.0/Exception.html#method-i-
# traceback.format_exc). # backtrace). * **C#**: Must be the return value of [`Exception.ToString()`](
# * **JavaScript**: Must be the value of # https://msdn.microsoft.com/en-us/library/system.exception.tostring.aspx). * **
# [`error.stack`](https://github.com/v8/v8/wiki/Stack-Trace-API) as returned # PHP**: Must start with `PHP (Notice|Parse error|Fatal error|Warning)` and
# by V8. # contain the result of [`(string)$exception`](http://php.net/manual/en/
# * **Ruby**: Must contain frames returned by # exception.tostring.php). * **Go**: Must be the return value of [`runtime.Stack(
# [`Exception.backtrace`](https://ruby-doc.org/core-2.2.0/Exception.html#method- # )`](https://golang.org/pkg/runtime/debug/#Stack).
# i-backtrace).
# * **C#**: Must be the return value of
# [`Exception.ToString()`](https://msdn.microsoft.com/en-us/library/system.
# exception.tostring.aspx).
# * **PHP**: Must start with `PHP (Notice|Parse error|Fatal error|Warning)`
# and contain the result of
# [`(string)$exception`](http://php.net/manual/en/exception.tostring.php).
# * **Go**: Must be the return value of
# [`runtime.Stack()`](https://golang.org/pkg/runtime/debug/#Stack).
# Corresponds to the JSON property `message` # Corresponds to the JSON property `message`
# @return [String] # @return [String]
attr_accessor :message attr_accessor :message
# Describes a running service that sends errors. # Describes a running service that sends errors. Its version changes over time
# Its version changes over time and multiple versions can run in parallel. # and multiple versions can run in parallel.
# Corresponds to the JSON property `serviceContext` # Corresponds to the JSON property `serviceContext`
# @return [Google::Apis::ClouderrorreportingV1beta1::ServiceContext] # @return [Google::Apis::ClouderrorreportingV1beta1::ServiceContext]
attr_accessor :service_context attr_accessor :service_context
@ -470,33 +444,31 @@ module Google
end end
end end
# Describes a running service that sends errors. # Describes a running service that sends errors. Its version changes over time
# Its version changes over time and multiple versions can run in parallel. # and multiple versions can run in parallel.
class ServiceContext class ServiceContext
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
# Type of the MonitoredResource. List of possible values: # Type of the MonitoredResource. List of possible values: https://cloud.google.
# https://cloud.google.com/monitoring/api/resources # com/monitoring/api/resources Value is set automatically for incoming errors
# Value is set automatically for incoming errors and must not be set when # and must not be set when reporting errors.
# reporting errors.
# Corresponds to the JSON property `resourceType` # Corresponds to the JSON property `resourceType`
# @return [String] # @return [String]
attr_accessor :resource_type attr_accessor :resource_type
# An identifier of the service, such as the name of the # An identifier of the service, such as the name of the executable, job, or
# executable, job, or Google App Engine service name. This field is expected # Google App Engine service name. This field is expected to have a low number of
# to have a low number of values that are relatively stable over time, as # values that are relatively stable over time, as opposed to `version`, which
# opposed to `version`, which can be changed whenever new code is deployed. # can be changed whenever new code is deployed. Contains the service name for
# Contains the service name for error reports extracted from Google # error reports extracted from Google App Engine logs or `default` if the App
# App Engine logs or `default` if the App Engine default service is used. # Engine default service is used.
# Corresponds to the JSON property `service` # Corresponds to the JSON property `service`
# @return [String] # @return [String]
attr_accessor :service attr_accessor :service
# Represents the source code version that the developer provided, # Represents the source code version that the developer provided, which could
# which could represent a version label or a Git SHA-1 hash, for example. # represent a version label or a Git SHA-1 hash, for example. For App Engine
# For App Engine standard environment, the version is set to the version of # standard environment, the version is set to the version of the app.
# the app.
# Corresponds to the JSON property `version` # Corresponds to the JSON property `version`
# @return [String] # @return [String]
attr_accessor :version attr_accessor :version
@ -514,21 +486,21 @@ module Google
end end
# Indicates a location in the source code of the service for which errors are # Indicates a location in the source code of the service for which errors are
# reported. `functionName` must be provided by the application when reporting # reported. `functionName` must be provided by the application when reporting an
# an error, unless the error report contains a `message` with a supported # error, unless the error report contains a `message` with a supported exception
# exception stack trace. All fields are optional for the later case. # stack trace. All fields are optional for the later case.
class SourceLocation class SourceLocation
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
# The source code filename, which can include a truncated relative # The source code filename, which can include a truncated relative path, or a
# path, or a full path from a production machine. # full path from a production machine.
# Corresponds to the JSON property `filePath` # Corresponds to the JSON property `filePath`
# @return [String] # @return [String]
attr_accessor :file_path attr_accessor :file_path
# Human-readable name of a function or method. # Human-readable name of a function or method. The value can include optional
# The value can include optional context like the class or package name. # context like the class or package name. For example, `my.package.MyClass.
# For example, `my.package.MyClass.method` in case of Java. # method` in case of Java.
# Corresponds to the JSON property `functionName` # Corresponds to the JSON property `functionName`
# @return [String] # @return [String]
attr_accessor :function_name attr_accessor :function_name
@ -555,14 +527,14 @@ module Google
class SourceReference class SourceReference
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
# Optional. A URI string identifying the repository. # Optional. A URI string identifying the repository. Example: "https://github.
# Example: "https://github.com/GoogleCloudPlatform/kubernetes.git" # com/GoogleCloudPlatform/kubernetes.git"
# Corresponds to the JSON property `repository` # Corresponds to the JSON property `repository`
# @return [String] # @return [String]
attr_accessor :repository attr_accessor :repository
# The canonical and persistent identifier of the deployed revision. # The canonical and persistent identifier of the deployed revision. Example (git)
# Example (git): "0035781c50ec7aa23385dc841529ce8a4b70db1b" # : "0035781c50ec7aa23385dc841529ce8a4b70db1b"
# Corresponds to the JSON property `revisionId` # Corresponds to the JSON property `revisionId`
# @return [String] # @return [String]
attr_accessor :revision_id attr_accessor :revision_id
@ -578,9 +550,8 @@ module Google
end end
end end
# The number of errors in a given time period. # The number of errors in a given time period. All numbers are approximate since
# All numbers are approximate since the error events are sampled # the error events are sampled before counting them.
# before counting them.
class TimedCount class TimedCount
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
@ -615,8 +586,8 @@ module Google
class TrackingIssue class TrackingIssue
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
# A URL pointing to a related entry in an issue tracking system. # A URL pointing to a related entry in an issue tracking system. Example: `https:
# Example: `https://github.com/user/project/issues/4` # //github.com/user/project/issues/4`
# Corresponds to the JSON property `url` # Corresponds to the JSON property `url`
# @return [String] # @return [String]
attr_accessor :url attr_accessor :url

122
generated/google/apis/clouderrorreporting_v1beta1/service.rb
View File

@ -50,11 +50,10 @@ module Google
# Deletes all error events of a given project. # Deletes all error events of a given project.
# @param [String] project_name # @param [String] project_name
# Required. The resource name of the Google Cloud Platform project. Written # Required. The resource name of the Google Cloud Platform project. Written as `
# as `projects/`projectID``, where ``projectID`` is the # projects/`projectID``, where ``projectID`` is the [Google Cloud Platform
# [Google Cloud Platform project # project ID](https://support.google.com/cloud/answer/6158840). Example: `
# ID](https://support.google.com/cloud/answer/6158840). # projects/my-project-123`.
# Example: `projects/my-project-123`.
# @param [String] fields # @param [String] fields
# Selector specifying which fields to include in a partial response. # Selector specifying which fields to include in a partial response.
# @param [String] quota_user # @param [String] quota_user
@ -84,11 +83,10 @@ module Google
# Lists the specified events. # Lists the specified events.
# @param [String] project_name # @param [String] project_name
# Required. The resource name of the Google Cloud Platform project. Written # Required. The resource name of the Google Cloud Platform project. Written as `
# as `projects/`projectID``, where ``projectID`` is the # projects/`projectID``, where ``projectID`` is the [Google Cloud Platform
# [Google Cloud Platform project # project ID](https://support.google.com/cloud/answer/6158840). Example: `
# ID](https://support.google.com/cloud/answer/6158840). # projects/my-project-123`.
# Example: `projects/my-project-123`.
# @param [String] group_id # @param [String] group_id
# Required. The group for which events shall be returned. # Required. The group for which events shall be returned.
# @param [Fixnum] page_size # @param [Fixnum] page_size
@ -96,17 +94,14 @@ module Google
# @param [String] page_token # @param [String] page_token
# Optional. A `next_page_token` provided by a previous response. # Optional. A `next_page_token` provided by a previous response.
# @param [String] service_filter_resource_type # @param [String] service_filter_resource_type
# Optional. The exact value to match against # Optional. The exact value to match against [`ServiceContext.resource_type`](/
# [`ServiceContext.resource_type`](/error-reporting/reference/rest/v1beta1/ # error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.resource_type).
# ServiceContext#FIELDS.resource_type).
# @param [String] service_filter_service # @param [String] service_filter_service
# Optional. The exact value to match against # Optional. The exact value to match against [`ServiceContext.service`](/error-
# [`ServiceContext.service`](/error-reporting/reference/rest/v1beta1/ # reporting/reference/rest/v1beta1/ServiceContext#FIELDS.service).
# ServiceContext#FIELDS.service).
# @param [String] service_filter_version # @param [String] service_filter_version
# Optional. The exact value to match against # Optional. The exact value to match against [`ServiceContext.version`](/error-
# [`ServiceContext.version`](/error-reporting/reference/rest/v1beta1/ # reporting/reference/rest/v1beta1/ServiceContext#FIELDS.version).
# ServiceContext#FIELDS.version).
# @param [String] time_range_period # @param [String] time_range_period
# Restricts the query to the specified time range. # Restricts the query to the specified time range.
# @param [String] fields # @param [String] fields
@ -143,20 +138,16 @@ module Google
execute_or_queue_command(command, &block) execute_or_queue_command(command, &block)
end end
# Report an individual error event. # Report an individual error event. This endpoint accepts **either** an OAuth
# This endpoint accepts **either** an OAuth token, # token, **or** an [API key](https://support.google.com/cloud/answer/6158862)
# **or** an [API key](https://support.google.com/cloud/answer/6158862) # for authentication. To use an API key, append it to the URL as the value of a `
# for authentication. To use an API key, append it to the URL as the value of # key` parameter. For example: `POST https://clouderrorreporting.googleapis.com/
# a `key` parameter. For example: # v1beta1/`projectName`/events:report?key=123ABC456`
# `POST
# https://clouderrorreporting.googleapis.com/v1beta1/`projectName`/events:report?
# key=123ABC456`
# @param [String] project_name # @param [String] project_name
# Required. The resource name of the Google Cloud Platform project. Written # Required. The resource name of the Google Cloud Platform project. Written as `
# as `projects/`projectId``, where ``projectId`` is the # projects/`projectId``, where ``projectId`` is the [Google Cloud Platform
# [Google Cloud Platform project # project ID](https://support.google.com/cloud/answer/6158840). Example: // `
# ID](https://support.google.com/cloud/answer/6158840). # projects/my-project-123`.
# Example: // `projects/my-project-123`.
# @param [Google::Apis::ClouderrorreportingV1beta1::ReportedErrorEvent] reported_error_event_object # @param [Google::Apis::ClouderrorreportingV1beta1::ReportedErrorEvent] reported_error_event_object
# @param [String] fields # @param [String] fields
# Selector specifying which fields to include in a partial response. # Selector specifying which fields to include in a partial response.
@ -189,46 +180,41 @@ module Google
# Lists the specified groups. # Lists the specified groups.
# @param [String] project_name # @param [String] project_name
# Required. The resource name of the Google Cloud Platform project. Written # Required. The resource name of the Google Cloud Platform project. Written as `
# as `projects/`projectID``, where ``projectID`` is the # projects/`projectID``, where ``projectID`` is the [Google Cloud Platform
# [Google Cloud Platform project # project ID](https://support.google.com/cloud/answer/6158840). Example: `
# ID](https://support.google.com/cloud/answer/6158840). # projects/my-project-123`.
# Example: `projects/my-project-123`.
# @param [String] alignment # @param [String] alignment
# Optional. The alignment of the timed counts to be returned. # Optional. The alignment of the timed counts to be returned. Default is `
# Default is `ALIGNMENT_EQUAL_AT_END`. # ALIGNMENT_EQUAL_AT_END`.
# @param [String] alignment_time # @param [String] alignment_time
# Optional. Time where the timed counts shall be aligned if rounded # Optional. Time where the timed counts shall be aligned if rounded alignment is
# alignment is chosen. Default is 00:00 UTC. # chosen. Default is 00:00 UTC.
# @param [Array<String>, String] group_id # @param [Array<String>, String] group_id
# Optional. List all <code>ErrorGroupStats</code> with these IDs. # Optional. List all ErrorGroupStats with these IDs.
# @param [String] order # @param [String] order
# Optional. The sort order in which the results are returned. # Optional. The sort order in which the results are returned. Default is `
# Default is `COUNT_DESC`. # COUNT_DESC`.
# @param [Fixnum] page_size # @param [Fixnum] page_size
# Optional. The maximum number of results to return per response. # Optional. The maximum number of results to return per response. Default is 20.
# Default is 20.
# @param [String] page_token # @param [String] page_token
# Optional. A `next_page_token` provided by a previous response. To view # Optional. A `next_page_token` provided by a previous response. To view
# additional results, pass this token along with the identical query # additional results, pass this token along with the identical query parameters
# parameters as the first request. # as the first request.
# @param [String] service_filter_resource_type # @param [String] service_filter_resource_type
# Optional. The exact value to match against # Optional. The exact value to match against [`ServiceContext.resource_type`](/
# [`ServiceContext.resource_type`](/error-reporting/reference/rest/v1beta1/ # error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.resource_type).
# ServiceContext#FIELDS.resource_type).
# @param [String] service_filter_service # @param [String] service_filter_service
# Optional. The exact value to match against # Optional. The exact value to match against [`ServiceContext.service`](/error-
# [`ServiceContext.service`](/error-reporting/reference/rest/v1beta1/ # reporting/reference/rest/v1beta1/ServiceContext#FIELDS.service).
# ServiceContext#FIELDS.service).
# @param [String] service_filter_version # @param [String] service_filter_version
# Optional. The exact value to match against # Optional. The exact value to match against [`ServiceContext.version`](/error-
# [`ServiceContext.version`](/error-reporting/reference/rest/v1beta1/ # reporting/reference/rest/v1beta1/ServiceContext#FIELDS.version).
# ServiceContext#FIELDS.version).
# @param [String] time_range_period # @param [String] time_range_period
# Restricts the query to the specified time range. # Restricts the query to the specified time range.
# @param [String] timed_count_duration # @param [String] timed_count_duration
# Optional. The preferred duration for a single returned `TimedCount`. # Optional. The preferred duration for a single returned `TimedCount`. If not
# If not set, no timed counts are returned. # set, no timed counts are returned.
# @param [String] fields # @param [String] fields
# Selector specifying which fields to include in a partial response. # Selector specifying which fields to include in a partial response.
# @param [String] quota_user # @param [String] quota_user
@ -269,12 +255,11 @@ module Google
# Get the specified group. # Get the specified group.
# @param [String] group_name # @param [String] group_name
# Required. The group resource name. Written as # Required. The group resource name. Written as `projects/`projectID`/groups/`
# `projects/`projectID`/groups/`group_name``. Call # group_name``. Call [`groupStats.list`](https://cloud.google.com/error-
# [`groupStats.list`](https://cloud.google.com/error-reporting/reference/rest/ # reporting/reference/rest/v1beta1/projects.groupStats/list) to return a list of
# v1beta1/projects.groupStats/list) # groups belonging to this project. Example: `projects/my-project-123/groups/my-
# to return a list of groups belonging to this project. # group`
# Example: `projects/my-project-123/groups/my-group`
# @param [String] fields # @param [String] fields
# Selector specifying which fields to include in a partial response. # Selector specifying which fields to include in a partial response.
# @param [String] quota_user # @param [String] quota_user
@ -302,11 +287,10 @@ module Google
execute_or_queue_command(command, &block) execute_or_queue_command(command, &block)
end end
# Replace the data for the specified group. # Replace the data for the specified group. Fails if the group does not exist.
# Fails if the group does not exist.
# @param [String] name # @param [String] name
# The group resource name. # The group resource name. Example: projects/my-project-123/groups/
# Example: <code>projects/my-project-123/groups/CNSgkpnppqKCUw</code> # CNSgkpnppqKCUw
# @param [Google::Apis::ClouderrorreportingV1beta1::ErrorGroup] error_group_object # @param [Google::Apis::ClouderrorreportingV1beta1::ErrorGroup] error_group_object
# @param [String] fields # @param [String] fields
# Selector specifying which fields to include in a partial response. # Selector specifying which fields to include in a partial response.

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

@ -25,7 +25,7 @@ module Google
# @see https://developers.google.com/docs/ # @see https://developers.google.com/docs/
module DocsV1 module DocsV1
VERSION = 'V1' VERSION = 'V1'
REVISION = '20200221' REVISION = '20200803'
# View and manage your Google Docs documents # View and manage your Google Docs documents
AUTH_DOCUMENTS = 'https://www.googleapis.com/auth/documents' AUTH_DOCUMENTS = 'https://www.googleapis.com/auth/documents'

2123
generated/google/apis/docs_v1/classes.rb
View File

File diff suppressed because it is too large Load Diff

39
generated/google/apis/docs_v1/service.rb
View File

@ -47,23 +47,19 @@ module Google
@batch_path = 'batch' @batch_path = 'batch'
end end
# Applies one or more updates to the document. # Applies one or more updates to the document. Each request is validated before
# Each request is validated before # being applied. If any request is not valid, then the entire request will fail
# being applied. If any request is not valid, then the entire request will # and nothing will be applied. Some requests have replies to give you some
# fail and nothing will be applied. # information about how they are applied. Other requests do not need to return
# Some requests have replies to # information; these each return an empty reply. The order of replies matches
# give you some information about how they are applied. Other requests do # that of the requests. For example, suppose you call batchUpdate with four
# not need to return information; these each return an empty reply. # updates, and only the third one returns information. The response would have
# The order of replies matches that of the requests. # two empty replies, the reply to the third request, and another empty reply, in
# For example, suppose you call batchUpdate with four updates, and only the # that order. Because other users may be editing the document, the document
# third one returns information. The response would have two empty replies, # might not exactly reflect your changes: your changes may be altered with
# the reply to the third request, and another empty reply, in that order. # respect to collaborator changes. If there are no collaborators, the document
# Because other users may be editing the document, the document # should reflect your changes. In any case, the updates in your request are
# might not exactly reflect your changes: your changes may # guaranteed to be applied together atomically.
# be altered with respect to collaborator changes. If there are no
# collaborators, the document should reflect your changes. In any case,
# the updates in your request are guaranteed to be applied together
# atomically.
# @param [String] document_id # @param [String] document_id
# The ID of the document to update. # The ID of the document to update.
# @param [Google::Apis::DocsV1::BatchUpdateDocumentRequest] batch_update_document_request_object # @param [Google::Apis::DocsV1::BatchUpdateDocumentRequest] batch_update_document_request_object
@ -96,9 +92,9 @@ module Google
execute_or_queue_command(command, &block) execute_or_queue_command(command, &block)
end end
# Creates a blank document using the title given in the request. Other fields # Creates a blank document using the title given in the request. Other fields in
# in the request, including any provided content, are ignored. # the request, including any provided content, are ignored. Returns the created
# Returns the created document. # document.
# @param [Google::Apis::DocsV1::Document] document_object # @param [Google::Apis::DocsV1::Document] document_object
# @param [String] fields # @param [String] fields
# Selector specifying which fields to include in a partial response. # Selector specifying which fields to include in a partial response.
@ -134,8 +130,7 @@ module Google
# @param [String] suggestions_view_mode # @param [String] suggestions_view_mode
# The suggestions view mode to apply to the document. This allows viewing the # The suggestions view mode to apply to the document. This allows viewing the
# document with all suggestions inline, accepted or rejected. If one is not # document with all suggestions inline, accepted or rejected. If one is not
# specified, DEFAULT_FOR_CURRENT_ACCESS is # specified, DEFAULT_FOR_CURRENT_ACCESS is used.
# used.
# @param [String] fields # @param [String] fields
# Selector specifying which fields to include in a partial response. # Selector specifying which fields to include in a partial response.
# @param [String] quota_user # @param [String] quota_user

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

@ -25,7 +25,7 @@ module Google
# @see https://developers.google.com/search/apis/indexing-api/ # @see https://developers.google.com/search/apis/indexing-api/
module IndexingV3 module IndexingV3
VERSION = 'V3' VERSION = 'V3'
REVISION = '20200214' REVISION = '20200804'
# Submit data to Google for indexing # Submit data to Google for indexing
AUTH_INDEXING = 'https://www.googleapis.com/auth/indexing' AUTH_INDEXING = 'https://www.googleapis.com/auth/indexing'

22
generated/google/apis/indexing_v3/classes.rb
View File

@ -42,13 +42,13 @@ module Google
end end
end end
# `UrlNotification` is the resource used in all Indexing API calls. # `UrlNotification` is the resource used in all Indexing API calls. It describes
# It describes one event in the life cycle of a Web Document. # one event in the life cycle of a Web Document.
class UrlNotification class UrlNotification
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
# Creation timestamp for this notification. # Creation timestamp for this notification. Users should _not_ specify it, the
# Users should _not_ specify it, the field is ignored at the request time. # field is ignored at the request time.
# Corresponds to the JSON property `notifyTime` # Corresponds to the JSON property `notifyTime`
# @return [String] # @return [String]
attr_accessor :notify_time attr_accessor :notify_time
@ -58,9 +58,9 @@ module Google
# @return [String] # @return [String]
attr_accessor :type attr_accessor :type
# The object of this notification. The URL must be owned by the publisher # The object of this notification. The URL must be owned by the publisher of
# of this notification and, in case of `URL_UPDATED` notifications, it _must_ # this notification and, in case of `URL_UPDATED` notifications, it _must_ be
# be crawlable by Google. # crawlable by Google.
# Corresponds to the JSON property `url` # Corresponds to the JSON property `url`
# @return [String] # @return [String]
attr_accessor :url attr_accessor :url
@ -82,14 +82,14 @@ module Google
class UrlNotificationMetadata class UrlNotificationMetadata
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
# `UrlNotification` is the resource used in all Indexing API calls. # `UrlNotification` is the resource used in all Indexing API calls. It describes
# It describes one event in the life cycle of a Web Document. # one event in the life cycle of a Web Document.
# Corresponds to the JSON property `latestRemove` # Corresponds to the JSON property `latestRemove`
# @return [Google::Apis::IndexingV3::UrlNotification] # @return [Google::Apis::IndexingV3::UrlNotification]
attr_accessor :latest_remove attr_accessor :latest_remove
# `UrlNotification` is the resource used in all Indexing API calls. # `UrlNotification` is the resource used in all Indexing API calls. It describes
# It describes one event in the life cycle of a Web Document. # one event in the life cycle of a Web Document.
# Corresponds to the JSON property `latestUpdate` # Corresponds to the JSON property `latestUpdate`
# @return [Google::Apis::IndexingV3::UrlNotification] # @return [Google::Apis::IndexingV3::UrlNotification]
attr_accessor :latest_update attr_accessor :latest_update

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

@ -25,7 +25,7 @@ module Google
# @see https://developers.google.com/manufacturers/ # @see https://developers.google.com/manufacturers/
module ManufacturersV1 module ManufacturersV1
VERSION = 'V1' VERSION = 'V1'
REVISION = '20200317' REVISION = '20200805'
# Manage your product listings for Google Manufacturer Center # Manage your product listings for Google Manufacturer Center
AUTH_MANUFACTURERCENTER = 'https://www.googleapis.com/auth/manufacturercenter' AUTH_MANUFACTURERCENTER = 'https://www.googleapis.com/auth/manufacturercenter'

208
generated/google/apis/manufacturers_v1/classes.rb
View File

@ -22,55 +22,55 @@ module Google
module Apis module Apis
module ManufacturersV1 module ManufacturersV1
# Attributes of the product. For more information, see # Attributes of the product. For more information, see https://support.google.
# https://support.google.com/manufacturers/answer/6124116. # com/manufacturers/answer/6124116.
class Attributes class Attributes
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
# The additional images of the product. For more information, see # The additional images of the product. For more information, see https://
# https://support.google.com/manufacturers/answer/6124116#addlimage. # support.google.com/manufacturers/answer/6124116#addlimage.
# Corresponds to the JSON property `additionalImageLink` # Corresponds to the JSON property `additionalImageLink`
# @return [Array<Google::Apis::ManufacturersV1::Image>] # @return [Array<Google::Apis::ManufacturersV1::Image>]
attr_accessor :additional_image_link attr_accessor :additional_image_link
# The target age group of the product. For more information, see # The target age group of the product. For more information, see https://support.
# https://support.google.com/manufacturers/answer/6124116#agegroup. # google.com/manufacturers/answer/6124116#agegroup.
# Corresponds to the JSON property `ageGroup` # Corresponds to the JSON property `ageGroup`
# @return [String] # @return [String]
attr_accessor :age_group attr_accessor :age_group
# The brand name of the product. For more information, see # The brand name of the product. For more information, see https://support.
# https://support.google.com/manufacturers/answer/6124116#brand. # google.com/manufacturers/answer/6124116#brand.
# Corresponds to the JSON property `brand` # Corresponds to the JSON property `brand`
# @return [String] # @return [String]
attr_accessor :brand attr_accessor :brand
# The capacity of a product. For more information, see # The capacity of a product. For more information, see https://support.google.
# https://support.google.com/manufacturers/answer/6124116#capacity. # com/manufacturers/answer/6124116#capacity.
# Corresponds to the JSON property `capacity` # Corresponds to the JSON property `capacity`
# @return [Google::Apis::ManufacturersV1::Capacity] # @return [Google::Apis::ManufacturersV1::Capacity]
attr_accessor :capacity attr_accessor :capacity
# The color of the product. For more information, see # The color of the product. For more information, see https://support.google.com/
# https://support.google.com/manufacturers/answer/6124116#color. # manufacturers/answer/6124116#color.
# Corresponds to the JSON property `color` # Corresponds to the JSON property `color`
# @return [String] # @return [String]
attr_accessor :color attr_accessor :color
# The number of products in a single package. For more information, see # The number of products in a single package. For more information, see https://
# https://support.google.com/manufacturers/answer/6124116#count. # support.google.com/manufacturers/answer/6124116#count.
# Corresponds to the JSON property `count` # Corresponds to the JSON property `count`
# @return [Google::Apis::ManufacturersV1::Count] # @return [Google::Apis::ManufacturersV1::Count]
attr_accessor :count attr_accessor :count
# The description of the product. For more information, see # The description of the product. For more information, see https://support.
# https://support.google.com/manufacturers/answer/6124116#description. # google.com/manufacturers/answer/6124116#description.
# Corresponds to the JSON property `description` # Corresponds to the JSON property `description`
# @return [String] # @return [String]
attr_accessor :description attr_accessor :description
# The disclosure date of the product. For more information, see # The disclosure date of the product. For more information, see https://support.
# https://support.google.com/manufacturers/answer/6124116#disclosure. # google.com/manufacturers/answer/6124116#disclosure.
# Corresponds to the JSON property `disclosureDate` # Corresponds to the JSON property `disclosureDate`
# @return [String] # @return [String]
attr_accessor :disclosure_date attr_accessor :disclosure_date
@ -80,32 +80,32 @@ module Google
# @return [Array<String>] # @return [Array<String>]
attr_accessor :excluded_destination attr_accessor :excluded_destination
# The rich format description of the product. For more information, see # The rich format description of the product. For more information, see https://
# https://support.google.com/manufacturers/answer/6124116#featuredesc. # support.google.com/manufacturers/answer/6124116#featuredesc.
# Corresponds to the JSON property `featureDescription` # Corresponds to the JSON property `featureDescription`
# @return [Array<Google::Apis::ManufacturersV1::FeatureDescription>] # @return [Array<Google::Apis::ManufacturersV1::FeatureDescription>]
attr_accessor :feature_description attr_accessor :feature_description
# The flavor of the product. For more information, see # The flavor of the product. For more information, see https://support.google.
# https://support.google.com/manufacturers/answer/6124116#flavor. # com/manufacturers/answer/6124116#flavor.
# Corresponds to the JSON property `flavor` # Corresponds to the JSON property `flavor`
# @return [String] # @return [String]
attr_accessor :flavor attr_accessor :flavor
# The format of the product. For more information, see # The format of the product. For more information, see https://support.google.
# https://support.google.com/manufacturers/answer/6124116#format. # com/manufacturers/answer/6124116#format.
# Corresponds to the JSON property `format` # Corresponds to the JSON property `format`
# @return [String] # @return [String]
attr_accessor :format attr_accessor :format
# The target gender of the product. For more information, see # The target gender of the product. For more information, see https://support.
# https://support.google.com/manufacturers/answer/6124116#gender. # google.com/manufacturers/answer/6124116#gender.
# Corresponds to the JSON property `gender` # Corresponds to the JSON property `gender`
# @return [String] # @return [String]
attr_accessor :gender attr_accessor :gender
# The Global Trade Item Number (GTIN) of the product. For more information, # The Global Trade Item Number (GTIN) of the product. For more information, see
# see https://support.google.com/manufacturers/answer/6124116#gtin. # https://support.google.com/manufacturers/answer/6124116#gtin.
# Corresponds to the JSON property `gtin` # Corresponds to the JSON property `gtin`
# @return [Array<String>] # @return [Array<String>]
attr_accessor :gtin attr_accessor :gtin
@ -120,93 +120,92 @@ module Google
# @return [Array<String>] # @return [Array<String>]
attr_accessor :included_destination attr_accessor :included_destination
# The item group id of the product. For more information, see # The item group id of the product. For more information, see https://support.
# https://support.google.com/manufacturers/answer/6124116#itemgroupid. # google.com/manufacturers/answer/6124116#itemgroupid.
# Corresponds to the JSON property `itemGroupId` # Corresponds to the JSON property `itemGroupId`
# @return [String] # @return [String]
attr_accessor :item_group_id attr_accessor :item_group_id
# The material of the product. For more information, see # The material of the product. For more information, see https://support.google.
# https://support.google.com/manufacturers/answer/6124116#material. # com/manufacturers/answer/6124116#material.
# Corresponds to the JSON property `material` # Corresponds to the JSON property `material`
# @return [String] # @return [String]
attr_accessor :material attr_accessor :material
# The Manufacturer Part Number (MPN) of the product. For more information, # The Manufacturer Part Number (MPN) of the product. For more information, see
# see https://support.google.com/manufacturers/answer/6124116#mpn. # https://support.google.com/manufacturers/answer/6124116#mpn.
# Corresponds to the JSON property `mpn` # Corresponds to the JSON property `mpn`
# @return [String] # @return [String]
attr_accessor :mpn attr_accessor :mpn
# The pattern of the product. For more information, see # The pattern of the product. For more information, see https://support.google.
# https://support.google.com/manufacturers/answer/6124116#pattern. # com/manufacturers/answer/6124116#pattern.
# Corresponds to the JSON property `pattern` # Corresponds to the JSON property `pattern`
# @return [String] # @return [String]
attr_accessor :pattern attr_accessor :pattern
# The details of the product. For more information, see # The details of the product. For more information, see https://support.google.
# https://support.google.com/manufacturers/answer/6124116#productdetail. # com/manufacturers/answer/6124116#productdetail.
# Corresponds to the JSON property `productDetail` # Corresponds to the JSON property `productDetail`
# @return [Array<Google::Apis::ManufacturersV1::ProductDetail>] # @return [Array<Google::Apis::ManufacturersV1::ProductDetail>]
attr_accessor :product_detail attr_accessor :product_detail
# The name of the group of products related to the product. For more # The name of the group of products related to the product. For more information,
# information, see # see https://support.google.com/manufacturers/answer/6124116#productline.
# https://support.google.com/manufacturers/answer/6124116#productline.
# Corresponds to the JSON property `productLine` # Corresponds to the JSON property `productLine`
# @return [String] # @return [String]
attr_accessor :product_line attr_accessor :product_line
# The canonical name of the product. For more information, see # The canonical name of the product. For more information, see https://support.
# https://support.google.com/manufacturers/answer/6124116#productname. # google.com/manufacturers/answer/6124116#productname.
# Corresponds to the JSON property `productName` # Corresponds to the JSON property `productName`
# @return [String] # @return [String]
attr_accessor :product_name attr_accessor :product_name
# The URL of the detail page of the product. For more information, see # The URL of the detail page of the product. For more information, see https://
# https://support.google.com/manufacturers/answer/6124116#productpage. # support.google.com/manufacturers/answer/6124116#productpage.
# Corresponds to the JSON property `productPageUrl` # Corresponds to the JSON property `productPageUrl`
# @return [String] # @return [String]
attr_accessor :product_page_url attr_accessor :product_page_url
# The type or category of the product. For more information, see # The type or category of the product. For more information, see https://support.
# https://support.google.com/manufacturers/answer/6124116#producttype. # google.com/manufacturers/answer/6124116#producttype.
# Corresponds to the JSON property `productType` # Corresponds to the JSON property `productType`
# @return [Array<String>] # @return [Array<String>]
attr_accessor :product_type attr_accessor :product_type
# The release date of the product. For more information, see # The release date of the product. For more information, see https://support.
# https://support.google.com/manufacturers/answer/6124116#release. # google.com/manufacturers/answer/6124116#release.
# Corresponds to the JSON property `releaseDate` # Corresponds to the JSON property `releaseDate`
# @return [String] # @return [String]
attr_accessor :release_date attr_accessor :release_date
# Rich product content. For more information, see # Rich product content. For more information, see https://support.google.com/
# https://support.google.com/manufacturers/answer/9389865 # manufacturers/answer/9389865
# Corresponds to the JSON property `richProductContent` # Corresponds to the JSON property `richProductContent`
# @return [Array<String>] # @return [Array<String>]
attr_accessor :rich_product_content attr_accessor :rich_product_content
# The scent of the product. For more information, see # The scent of the product. For more information, see https://support.google.com/
# https://support.google.com/manufacturers/answer/6124116#scent. # manufacturers/answer/6124116#scent.
# Corresponds to the JSON property `scent` # Corresponds to the JSON property `scent`
# @return [String] # @return [String]
attr_accessor :scent attr_accessor :scent
# The size of the product. For more information, see # The size of the product. For more information, see https://support.google.com/
# https://support.google.com/manufacturers/answer/6124116#size. # manufacturers/answer/6124116#size.
# Corresponds to the JSON property `size` # Corresponds to the JSON property `size`
# @return [String] # @return [String]
attr_accessor :size attr_accessor :size
# The size system of the product. For more information, see # The size system of the product. For more information, see https://support.
# https://support.google.com/manufacturers/answer/6124116#sizesystem. # google.com/manufacturers/answer/6124116#sizesystem.
# Corresponds to the JSON property `sizeSystem` # Corresponds to the JSON property `sizeSystem`
# @return [String] # @return [String]
attr_accessor :size_system attr_accessor :size_system
# The size type of the product. For more information, see # The size type of the product. For more information, see https://support.google.
# https://support.google.com/manufacturers/answer/6124116#sizetype. # com/manufacturers/answer/6124116#sizetype.
# Corresponds to the JSON property `sizeType` # Corresponds to the JSON property `sizeType`
# @return [String] # @return [String]
attr_accessor :size_type attr_accessor :size_type
@ -216,26 +215,25 @@ module Google
# @return [Google::Apis::ManufacturersV1::Price] # @return [Google::Apis::ManufacturersV1::Price]
attr_accessor :suggested_retail_price attr_accessor :suggested_retail_price
# The target client id. Should only be used in the accounts of the data # The target client id. Should only be used in the accounts of the data partners.
# partners.
# Corresponds to the JSON property `targetClientId` # Corresponds to the JSON property `targetClientId`
# @return [String] # @return [String]
attr_accessor :target_client_id attr_accessor :target_client_id
# The theme of the product. For more information, see # The theme of the product. For more information, see https://support.google.com/
# https://support.google.com/manufacturers/answer/6124116#theme. # manufacturers/answer/6124116#theme.
# Corresponds to the JSON property `theme` # Corresponds to the JSON property `theme`
# @return [String] # @return [String]
attr_accessor :theme attr_accessor :theme
# The title of the product. For more information, see # The title of the product. For more information, see https://support.google.com/
# https://support.google.com/manufacturers/answer/6124116#title. # manufacturers/answer/6124116#title.
# Corresponds to the JSON property `title` # Corresponds to the JSON property `title`
# @return [String] # @return [String]
attr_accessor :title attr_accessor :title
# The videos of the product. For more information, see # The videos of the product. For more information, see https://support.google.
# https://support.google.com/manufacturers/answer/6124116#video. # com/manufacturers/answer/6124116#video.
# Corresponds to the JSON property `videoLink` # Corresponds to the JSON property `videoLink`
# @return [Array<String>] # @return [Array<String>]
attr_accessor :video_link attr_accessor :video_link
@ -285,8 +283,8 @@ module Google
end end
end end
# The capacity of a product. For more information, see # The capacity of a product. For more information, see https://support.google.
# https://support.google.com/manufacturers/answer/6124116#capacity. # com/manufacturers/answer/6124116#capacity.
class Capacity class Capacity
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
@ -311,8 +309,8 @@ module Google
end end
end end
# The number of products in a single package. For more information, see # The number of products in a single package. For more information, see https://
# https://support.google.com/manufacturers/answer/6124116#count. # support.google.com/manufacturers/answer/6124116#count.
class Count class Count
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
@ -362,13 +360,11 @@ module Google
end end
end end
# A generic empty message that you can re-use to avoid defining duplicated # A generic empty message that you can re-use to avoid defining duplicated empty
# empty messages in your APIs. A typical example is to use it as the request # messages in your APIs. A typical example is to use it as the request or the
# or the response type of an API method. For instance: # response type of an API method. For instance: service Foo ` rpc Bar(google.
# service Foo ` # protobuf.Empty) returns (google.protobuf.Empty); ` The JSON representation for
# rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); # `Empty` is empty JSON object ````.
# `
# The JSON representation for `Empty` is empty JSON object ````.
class Empty class Empty
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
@ -381,8 +377,8 @@ module Google
end end
end end
# A feature description of the product. For more information, see # A feature description of the product. For more information, see https://
# https://support.google.com/manufacturers/answer/6124116#featuredesc. # support.google.com/manufacturers/answer/6124116#featuredesc.
class FeatureDescription class FeatureDescription
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
@ -424,14 +420,12 @@ module Google
# @return [String] # @return [String]
attr_accessor :image_url attr_accessor :image_url
# The status of the image. # The status of the image. @OutputOnly
# @OutputOnly
# Corresponds to the JSON property `status` # Corresponds to the JSON property `status`
# @return [String] # @return [String]
attr_accessor :status attr_accessor :status
# The type of the image, i.e., crawled or uploaded. # The type of the image, i.e., crawled or uploaded. @OutputOnly
# @OutputOnly
# Corresponds to the JSON property `type` # Corresponds to the JSON property `type`
# @return [String] # @return [String]
attr_accessor :type attr_accessor :type
@ -452,9 +446,8 @@ module Google
class Issue class Issue
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
# If present, the attribute that triggered the issue. For more information # If present, the attribute that triggered the issue. For more information about
# about attributes, see # attributes, see https://support.google.com/manufacturers/answer/6124116.
# https://support.google.com/manufacturers/answer/6124116.
# Corresponds to the JSON property `attribute` # Corresponds to the JSON property `attribute`
# @return [String] # @return [String]
attr_accessor :attribute attr_accessor :attribute
@ -489,8 +482,8 @@ module Google
# @return [String] # @return [String]
attr_accessor :title attr_accessor :title
# The server-generated type of the issue, for example, # The server-generated type of the issue, for example, “
# “INCORRECT_TEXT_FORMATTING”, “IMAGE_NOT_SERVEABLE”, etc. # INCORRECT_TEXT_FORMATTING”, “IMAGE_NOT_SERVEABLE”, etc.
# Corresponds to the JSON property `type` # Corresponds to the JSON property `type`
# @return [String] # @return [String]
attr_accessor :type attr_accessor :type
@ -566,14 +559,14 @@ module Google
class Product class Product
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
# Attributes of the product. For more information, see # Attributes of the product. For more information, see https://support.google.
# https://support.google.com/manufacturers/answer/6124116. # com/manufacturers/answer/6124116.
# Corresponds to the JSON property `attributes` # Corresponds to the JSON property `attributes`
# @return [Google::Apis::ManufacturersV1::Attributes] # @return [Google::Apis::ManufacturersV1::Attributes]
attr_accessor :attributes attr_accessor :attributes
# The content language of the product as a two-letter ISO 639-1 language code # The content language of the product as a two-letter ISO 639-1 language code (
# (for example, en). # for example, en).
# Corresponds to the JSON property `contentLanguage` # Corresponds to the JSON property `contentLanguage`
# @return [String] # @return [String]
attr_accessor :content_language attr_accessor :content_language
@ -588,32 +581,29 @@ module Google
# @return [Array<Google::Apis::ManufacturersV1::Issue>] # @return [Array<Google::Apis::ManufacturersV1::Issue>]
attr_accessor :issues attr_accessor :issues
# Name in the format ``target_country`:`content_language`:`product_id``. # Name in the format ``target_country`:`content_language`:`product_id``. `
# `target_country` - The target country of the product as a CLDR territory # target_country` - The target country of the product as a CLDR territory code (
# code (for example, US). # for example, US). `content_language` - The content language of the product as
# `content_language` - The content language of the product as a two-letter # a two-letter ISO 639-1 language code (for example, en). `product_id` - The ID
# ISO 639-1 language code (for example, en). # of the product. For more information, see https://support.google.com/
# `product_id` - The ID of the product. For more information, see # manufacturers/answer/6124116#id.
# https://support.google.com/manufacturers/answer/6124116#
# id.
# Corresponds to the JSON property `name` # Corresponds to the JSON property `name`
# @return [String] # @return [String]
attr_accessor :name attr_accessor :name
# Parent ID in the format `accounts/`account_id``. # Parent ID in the format `accounts/`account_id``. `account_id` - The ID of the
# `account_id` - The ID of the Manufacturer Center account. # Manufacturer Center account.
# Corresponds to the JSON property `parent` # Corresponds to the JSON property `parent`
# @return [String] # @return [String]
attr_accessor :parent attr_accessor :parent
# The ID of the product. For more information, see # The ID of the product. For more information, see https://support.google.com/
# https://support.google.com/manufacturers/answer/6124116#id. # manufacturers/answer/6124116#id.
# Corresponds to the JSON property `productId` # Corresponds to the JSON property `productId`
# @return [String] # @return [String]
attr_accessor :product_id attr_accessor :product_id
# The target country of the product as a CLDR territory code (for example, # The target country of the product as a CLDR territory code (for example, US).
# US).
# Corresponds to the JSON property `targetCountry` # Corresponds to the JSON property `targetCountry`
# @return [String] # @return [String]
attr_accessor :target_country attr_accessor :target_country
@ -635,8 +625,8 @@ module Google
end end
end end
# A product detail of the product. For more information, see # A product detail of the product. For more information, see https://support.
# https://support.google.com/manufacturers/answer/6124116#productdetail. # google.com/manufacturers/answer/6124116#productdetail.
class ProductDetail class ProductDetail
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable

99
generated/google/apis/manufacturers_v1/service.rb
View File

@ -49,17 +49,15 @@ module Google
# Deletes the product from a Manufacturer Center account. # Deletes the product from a Manufacturer Center account.
# @param [String] parent # @param [String] parent
# Parent ID in the format `accounts/`account_id``. # Parent ID in the format `accounts/`account_id``. `account_id` - The ID of the
# `account_id` - The ID of the Manufacturer Center account. # Manufacturer Center account.
# @param [String] name # @param [String] name
# Name in the format ``target_country`:`content_language`:`product_id``. # Name in the format ``target_country`:`content_language`:`product_id``. `
# `target_country` - The target country of the product as a CLDR territory # target_country` - The target country of the product as a CLDR territory code (
# code (for example, US). # for example, US). `content_language` - The content language of the product as
# `content_language` - The content language of the product as a two-letter # a two-letter ISO 639-1 language code (for example, en). `product_id` - The ID
# ISO 639-1 language code (for example, en). # of the product. For more information, see https://support.google.com/
# `product_id` - The ID of the product. For more information, see # manufacturers/answer/6124116#id.
# https://support.google.com/manufacturers/answer/6124116#
# id.
# @param [String] fields # @param [String] fields
# Selector specifying which fields to include in a partial response. # Selector specifying which fields to include in a partial response.
# @param [String] quota_user # @param [String] quota_user
@ -88,27 +86,23 @@ module Google
execute_or_queue_command(command, &block) execute_or_queue_command(command, &block)
end end
# Gets the product from a Manufacturer Center account, including product # Gets the product from a Manufacturer Center account, including product issues.
# issues.
# A recently updated product takes around 15 minutes to process. Changes are # A recently updated product takes around 15 minutes to process. Changes are
# only visible after it has been processed. While some issues may be # only visible after it has been processed. While some issues may be available
# available once the product has been processed, other issues may take days # once the product has been processed, other issues may take days to appear.
# to appear.
# @param [String] parent # @param [String] parent
# Parent ID in the format `accounts/`account_id``. # Parent ID in the format `accounts/`account_id``. `account_id` - The ID of the
# `account_id` - The ID of the Manufacturer Center account. # Manufacturer Center account.
# @param [String] name # @param [String] name
# Name in the format ``target_country`:`content_language`:`product_id``. # Name in the format ``target_country`:`content_language`:`product_id``. `
# `target_country` - The target country of the product as a CLDR territory # target_country` - The target country of the product as a CLDR territory code (
# code (for example, US). # for example, US). `content_language` - The content language of the product as
# `content_language` - The content language of the product as a two-letter # a two-letter ISO 639-1 language code (for example, en). `product_id` - The ID
# ISO 639-1 language code (for example, en). # of the product. For more information, see https://support.google.com/
# `product_id` - The ID of the product. For more information, see # manufacturers/answer/6124116#id.
# https://support.google.com/manufacturers/answer/6124116#
# id.
# @param [Array<String>, String] include # @param [Array<String>, String] include
# The information to be included in the response. Only sections listed here # The information to be included in the response. Only sections listed here will
# will be returned. # be returned.
# @param [String] fields # @param [String] fields
# Selector specifying which fields to include in a partial response. # Selector specifying which fields to include in a partial response.
# @param [String] quota_user # @param [String] quota_user
@ -140,14 +134,13 @@ module Google
# Lists all the products in a Manufacturer Center account. # Lists all the products in a Manufacturer Center account.
# @param [String] parent # @param [String] parent
# Parent ID in the format `accounts/`account_id``. # Parent ID in the format `accounts/`account_id``. `account_id` - The ID of the
# `account_id` - The ID of the Manufacturer Center account. # Manufacturer Center account.
# @param [Array<String>, String] include # @param [Array<String>, String] include
# The information to be included in the response. Only sections listed here # The information to be included in the response. Only sections listed here will
# will be returned. # be returned.
# @param [Fixnum] page_size # @param [Fixnum] page_size
# Maximum number of product statuses to return in the response, used for # Maximum number of product statuses to return in the response, used for paging.
# paging.
# @param [String] page_token # @param [String] page_token
# The token returned by the previous request. # The token returned by the previous request.
# @param [String] fields # @param [String] fields
@ -181,30 +174,26 @@ module Google
end end
# Inserts or updates the attributes of the product in a Manufacturer Center # Inserts or updates the attributes of the product in a Manufacturer Center
# account. # account. Creates a product with the provided attributes. If the product
# Creates a product with the provided attributes. If the product already # already exists, then all attributes are replaced with the new ones. The checks
# exists, then all attributes are replaced with the new ones. The checks at # at upload time are minimal. All required attributes need to be present for a
# upload time are minimal. All required attributes need to be present for a # product to be valid. Issues may show up later after the API has accepted a new
# product to be valid. Issues may show up later after the API has accepted a # upload for a product and it is possible to overwrite an existing valid product
# new upload for a product and it is possible to overwrite an existing valid # with an invalid product. To detect this, you should retrieve the product and
# product with an invalid product. To detect this, you should retrieve the # check it for issues once the new version is available. Uploaded attributes
# product and check it for issues once the new version is available. # first need to be processed before they can be retrieved. Until then, new
# Uploaded attributes first need to be processed before they can be # products will be unavailable, and retrieval of previously uploaded products
# retrieved. Until then, new products will be unavailable, and retrieval # will return the original state of the product.
# of previously uploaded products will return the original state of the
# product.
# @param [String] parent # @param [String] parent
# Parent ID in the format `accounts/`account_id``. # Parent ID in the format `accounts/`account_id``. `account_id` - The ID of the
# `account_id` - The ID of the Manufacturer Center account. # Manufacturer Center account.
# @param [String] name # @param [String] name
# Name in the format ``target_country`:`content_language`:`product_id``. # Name in the format ``target_country`:`content_language`:`product_id``. `
# `target_country` - The target country of the product as a CLDR territory # target_country` - The target country of the product as a CLDR territory code (
# code (for example, US). # for example, US). `content_language` - The content language of the product as
# `content_language` - The content language of the product as a two-letter # a two-letter ISO 639-1 language code (for example, en). `product_id` - The ID
# ISO 639-1 language code (for example, en). # of the product. For more information, see https://support.google.com/
# `product_id` - The ID of the product. For more information, see # manufacturers/answer/6124116#id.
# https://support.google.com/manufacturers/answer/6124116#
# id.
# @param [Google::Apis::ManufacturersV1::Attributes] attributes_object # @param [Google::Apis::ManufacturersV1::Attributes] attributes_object
# @param [String] fields # @param [String] fields
# Selector specifying which fields to include in a partial response. # Selector specifying which fields to include in a partial response.

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

@ -25,7 +25,7 @@ module Google
# @see https://developers.google.com/maps/contact-sales/ # @see https://developers.google.com/maps/contact-sales/
module PlayablelocationsV3 module PlayablelocationsV3
VERSION = 'V3' VERSION = 'V3'
REVISION = '20200622' REVISION = '20200808'
end end
end end
end end

263
generated/google/apis/playablelocations_v3/classes.rb
View File

@ -26,13 +26,12 @@ module Google
class GoogleMapsPlayablelocationsV3Impression class GoogleMapsPlayablelocationsV3Impression
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
# An arbitrary, developer-defined type identifier for each type of game # An arbitrary, developer-defined type identifier for each type of game object
# object used in your game. # used in your game. Since players interact with differ types of game objects in
# Since players interact with differ types of game objects in different ways, # different ways, this field allows you to segregate impression data by type for
# this field allows you to segregate impression data by type for analysis. # analysis. You should assign a unique `game_object_type` ID to represent a
# You should assign a unique `game_object_type` ID to represent a distinct # distinct type of game object in your game. For example, 1=monster location, 2=
# type of game object in your game. # powerup location.
# For example, 1=monster location, 2=powerup location.
# Corresponds to the JSON property `gameObjectType` # Corresponds to the JSON property `gameObjectType`
# @return [Fixnum] # @return [Fixnum]
attr_accessor :game_object_type attr_accessor :game_object_type
@ -69,19 +68,16 @@ module Google
attr_accessor :client_info attr_accessor :client_info
# Required. Impression event details. The maximum number of impression reports # Required. Impression event details. The maximum number of impression reports
# that you # that you can log at once is 50.
# can log at once is 50.
# Corresponds to the JSON property `impressions` # Corresponds to the JSON property `impressions`
# @return [Array<Google::Apis::PlayablelocationsV3::GoogleMapsPlayablelocationsV3Impression>] # @return [Array<Google::Apis::PlayablelocationsV3::GoogleMapsPlayablelocationsV3Impression>]
attr_accessor :impressions attr_accessor :impressions
# Required. A string that uniquely identifies the log impressions request. This # Required. A string that uniquely identifies the log impressions request. This
# allows # allows you to detect duplicate requests. We recommend that you use UUIDs for
# you to detect duplicate requests. We recommend that you use UUIDs for this # this value. The value must not exceed 50 characters. You should reuse the `
# value. The value must not exceed 50 characters. # request_id` only when retrying a request in case of failure. In this case, the
# You should reuse the `request_id` only when retrying a request in case of # request must be identical to the one that failed.
# failure. In this case, the request must be identical to the one that
# failed.
# Corresponds to the JSON property `requestId` # Corresponds to the JSON property `requestId`
# @return [String] # @return [String]
attr_accessor :request_id attr_accessor :request_id
@ -98,8 +94,8 @@ module Google
end end
end end
# A response for the LogImpressions method. # A response for the LogImpressions method. This method returns no data upon
# This method returns no data upon success. # success.
class GoogleMapsPlayablelocationsV3LogImpressionsResponse class GoogleMapsPlayablelocationsV3LogImpressionsResponse
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
@ -122,19 +118,16 @@ module Google
attr_accessor :client_info attr_accessor :client_info
# Required. Player reports. The maximum number of player reports that you can # Required. Player reports. The maximum number of player reports that you can
# log at # log at once is 50.
# once is 50.
# Corresponds to the JSON property `playerReports` # Corresponds to the JSON property `playerReports`
# @return [Array<Google::Apis::PlayablelocationsV3::GoogleMapsPlayablelocationsV3PlayerReport>] # @return [Array<Google::Apis::PlayablelocationsV3::GoogleMapsPlayablelocationsV3PlayerReport>]
attr_accessor :player_reports attr_accessor :player_reports
# Required. A string that uniquely identifies the log player reports request. # Required. A string that uniquely identifies the log player reports request.
# This # This allows you to detect duplicate requests. We recommend that you use UUIDs
# allows you to detect duplicate requests. We recommend that you use UUIDs # for this value. The value must not exceed 50 characters. You should reuse the `
# for this value. The value must not exceed 50 characters. # request_id` only when retrying a request in the case of a failure. In that
# You should reuse the `request_id` only when retrying a request in the case # case, the request must be identical to the one that failed.
# of a failure. In that case, the request must be identical to the one that
# failed.
# Corresponds to the JSON property `requestId` # Corresponds to the JSON property `requestId`
# @return [String] # @return [String]
attr_accessor :request_id attr_accessor :request_id
@ -151,9 +144,8 @@ module Google
end end
end end
# A response for the LogPlayerReports # A response for the LogPlayerReports method. This method returns no data upon
# method. # success.
# This method returns no data upon success.
class GoogleMapsPlayablelocationsV3LogPlayerReportsResponse class GoogleMapsPlayablelocationsV3LogPlayerReportsResponse
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
@ -172,9 +164,9 @@ module Google
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
# Language code (in BCP-47 format) indicating the language of the freeform # Language code (in BCP-47 format) indicating the language of the freeform
# description provided in `reason_details`. Examples are "en", "en-US" or # description provided in `reason_details`. Examples are "en", "en-US" or "ja-
# "ja-Latn". For more information, see # Latn". For more information, see http://www.unicode.org/reports/tr35/#
# http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. # Unicode_locale_identifier.
# Corresponds to the JSON property `languageCode` # Corresponds to the JSON property `languageCode`
# @return [String] # @return [String]
attr_accessor :language_code attr_accessor :language_code
@ -213,15 +205,12 @@ module Google
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
# Required. The S2 cell ID of the area you want. This must be between cell level # Required. The S2 cell ID of the area you want. This must be between cell level
# 11 and # 11 and 14 (inclusive). S2 cells are 64-bit integers that identify areas on the
# 14 (inclusive). # Earth. They are hierarchical, and can therefore be used for spatial indexing.
# S2 cells are 64-bit integers that identify areas on the Earth. They are # The S2 geometry library is available in a number of languages: * [C++](https://
# hierarchical, and can therefore be used for spatial indexing. # github.com/google/s2geometry) * [Java](https://github.com/google/s2-geometry-
# The S2 geometry library is available in a number of languages: # library-java) * [Go](https://github.com/golang/geo) * [Python](https://github.
# * [C++](https://github.com/google/s2geometry) # com/google/s2geometry/tree/master/src/python)
# * [Java](https://github.com/google/s2-geometry-library-java)
# * [Go](https://github.com/golang/geo)
# * [Python](https://github.com/google/s2geometry/tree/master/src/python)
# Corresponds to the JSON property `s2CellId` # Corresponds to the JSON property `s2CellId`
# @return [Fixnum] # @return [Fixnum]
attr_accessor :s2_cell_id attr_accessor :s2_cell_id
@ -236,19 +225,15 @@ module Google
end end
end end
# Encapsulates a filter criterion for searching for a set of playable # Encapsulates a filter criterion for searching for a set of playable locations.
# locations.
class GoogleMapsPlayablelocationsV3SampleCriterion class GoogleMapsPlayablelocationsV3SampleCriterion
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
# Specifies which `PlayableLocation` fields are returned. # Specifies which `PlayableLocation` fields are returned. `name` (which is used
# `name` (which is used for logging impressions), `center_point` and # for logging impressions), `center_point` and `place_id` (or `plus_code`) are
# `place_id` (or `plus_code`) are always returned. # always returned. The following fields are omitted unless you specify them here:
# The following fields are omitted unless you specify them here: # * snapped_point * types Note: The more fields you include, the more expensive
# * snapped_point # in terms of data and associated latency your query will be.
# * types
# Note: The more fields you include, the more expensive in terms of data and
# associated latency your query will be.
# Corresponds to the JSON property `fieldsToReturn` # Corresponds to the JSON property `fieldsToReturn`
# @return [String] # @return [String]
attr_accessor :fields_to_return attr_accessor :fields_to_return
@ -259,13 +244,11 @@ module Google
attr_accessor :filter attr_accessor :filter
# Required. An arbitrary, developer-defined identifier of the type of game # Required. An arbitrary, developer-defined identifier of the type of game
# object that # object that the playable location is used for. This field allows you to
# the playable location is used for. This field allows you to specify # specify criteria per game object type when searching for playable locations.
# criteria per game object type when searching for playable locations. # You should assign a unique `game_object_type` ID across all `request_criteria`
# You should assign a unique `game_object_type` ID across all # to represent a distinct type of game object. For example, 1=monster location,
# `request_criteria` to represent a distinct type of game object. For # 2=powerup location. The response contains a map.
# example, 1=monster location, 2=powerup location.
# The response contains a map<game_object_type, Response>.
# Corresponds to the JSON property `gameObjectType` # Corresponds to the JSON property `gameObjectType`
# @return [Fixnum] # @return [Fixnum]
attr_accessor :game_object_type attr_accessor :game_object_type
@ -286,15 +269,15 @@ module Google
class GoogleMapsPlayablelocationsV3SampleFilter class GoogleMapsPlayablelocationsV3SampleFilter
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
# Restricts the set of playable locations to just the # Restricts the set of playable locations to just the [types](/maps/
# [types](/maps/documentation/gaming/tt/types) that you want. # documentation/gaming/tt/types) that you want.
# Corresponds to the JSON property `includedTypes` # Corresponds to the JSON property `includedTypes`
# @return [Array<String>] # @return [Array<String>]
attr_accessor :included_types attr_accessor :included_types
# Specifies the maximum number of playable locations to return. This value # Specifies the maximum number of playable locations to return. This value must
# must not be greater than 1000. The default value is 100. # not be greater than 1000. The default value is 100. Only the top-ranking
# Only the top-ranking playable locations are returned. # playable locations are returned.
# Corresponds to the JSON property `maxLocationCount` # Corresponds to the JSON property `maxLocationCount`
# @return [Fixnum] # @return [Fixnum]
attr_accessor :max_location_count attr_accessor :max_location_count
@ -316,16 +299,14 @@ module Google
end end
end end
# A geographical point suitable for placing game objects in location-based # A geographical point suitable for placing game objects in location-based games.
# games.
class GoogleMapsPlayablelocationsV3SamplePlayableLocation class GoogleMapsPlayablelocationsV3SamplePlayableLocation
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
# An object representing a latitude/longitude pair. This is expressed as a pair # An object representing a latitude/longitude pair. This is expressed as a pair
# of doubles representing degrees latitude and degrees longitude. Unless # of doubles representing degrees latitude and degrees longitude. Unless
# specified otherwise, this must conform to the # specified otherwise, this must conform to the WGS84 standard. Values must be
# <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 # within normalized ranges.
# standard</a>. Values must be within normalized ranges.
# Corresponds to the JSON property `centerPoint` # Corresponds to the JSON property `centerPoint`
# @return [Google::Apis::PlayablelocationsV3::GoogleTypeLatLng] # @return [Google::Apis::PlayablelocationsV3::GoogleTypeLatLng]
attr_accessor :center_point attr_accessor :center_point
@ -347,17 +328,15 @@ module Google
# An object representing a latitude/longitude pair. This is expressed as a pair # An object representing a latitude/longitude pair. This is expressed as a pair
# of doubles representing degrees latitude and degrees longitude. Unless # of doubles representing degrees latitude and degrees longitude. Unless
# specified otherwise, this must conform to the # specified otherwise, this must conform to the WGS84 standard. Values must be
# <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 # within normalized ranges.
# standard</a>. Values must be within normalized ranges.
# Corresponds to the JSON property `snappedPoint` # Corresponds to the JSON property `snappedPoint`
# @return [Google::Apis::PlayablelocationsV3::GoogleTypeLatLng] # @return [Google::Apis::PlayablelocationsV3::GoogleTypeLatLng]
attr_accessor :snapped_point attr_accessor :snapped_point
# A collection of [Playable Location # A collection of [Playable Location Types](/maps/documentation/gaming/tt/types)
# Types](/maps/documentation/gaming/tt/types) for this playable location. The # for this playable location. The first type in the collection is the primary
# first type in the collection is the primary type. # type. Type information might not be available for all playable locations.
# Type information might not be available for all playable locations.
# Corresponds to the JSON property `types` # Corresponds to the JSON property `types`
# @return [Array<String>] # @return [Array<String>]
attr_accessor :types attr_accessor :types
@ -396,24 +375,19 @@ module Google
end end
end end
# Life of a query: # Life of a query: - When a game starts in a new location, your game server
# - When a game starts in a new location, your game server issues a # issues a SamplePlayableLocations request. The request specifies the S2 cell,
# SamplePlayableLocations # and contains one or more "criteria" for filtering: - Criterion 0: i locations
# request. The request specifies the S2 cell, and contains one or more # for long-lived bases, or level 0 monsters, or... - Criterion 1: j locations
# "criteria" for filtering: # for short-lived bases, or level 1 monsters, ... - Criterion 2: k locations for
# - Criterion 0: i locations for long-lived bases, or level 0 monsters, or... # random objects. - etc (up to 5 criterion may be specified). `
# - Criterion 1: j locations for short-lived bases, or level 1 monsters, ... # PlayableLocationList` will then contain mutually exclusive lists of `
# - Criterion 2: k locations for random objects. # PlayableLocation` objects that satisfy each of the criteria. Think of it as a
# - etc (up to 5 criterion may be specified). # collection of real-world locations that you can then associate with your game
# `PlayableLocationList` will then contain mutually # state. Note: These points are impermanent in nature. E.g, parks can close, and
# exclusive lists of `PlayableLocation` objects that satisfy each of # places can be removed. The response specifies how long you can expect the
# the criteria. Think of it as a collection of real-world locations that you # playable locations to last. Once they expire, you should query the `
# can then associate with your game state. # samplePlayableLocations` API again to get a fresh view of the real world.
# Note: These points are impermanent in nature. E.g, parks can close, and
# places can be removed.
# The response specifies how long you can expect the playable locations to
# last. Once they expire, you should query the `samplePlayableLocations` API
# again to get a fresh view of the real world.
class GoogleMapsPlayablelocationsV3SamplePlayableLocationsRequest class GoogleMapsPlayablelocationsV3SamplePlayableLocationsRequest
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
@ -422,8 +396,8 @@ module Google
# @return [Google::Apis::PlayablelocationsV3::GoogleMapsPlayablelocationsV3SampleAreaFilter] # @return [Google::Apis::PlayablelocationsV3::GoogleMapsPlayablelocationsV3SampleAreaFilter]
attr_accessor :area_filter attr_accessor :area_filter
# Required. Specifies one or more (up to 5) criteria for filtering the # Required. Specifies one or more (up to 5) criteria for filtering the returned
# returned playable locations. # playable locations.
# Corresponds to the JSON property `criteria` # Corresponds to the JSON property `criteria`
# @return [Array<Google::Apis::PlayablelocationsV3::GoogleMapsPlayablelocationsV3SampleCriterion>] # @return [Array<Google::Apis::PlayablelocationsV3::GoogleMapsPlayablelocationsV3SampleCriterion>]
attr_accessor :criteria attr_accessor :criteria
@ -439,26 +413,22 @@ module Google
end end
end end
# Response for the # Response for the SamplePlayableLocations method.
# SamplePlayableLocations
# method.
class GoogleMapsPlayablelocationsV3SamplePlayableLocationsResponse class GoogleMapsPlayablelocationsV3SamplePlayableLocationsResponse
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
# Each PlayableLocation object corresponds to a game_object_type specified # Each PlayableLocation object corresponds to a game_object_type specified in
# in the request. # the request.
# Corresponds to the JSON property `locationsPerGameObjectType` # Corresponds to the JSON property `locationsPerGameObjectType`
# @return [Hash<String,Google::Apis::PlayablelocationsV3::GoogleMapsPlayablelocationsV3SamplePlayableLocationList>] # @return [Hash<String,Google::Apis::PlayablelocationsV3::GoogleMapsPlayablelocationsV3SamplePlayableLocationList>]
attr_accessor :locations_per_game_object_type attr_accessor :locations_per_game_object_type
# Required. Specifies the "time-to-live" for the set of playable locations. You # Required. Specifies the "time-to-live" for the set of playable locations. You
# can use # can use this value to determine how long to cache the set of playable
# this value to determine how long to cache the set of playable locations. # locations. After this length of time, your back-end game server should issue a
# After this length of time, your back-end game server should issue a new # new SamplePlayableLocations request to get a fresh set of playable locations (
# SamplePlayableLocations # because for example, they might have been removed, a park might have closed
# request to get a fresh set of playable locations (because for example, they # for the day, a business might have closed permanently).
# might have been removed, a park might have closed for the day, a
# business might have closed permanently).
# Corresponds to the JSON property `ttl` # Corresponds to the JSON property `ttl`
# @return [String] # @return [String]
attr_accessor :ttl attr_accessor :ttl
@ -479,42 +449,28 @@ module Google
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
# Required. The minimum spacing between any two playable locations, measured in # Required. The minimum spacing between any two playable locations, measured in
# meters. # meters. The minimum value is 30. The maximum value is 1000. Inputs will be
# The minimum value is 30. # rounded up to the next 10 meter interval. The default value is 200m. Set this
# The maximum value is 1000. # field to remove tight clusters of playable locations. Note: The spacing is a
# Inputs will be rounded up to the next 10 meter interval. # greedy algorithm. It optimizes for selecting the highest ranking locations
# The default value is 200m. # first, not to maximize the number of locations selected. Consider the
# Set this field to remove tight clusters of playable locations. # following scenario: * Rank: A: 2, B: 1, C: 3. * Distance: A--200m--B--200m--C
# Note: # If spacing=250, it will pick the highest ranked location [B], not [A, C]. Note:
# The spacing is a greedy algorithm. It optimizes for selecting the highest
# ranking locations first, not to maximize the number of locations selected.
# Consider the following scenario:
# * Rank: A: 2, B: 1, C: 3.
# * Distance: A--200m--B--200m--C
# If spacing=250, it will pick the highest ranked location [B], not [A, C].
# Note:
# Spacing works within the game object type itself, as well as the previous # Spacing works within the game object type itself, as well as the previous
# ones. # ones. Suppose three game object types, each with the following spacing: * X:
# Suppose three game object types, each with the following spacing: # 400m, Y: undefined, Z: 200m. 1. Add locations for X, within 400m of each other.
# * X: 400m, Y: undefined, Z: 200m. # 2. Add locations for Y, without any spacing. 3. Finally, add locations for Z
# 1. Add locations for X, within 400m of each other. # within 200m of each other as well X and Y. The distance diagram between those
# 2. Add locations for Y, without any spacing. # locations end up as: * From->To. * X->X: 400m * Y->X, Y->Y: unspecified. * Z->
# 3. Finally, add locations for Z within 200m of each other as well X and Y. # X, Z->Y, Z->Z: 200m.
# The distance diagram between those locations end up as:
# * From->To.
# * X->X: 400m
# * Y->X, Y->Y: unspecified.
# * Z->X, Z->Y, Z->Z: 200m.
# Corresponds to the JSON property `minSpacingMeters` # Corresponds to the JSON property `minSpacingMeters`
# @return [Float] # @return [Float]
attr_accessor :min_spacing_meters attr_accessor :min_spacing_meters
# Specifies whether the minimum spacing constraint applies to the # Specifies whether the minimum spacing constraint applies to the center-point
# center-point or to the snapped point of playable locations. The default # or to the snapped point of playable locations. The default value is `
# value is `CENTER_POINT`. # CENTER_POINT`. If a snapped point is not available for a playable location,
# If a snapped point is not available for a playable location, its # its center-point is used instead. Set this to the point type used in your game.
# center-point is used instead.
# Set this to the point type used in your game.
# Corresponds to the JSON property `pointType` # Corresponds to the JSON property `pointType`
# @return [String] # @return [String]
attr_accessor :point_type attr_accessor :point_type
@ -534,46 +490,44 @@ module Google
class GoogleMapsUnityClientInfo class GoogleMapsUnityClientInfo
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
# API client name and version. For example, the SDK calling the API. The # API client name and version. For example, the SDK calling the API. The exact
# exact format is up to the client. # format is up to the client.
# Corresponds to the JSON property `apiClient` # Corresponds to the JSON property `apiClient`
# @return [String] # @return [String]
attr_accessor :api_client attr_accessor :api_client
# Application ID, such as the package name on Android and the bundle # Application ID, such as the package name on Android and the bundle identifier
# identifier on iOS platforms. # on iOS platforms.
# Corresponds to the JSON property `applicationId` # Corresponds to the JSON property `applicationId`
# @return [String] # @return [String]
attr_accessor :application_id attr_accessor :application_id
# Application version number, such as "1.2.3". The exact format is # Application version number, such as "1.2.3". The exact format is application-
# application-dependent. # dependent.
# Corresponds to the JSON property `applicationVersion` # Corresponds to the JSON property `applicationVersion`
# @return [String] # @return [String]
attr_accessor :application_version attr_accessor :application_version
# Device model as reported by the device. The exact format is # Device model as reported by the device. The exact format is platform-dependent.
# platform-dependent.
# Corresponds to the JSON property `deviceModel` # Corresponds to the JSON property `deviceModel`
# @return [String] # @return [String]
attr_accessor :device_model attr_accessor :device_model
# Language code (in BCP-47 format) indicating the UI language of the client. # Language code (in BCP-47 format) indicating the UI language of the client.
# Examples are "en", "en-US" or "ja-Latn". For more information, see # Examples are "en", "en-US" or "ja-Latn". For more information, see http://www.
# http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. # unicode.org/reports/tr35/#Unicode_locale_identifier.
# Corresponds to the JSON property `languageCode` # Corresponds to the JSON property `languageCode`
# @return [String] # @return [String]
attr_accessor :language_code attr_accessor :language_code
# Operating system name and version as reported by the OS. For example, # Operating system name and version as reported by the OS. For example, "Mac OS
# "Mac OS X 10.10.4". The exact format is platform-dependent. # X 10.10.4". The exact format is platform-dependent.
# Corresponds to the JSON property `operatingSystem` # Corresponds to the JSON property `operatingSystem`
# @return [String] # @return [String]
attr_accessor :operating_system attr_accessor :operating_system
# Build number/version of the operating system. e.g., the contents of # Build number/version of the operating system. e.g., the contents of android.os.
# android.os.Build.ID in Android, or the contents of sysctl "kern.osversion" # Build.ID in Android, or the contents of sysctl "kern.osversion" in iOS.
# in iOS.
# Corresponds to the JSON property `operatingSystemBuild` # Corresponds to the JSON property `operatingSystemBuild`
# @return [String] # @return [String]
attr_accessor :operating_system_build attr_accessor :operating_system_build
@ -602,9 +556,8 @@ module Google
# An object representing a latitude/longitude pair. This is expressed as a pair # An object representing a latitude/longitude pair. This is expressed as a pair
# of doubles representing degrees latitude and degrees longitude. Unless # of doubles representing degrees latitude and degrees longitude. Unless
# specified otherwise, this must conform to the # specified otherwise, this must conform to the WGS84 standard. Values must be
# <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 # within normalized ranges.
# standard</a>. Values must be within normalized ranges.
class GoogleTypeLatLng class GoogleTypeLatLng
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable

20
generated/google/apis/playablelocations_v3/service.rb
View File

@ -48,9 +48,9 @@ module Google
end end
# Logs new events when playable locations are displayed, and when they are # Logs new events when playable locations are displayed, and when they are
# interacted with. # interacted with. Impressions are not partially saved; either all impressions
# Impressions are not partially saved; either all impressions are saved and # are saved and this request succeeds, or no impressions are saved, and this
# this request succeeds, or no impressions are saved, and this request fails. # request fails.
# @param [Google::Apis::PlayablelocationsV3::GoogleMapsPlayablelocationsV3LogImpressionsRequest] google_maps_playablelocations_v3_log_impressions_request_object # @param [Google::Apis::PlayablelocationsV3::GoogleMapsPlayablelocationsV3LogImpressionsRequest] google_maps_playablelocations_v3_log_impressions_request_object
# @param [String] fields # @param [String] fields
# Selector specifying which fields to include in a partial response. # Selector specifying which fields to include in a partial response.
@ -80,9 +80,9 @@ module Google
execute_or_queue_command(command, &block) execute_or_queue_command(command, &block)
end end
# Logs bad playable location reports submitted by players. # Logs bad playable location reports submitted by players. Reports are not
# Reports are not partially saved; either all reports are saved and this # partially saved; either all reports are saved and this request succeeds, or no
# request succeeds, or no reports are saved, and this request fails. # reports are saved, and this request fails.
# @param [Google::Apis::PlayablelocationsV3::GoogleMapsPlayablelocationsV3LogPlayerReportsRequest] google_maps_playablelocations_v3_log_player_reports_request_object # @param [Google::Apis::PlayablelocationsV3::GoogleMapsPlayablelocationsV3LogPlayerReportsRequest] google_maps_playablelocations_v3_log_player_reports_request_object
# @param [String] fields # @param [String] fields
# Selector specifying which fields to include in a partial response. # Selector specifying which fields to include in a partial response.
@ -112,10 +112,10 @@ module Google
execute_or_queue_command(command, &block) execute_or_queue_command(command, &block)
end end
# Returns a set of playable locations that lie within a specified area, # Returns a set of playable locations that lie within a specified area, that
# that satisfy optional filter criteria. # satisfy optional filter criteria. Note: Identical `SamplePlayableLocations`
# Note: Identical `SamplePlayableLocations` requests can return different # requests can return different results as the state of the world changes over
# results as the state of the world changes over time. # time.
# @param [Google::Apis::PlayablelocationsV3::GoogleMapsPlayablelocationsV3SamplePlayableLocationsRequest] google_maps_playablelocations_v3_sample_playable_locations_request_object # @param [Google::Apis::PlayablelocationsV3::GoogleMapsPlayablelocationsV3SamplePlayableLocationsRequest] google_maps_playablelocations_v3_sample_playable_locations_request_object
# @param [String] fields # @param [String] fields
# Selector specifying which fields to include in a partial response. # Selector specifying which fields to include in a partial response.

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

@ -26,7 +26,7 @@ module Google
# @see https://console.cloud.google.com/apis/api/securitycenter.googleapis.com/overview # @see https://console.cloud.google.com/apis/api/securitycenter.googleapis.com/overview
module SecuritycenterV1 module SecuritycenterV1
VERSION = 'V1' VERSION = 'V1'
REVISION = '20200731' REVISION = '20200806'
# View and manage your data across Google Cloud Platform services # View and manage your data across Google Cloud Platform services
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'

6
generated/google/apis/securitycenter_v1/classes.rb
View File

@ -731,6 +731,11 @@ module Google
# @return [Google::Apis::SecuritycenterV1::GoogleCloudSecuritycenterV1p1beta1SecurityMarks] # @return [Google::Apis::SecuritycenterV1::GoogleCloudSecuritycenterV1p1beta1SecurityMarks]
attr_accessor :security_marks attr_accessor :security_marks
# The severity of the finding.
# Corresponds to the JSON property `severity`
# @return [String]
attr_accessor :severity
# Source specific properties. These properties are managed by the source that # Source specific properties. These properties are managed by the source that
# writes the finding. The key names in the source_properties map must be between # writes the finding. The key names in the source_properties map must be between
# 1 and 255 characters, and must start with a letter and contain alphanumeric # 1 and 255 characters, and must start with a letter and contain alphanumeric
@ -758,6 +763,7 @@ module Google
@parent = args[:parent] if args.key?(:parent) @parent = args[:parent] if args.key?(:parent)
@resource_name = args[:resource_name] if args.key?(:resource_name) @resource_name = args[:resource_name] if args.key?(:resource_name)
@security_marks = args[:security_marks] if args.key?(:security_marks) @security_marks = args[:security_marks] if args.key?(:security_marks)
@severity = args[:severity] if args.key?(:severity)
@source_properties = args[:source_properties] if args.key?(:source_properties) @source_properties = args[:source_properties] if args.key?(:source_properties)
@state = args[:state] if args.key?(:state) @state = args[:state] if args.key?(:state)
end end

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

@ -493,6 +493,7 @@ module Google
property :resource_name, as: 'resourceName' property :resource_name, as: 'resourceName'
property :security_marks, as: 'securityMarks', class: Google::Apis::SecuritycenterV1::GoogleCloudSecuritycenterV1p1beta1SecurityMarks, decorator: Google::Apis::SecuritycenterV1::GoogleCloudSecuritycenterV1p1beta1SecurityMarks::Representation property :security_marks, as: 'securityMarks', class: Google::Apis::SecuritycenterV1::GoogleCloudSecuritycenterV1p1beta1SecurityMarks, decorator: Google::Apis::SecuritycenterV1::GoogleCloudSecuritycenterV1p1beta1SecurityMarks::Representation
property :severity, as: 'severity'
hash :source_properties, as: 'sourceProperties' hash :source_properties, as: 'sourceProperties'
property :state, as: 'state' property :state, as: 'state'
end end

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

@ -26,7 +26,7 @@ module Google
# @see https://console.cloud.google.com/apis/api/securitycenter.googleapis.com/overview # @see https://console.cloud.google.com/apis/api/securitycenter.googleapis.com/overview
module SecuritycenterV1beta1 module SecuritycenterV1beta1
VERSION = 'V1beta1' VERSION = 'V1beta1'
REVISION = '20200731' REVISION = '20200806'
# View and manage your data across Google Cloud Platform services # View and manage your data across Google Cloud Platform services
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'

6
generated/google/apis/securitycenter_v1beta1/classes.rb
View File

@ -867,6 +867,11 @@ module Google
# @return [Google::Apis::SecuritycenterV1beta1::GoogleCloudSecuritycenterV1p1beta1SecurityMarks] # @return [Google::Apis::SecuritycenterV1beta1::GoogleCloudSecuritycenterV1p1beta1SecurityMarks]
attr_accessor :security_marks attr_accessor :security_marks
# The severity of the finding.
# Corresponds to the JSON property `severity`
# @return [String]
attr_accessor :severity
# Source specific properties. These properties are managed by the source that # Source specific properties. These properties are managed by the source that
# writes the finding. The key names in the source_properties map must be between # writes the finding. The key names in the source_properties map must be between
# 1 and 255 characters, and must start with a letter and contain alphanumeric # 1 and 255 characters, and must start with a letter and contain alphanumeric
@ -894,6 +899,7 @@ module Google
@parent = args[:parent] if args.key?(:parent) @parent = args[:parent] if args.key?(:parent)
@resource_name = args[:resource_name] if args.key?(:resource_name) @resource_name = args[:resource_name] if args.key?(:resource_name)
@security_marks = args[:security_marks] if args.key?(:security_marks) @security_marks = args[:security_marks] if args.key?(:security_marks)
@severity = args[:severity] if args.key?(:severity)
@source_properties = args[:source_properties] if args.key?(:source_properties) @source_properties = args[:source_properties] if args.key?(:source_properties)
@state = args[:state] if args.key?(:state) @state = args[:state] if args.key?(:state)
end end

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

@ -504,6 +504,7 @@ module Google
property :resource_name, as: 'resourceName' property :resource_name, as: 'resourceName'
property :security_marks, as: 'securityMarks', class: Google::Apis::SecuritycenterV1beta1::GoogleCloudSecuritycenterV1p1beta1SecurityMarks, decorator: Google::Apis::SecuritycenterV1beta1::GoogleCloudSecuritycenterV1p1beta1SecurityMarks::Representation property :security_marks, as: 'securityMarks', class: Google::Apis::SecuritycenterV1beta1::GoogleCloudSecuritycenterV1p1beta1SecurityMarks, decorator: Google::Apis::SecuritycenterV1beta1::GoogleCloudSecuritycenterV1p1beta1SecurityMarks::Representation
property :severity, as: 'severity'
hash :source_properties, as: 'sourceProperties' hash :source_properties, as: 'sourceProperties'
property :state, as: 'state' property :state, as: 'state'
end end

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

@ -26,7 +26,7 @@ module Google
# @see https://console.cloud.google.com/apis/api/securitycenter.googleapis.com/overview # @see https://console.cloud.google.com/apis/api/securitycenter.googleapis.com/overview
module SecuritycenterV1p1alpha1 module SecuritycenterV1p1alpha1
VERSION = 'V1p1alpha1' VERSION = 'V1p1alpha1'
REVISION = '20200731' REVISION = '20200806'
# View and manage your data across Google Cloud Platform services # View and manage your data across Google Cloud Platform services
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'

6
generated/google/apis/securitycenter_v1p1alpha1/classes.rb
View File

@ -397,6 +397,11 @@ module Google
# @return [Google::Apis::SecuritycenterV1p1alpha1::GoogleCloudSecuritycenterV1p1beta1SecurityMarks] # @return [Google::Apis::SecuritycenterV1p1alpha1::GoogleCloudSecuritycenterV1p1beta1SecurityMarks]
attr_accessor :security_marks attr_accessor :security_marks
# The severity of the finding.
# Corresponds to the JSON property `severity`
# @return [String]
attr_accessor :severity
# Source specific properties. These properties are managed by the source that # Source specific properties. These properties are managed by the source that
# writes the finding. The key names in the source_properties map must be between # writes the finding. The key names in the source_properties map must be between
# 1 and 255 characters, and must start with a letter and contain alphanumeric # 1 and 255 characters, and must start with a letter and contain alphanumeric
@ -424,6 +429,7 @@ module Google
@parent = args[:parent] if args.key?(:parent) @parent = args[:parent] if args.key?(:parent)
@resource_name = args[:resource_name] if args.key?(:resource_name) @resource_name = args[:resource_name] if args.key?(:resource_name)
@security_marks = args[:security_marks] if args.key?(:security_marks) @security_marks = args[:security_marks] if args.key?(:security_marks)
@severity = args[:severity] if args.key?(:severity)
@source_properties = args[:source_properties] if args.key?(:source_properties) @source_properties = args[:source_properties] if args.key?(:source_properties)
@state = args[:state] if args.key?(:state) @state = args[:state] if args.key?(:state)
end end

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

@ -225,6 +225,7 @@ module Google
property :resource_name, as: 'resourceName' property :resource_name, as: 'resourceName'
property :security_marks, as: 'securityMarks', class: Google::Apis::SecuritycenterV1p1alpha1::GoogleCloudSecuritycenterV1p1beta1SecurityMarks, decorator: Google::Apis::SecuritycenterV1p1alpha1::GoogleCloudSecuritycenterV1p1beta1SecurityMarks::Representation property :security_marks, as: 'securityMarks', class: Google::Apis::SecuritycenterV1p1alpha1::GoogleCloudSecuritycenterV1p1beta1SecurityMarks, decorator: Google::Apis::SecuritycenterV1p1alpha1::GoogleCloudSecuritycenterV1p1beta1SecurityMarks::Representation
property :severity, as: 'severity'
hash :source_properties, as: 'sourceProperties' hash :source_properties, as: 'sourceProperties'
property :state, as: 'state' property :state, as: 'state'
end end

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

@ -26,7 +26,7 @@ module Google
# @see https://console.cloud.google.com/apis/api/securitycenter.googleapis.com/overview # @see https://console.cloud.google.com/apis/api/securitycenter.googleapis.com/overview
module SecuritycenterV1p1beta1 module SecuritycenterV1p1beta1
VERSION = 'V1p1beta1' VERSION = 'V1p1beta1'
REVISION = '20200731' REVISION = '20200806'
# View and manage your data across Google Cloud Platform services # View and manage your data across Google Cloud Platform services
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'

6
generated/google/apis/securitycenter_v1p1beta1/classes.rb
View File

@ -662,6 +662,11 @@ module Google
# @return [Google::Apis::SecuritycenterV1p1beta1::GoogleCloudSecuritycenterV1p1beta1SecurityMarks] # @return [Google::Apis::SecuritycenterV1p1beta1::GoogleCloudSecuritycenterV1p1beta1SecurityMarks]
attr_accessor :security_marks attr_accessor :security_marks
# The severity of the finding.
# Corresponds to the JSON property `severity`
# @return [String]
attr_accessor :severity
# Source specific properties. These properties are managed by the source that # Source specific properties. These properties are managed by the source that
# writes the finding. The key names in the source_properties map must be between # writes the finding. The key names in the source_properties map must be between
# 1 and 255 characters, and must start with a letter and contain alphanumeric # 1 and 255 characters, and must start with a letter and contain alphanumeric
@ -689,6 +694,7 @@ module Google
@parent = args[:parent] if args.key?(:parent) @parent = args[:parent] if args.key?(:parent)
@resource_name = args[:resource_name] if args.key?(:resource_name) @resource_name = args[:resource_name] if args.key?(:resource_name)
@security_marks = args[:security_marks] if args.key?(:security_marks) @security_marks = args[:security_marks] if args.key?(:security_marks)
@severity = args[:severity] if args.key?(:severity)
@source_properties = args[:source_properties] if args.key?(:source_properties) @source_properties = args[:source_properties] if args.key?(:source_properties)
@state = args[:state] if args.key?(:state) @state = args[:state] if args.key?(:state)
end end

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

@ -459,6 +459,7 @@ module Google
property :resource_name, as: 'resourceName' property :resource_name, as: 'resourceName'
property :security_marks, as: 'securityMarks', class: Google::Apis::SecuritycenterV1p1beta1::GoogleCloudSecuritycenterV1p1beta1SecurityMarks, decorator: Google::Apis::SecuritycenterV1p1beta1::GoogleCloudSecuritycenterV1p1beta1SecurityMarks::Representation property :security_marks, as: 'securityMarks', class: Google::Apis::SecuritycenterV1p1beta1::GoogleCloudSecuritycenterV1p1beta1SecurityMarks, decorator: Google::Apis::SecuritycenterV1p1beta1::GoogleCloudSecuritycenterV1p1beta1SecurityMarks::Representation
property :severity, as: 'severity'
hash :source_properties, as: 'sourceProperties' hash :source_properties, as: 'sourceProperties'
property :state, as: 'state' property :state, as: 'state'
end end

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

@ -25,7 +25,7 @@ module Google
# @see https://developers.google.com/slides/ # @see https://developers.google.com/slides/
module SlidesV1 module SlidesV1
VERSION = 'V1' VERSION = 'V1'
REVISION = '20200611' REVISION = '20200803'
# See, edit, create, and delete all of your Google Drive files # See, edit, create, and delete all of your Google Drive files
AUTH_DRIVE = 'https://www.googleapis.com/auth/drive' AUTH_DRIVE = 'https://www.googleapis.com/auth/drive'

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

File diff suppressed because it is too large Load Diff

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

@ -47,23 +47,19 @@ module Google
@batch_path = 'batch' @batch_path = 'batch'
end end
# Applies one or more updates to the presentation. # Applies one or more updates to the presentation. Each request is validated
# Each request is validated before # before being applied. If any request is not valid, then the entire request
# being applied. If any request is not valid, then the entire request will # will fail and nothing will be applied. Some requests have replies to give you
# fail and nothing will be applied. # some information about how they are applied. Other requests do not need to
# Some requests have replies to # return information; these each return an empty reply. The order of replies
# give you some information about how they are applied. Other requests do # matches that of the requests. For example, suppose you call batchUpdate with
# not need to return information; these each return an empty reply. # four updates, and only the third one returns information. The response would
# The order of replies matches that of the requests. # have two empty replies: the reply to the third request, and another empty
# For example, suppose you call batchUpdate with four updates, and only the # reply, in that order. Because other users may be editing the presentation, the
# third one returns information. The response would have two empty replies: # presentation might not exactly reflect your changes: your changes may be
# the reply to the third request, and another empty reply, in that order. # altered with respect to collaborator changes. If there are no collaborators,
# Because other users may be editing the presentation, the presentation # the presentation should reflect your changes. In any case, the updates in your
# might not exactly reflect your changes: your changes may # request are guaranteed to be applied together atomically.
# be altered with respect to collaborator changes. If there are no
# collaborators, the presentation should reflect your changes. In any case,
# the updates in your request are guaranteed to be applied together
# atomically.
# @param [String] presentation_id # @param [String] presentation_id
# The presentation to apply the updates to. # The presentation to apply the updates to.
# @param [Google::Apis::SlidesV1::BatchUpdatePresentationRequest] batch_update_presentation_request_object # @param [Google::Apis::SlidesV1::BatchUpdatePresentationRequest] batch_update_presentation_request_object
@ -96,11 +92,10 @@ module Google
execute_or_queue_command(command, &block) execute_or_queue_command(command, &block)
end end
# Creates a blank presentation using the title given in the request. If a # Creates a blank presentation using the title given in the request. If a `
# `presentationId` is provided, it is used as the ID of the new presentation. # presentationId` is provided, it is used as the ID of the new presentation.
# Otherwise, a new ID is generated. Other fields in the request, including # Otherwise, a new ID is generated. Other fields in the request, including any
# any provided content, are ignored. # provided content, are ignored. Returns the created presentation.
# Returns the created presentation.
# @param [Google::Apis::SlidesV1::Presentation] presentation_object # @param [Google::Apis::SlidesV1::Presentation] presentation_object
# @param [String] fields # @param [String] fields
# Selector specifying which fields to include in a partial response. # Selector specifying which fields to include in a partial response.
@ -194,20 +189,18 @@ module Google
end end
# Generates a thumbnail of the latest version of the specified page in the # Generates a thumbnail of the latest version of the specified page in the
# presentation and returns a URL to the thumbnail image. # presentation and returns a URL to the thumbnail image. This request counts as
# This request counts as an [expensive read request](/slides/limits) for # an [expensive read request](/slides/limits) for quota purposes.
# quota purposes.
# @param [String] presentation_id # @param [String] presentation_id
# The ID of the presentation to retrieve. # The ID of the presentation to retrieve.
# @param [String] page_object_id # @param [String] page_object_id
# The object ID of the page whose thumbnail to retrieve. # The object ID of the page whose thumbnail to retrieve.
# @param [String] thumbnail_properties_mime_type # @param [String] thumbnail_properties_mime_type
# The optional mime type of the thumbnail image. # The optional mime type of the thumbnail image. If you don't specify the mime
# If you don't specify the mime type, the mime type defaults to PNG. # type, the mime type defaults to PNG.
# @param [String] thumbnail_properties_thumbnail_size # @param [String] thumbnail_properties_thumbnail_size
# The optional thumbnail image size. # The optional thumbnail image size. If you don't specify the size, the server
# If you don't specify the size, the server chooses a default size of the # chooses a default size of the image.
# image.
# @param [String] fields # @param [String] fields
# Selector specifying which fields to include in a partial response. # Selector specifying which fields to include in a partial response.
# @param [String] quota_user # @param [String] quota_user

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

@ -27,7 +27,7 @@ module Google
# @see https://developers.google.com/streetview/publish/ # @see https://developers.google.com/streetview/publish/
module StreetviewpublishV1 module StreetviewpublishV1
VERSION = 'V1' VERSION = 'V1'
REVISION = '20200224' REVISION = '20200809'
# Publish and manage your 360 photos on Google Street View # Publish and manage your 360 photos on Google Street View
AUTH_STREETVIEWPUBLISH = 'https://www.googleapis.com/auth/streetviewpublish' AUTH_STREETVIEWPUBLISH = 'https://www.googleapis.com/auth/streetviewpublish'

250
generated/google/apis/streetviewpublish_v1/classes.rb
View File

@ -26,9 +26,8 @@ module Google
class BatchDeletePhotosRequest class BatchDeletePhotosRequest
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
# Required. IDs of the Photos. HTTP # Required. IDs of the Photos. HTTP GET requests require the following syntax
# GET requests require the following syntax for the URL query parameter: # for the URL query parameter: `photoIds=&photoIds=&...`.
# `photoIds=<id1>&photoIds=<id2>&...`.
# Corresponds to the JSON property `photoIds` # Corresponds to the JSON property `photoIds`
# @return [Array<String>] # @return [Array<String>]
attr_accessor :photo_ids attr_accessor :photo_ids
@ -43,13 +42,11 @@ module Google
end end
end end
# Response to batch delete of one or more # Response to batch delete of one or more Photos.
# Photos.
class BatchDeletePhotosResponse class BatchDeletePhotosResponse
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
# The status for the operation to delete a single # The status for the operation to delete a single Photo in the batch request.
# Photo in the batch request.
# Corresponds to the JSON property `status` # Corresponds to the JSON property `status`
# @return [Array<Google::Apis::StreetviewpublishV1::Status>] # @return [Array<Google::Apis::StreetviewpublishV1::Status>]
attr_accessor :status attr_accessor :status
@ -68,10 +65,8 @@ module Google
class BatchGetPhotosResponse class BatchGetPhotosResponse
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
# List of results for each individual # List of results for each individual Photo requested, in the same order as the
# Photo requested, in the same order as # requests in BatchGetPhotos.
# the requests in
# BatchGetPhotos.
# Corresponds to the JSON property `results` # Corresponds to the JSON property `results`
# @return [Array<Google::Apis::StreetviewpublishV1::PhotoResponse>] # @return [Array<Google::Apis::StreetviewpublishV1::PhotoResponse>]
attr_accessor :results attr_accessor :results
@ -86,13 +81,12 @@ module Google
end end
end end
# Request to update the metadata of photos. # Request to update the metadata of photos. Updating the pixels of photos is not
# Updating the pixels of photos is not supported. # supported.
class BatchUpdatePhotosRequest class BatchUpdatePhotosRequest
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
# Required. List of # Required. List of UpdatePhotoRequests.
# UpdatePhotoRequests.
# Corresponds to the JSON property `updatePhotoRequests` # Corresponds to the JSON property `updatePhotoRequests`
# @return [Array<Google::Apis::StreetviewpublishV1::UpdatePhotoRequest>] # @return [Array<Google::Apis::StreetviewpublishV1::UpdatePhotoRequest>]
attr_accessor :update_photo_requests attr_accessor :update_photo_requests
@ -107,14 +101,12 @@ module Google
end end
end end
# Response to batch update of metadata of one or more # Response to batch update of metadata of one or more Photos.
# Photos.
class BatchUpdatePhotosResponse class BatchUpdatePhotosResponse
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
# List of results for each individual # List of results for each individual Photo updated, in the same order as the
# Photo updated, in the same order as # request.
# the request.
# Corresponds to the JSON property `results` # Corresponds to the JSON property `results`
# @return [Array<Google::Apis::StreetviewpublishV1::PhotoResponse>] # @return [Array<Google::Apis::StreetviewpublishV1::PhotoResponse>]
attr_accessor :results attr_accessor :results
@ -148,13 +140,11 @@ module Google
end end
end end
# A generic empty message that you can re-use to avoid defining duplicated # A generic empty message that you can re-use to avoid defining duplicated empty
# empty messages in your APIs. A typical example is to use it as the request # messages in your APIs. A typical example is to use it as the request or the
# or the response type of an API method. For instance: # response type of an API method. For instance: service Foo ` rpc Bar(google.
# service Foo ` # protobuf.Empty) returns (google.protobuf.Empty); ` The JSON representation for
# rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); # `Empty` is empty JSON object ````.
# `
# The JSON representation for `Empty` is empty JSON object ````.
class Empty class Empty
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
@ -169,9 +159,8 @@ module Google
# An object representing a latitude/longitude pair. This is expressed as a pair # An object representing a latitude/longitude pair. This is expressed as a pair
# of doubles representing degrees latitude and degrees longitude. Unless # of doubles representing degrees latitude and degrees longitude. Unless
# specified otherwise, this must conform to the # specified otherwise, this must conform to the WGS84 standard. Values must be
# <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 # within normalized ranges.
# standard</a>. Values must be within normalized ranges.
class LatLng class LatLng
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
@ -200,16 +189,16 @@ module Google
class Level class Level
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
# Required. A name assigned to this Level, restricted to 3 characters. # Required. A name assigned to this Level, restricted to 3 characters. Consider
# Consider how the elevator buttons would be labeled for this level if there # how the elevator buttons would be labeled for this level if there was an
# was an elevator. # elevator.
# Corresponds to the JSON property `name` # Corresponds to the JSON property `name`
# @return [String] # @return [String]
attr_accessor :name attr_accessor :name
# Floor number, used for ordering. 0 indicates the ground level, 1 indicates # Floor number, used for ordering. 0 indicates the ground level, 1 indicates the
# the first level above ground level, -1 indicates the first level under # first level above ground level, -1 indicates the first level under ground
# ground level. Non-integer values are OK. # level. Non-integer values are OK.
# Corresponds to the JSON property `number` # Corresponds to the JSON property `number`
# @return [Float] # @return [Float]
attr_accessor :number attr_accessor :number
@ -235,9 +224,8 @@ module Google
# @return [String] # @return [String]
attr_accessor :next_page_token attr_accessor :next_page_token
# List of photos. The # List of photos. The pageSize field in the request determines the number of
# pageSize field # items returned.
# in the request determines the number of items returned.
# Corresponds to the JSON property `photos` # Corresponds to the JSON property `photos`
# @return [Array<Google::Apis::StreetviewpublishV1::Photo>] # @return [Array<Google::Apis::StreetviewpublishV1::Photo>]
attr_accessor :photos attr_accessor :photos
@ -258,47 +246,45 @@ module Google
class Operation class Operation
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
# If the value is `false`, it means the operation is still in progress. # If the value is `false`, it means the operation is still in progress. If `true`
# If `true`, the operation is completed, and either `error` or `response` is # , the operation is completed, and either `error` or `response` is available.
# available.
# Corresponds to the JSON property `done` # Corresponds to the JSON property `done`
# @return [Boolean] # @return [Boolean]
attr_accessor :done attr_accessor :done
alias_method :done?, :done alias_method :done?, :done
# The `Status` type defines a logical error model that is suitable for # The `Status` type defines a logical error model that is suitable for different
# different programming environments, including REST APIs and RPC APIs. It is # programming environments, including REST APIs and RPC APIs. It is used by [
# used by [gRPC](https://github.com/grpc). Each `Status` message contains # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
# three pieces of data: error code, error message, and error details. # data: error code, error message, and error details. You can find out more
# You can find out more about this error model and how to work with it in the # about this error model and how to work with it in the [API Design Guide](https:
# [API Design Guide](https://cloud.google.com/apis/design/errors). # //cloud.google.com/apis/design/errors).
# Corresponds to the JSON property `error` # Corresponds to the JSON property `error`
# @return [Google::Apis::StreetviewpublishV1::Status] # @return [Google::Apis::StreetviewpublishV1::Status]
attr_accessor :error attr_accessor :error
# Service-specific metadata associated with the operation. It typically # Service-specific metadata associated with the operation. It typically contains
# contains progress information and common metadata such as create time. # progress information and common metadata such as create time. Some services
# Some services might not provide such metadata. Any method that returns a # might not provide such metadata. Any method that returns a long-running
# long-running operation should document the metadata type, if any. # operation should document the metadata type, if any.
# Corresponds to the JSON property `metadata` # Corresponds to the JSON property `metadata`
# @return [Hash<String,Object>] # @return [Hash<String,Object>]
attr_accessor :metadata attr_accessor :metadata
# The server-assigned name, which is only unique within the same service that # The server-assigned name, which is only unique within the same service that
# originally returns it. If you use the default HTTP mapping, the # originally returns it. If you use the default HTTP mapping, the `name` should
# `name` should be a resource name ending with `operations/`unique_id``. # be a resource name ending with `operations/`unique_id``.
# Corresponds to the JSON property `name` # Corresponds to the JSON property `name`
# @return [String] # @return [String]
attr_accessor :name attr_accessor :name
# The normal response of the operation in case of success. If the original # 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 # method returns no data on success, such as `Delete`, the response is `google.
# `google.protobuf.Empty`. If the original method is standard # protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`,
# `Get`/`Create`/`Update`, the response should be the resource. For other # the response should be the resource. For other methods, the response should
# methods, the response should have the type `XxxResponse`, where `Xxx` # have the type `XxxResponse`, where `Xxx` is the original method name. For
# is the original method name. For example, if the original method name # example, if the original method name is `TakeSnapshot()`, the inferred
# is `TakeSnapshot()`, the inferred response type is # response type is `TakeSnapshotResponse`.
# `TakeSnapshotResponse`.
# Corresponds to the JSON property `response` # Corresponds to the JSON property `response`
# @return [Hash<String,Object>] # @return [Hash<String,Object>]
attr_accessor :response attr_accessor :response
@ -321,24 +307,20 @@ module Google
class Photo class Photo
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
# Absolute time when the photo was captured. # Absolute time when the photo was captured. When the photo has no exif
# When the photo has no exif timestamp, this is used to set a timestamp in # timestamp, this is used to set a timestamp in the photo metadata.
# the photo metadata.
# Corresponds to the JSON property `captureTime` # Corresponds to the JSON property `captureTime`
# @return [String] # @return [String]
attr_accessor :capture_time attr_accessor :capture_time
# Connections to other photos. A connection represents the link from this # Connections to other photos. A connection represents the link from this photo
# photo to another photo. # to another photo.
# Corresponds to the JSON property `connections` # Corresponds to the JSON property `connections`
# @return [Array<Google::Apis::StreetviewpublishV1::Connection>] # @return [Array<Google::Apis::StreetviewpublishV1::Connection>]
attr_accessor :connections attr_accessor :connections
# Output only. The download URL for the photo bytes. This field is set only # Output only. The download URL for the photo bytes. This field is set only when
# when # GetPhotoRequest.view is set to PhotoView.INCLUDE_DOWNLOAD_URL.
# GetPhotoRequest.view
# is set to
# PhotoView.INCLUDE_DOWNLOAD_URL.
# Corresponds to the JSON property `downloadUrl` # Corresponds to the JSON property `downloadUrl`
# @return [String] # @return [String]
attr_accessor :download_url attr_accessor :download_url
@ -429,12 +411,8 @@ module Google
end end
end end
# Response payload for a single # Response payload for a single Photo in batch operations including
# Photo # BatchGetPhotos and BatchUpdatePhotos.
# in batch operations including
# BatchGetPhotos
# and
# BatchUpdatePhotos.
class PhotoResponse class PhotoResponse
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
@ -443,12 +421,12 @@ module Google
# @return [Google::Apis::StreetviewpublishV1::Photo] # @return [Google::Apis::StreetviewpublishV1::Photo]
attr_accessor :photo attr_accessor :photo
# The `Status` type defines a logical error model that is suitable for # The `Status` type defines a logical error model that is suitable for different
# different programming environments, including REST APIs and RPC APIs. It is # programming environments, including REST APIs and RPC APIs. It is used by [
# used by [gRPC](https://github.com/grpc). Each `Status` message contains # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
# three pieces of data: error code, error message, and error details. # data: error code, error message, and error details. You can find out more
# You can find out more about this error model and how to work with it in the # about this error model and how to work with it in the [API Design Guide](https:
# [API Design Guide](https://cloud.google.com/apis/design/errors). # //cloud.google.com/apis/design/errors).
# Corresponds to the JSON property `status` # Corresponds to the JSON property `status`
# @return [Google::Apis::StreetviewpublishV1::Status] # @return [Google::Apis::StreetviewpublishV1::Status]
attr_accessor :status attr_accessor :status
@ -468,8 +446,8 @@ module Google
class Place class Place
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
# Output-only. The language_code that the name is localized with. This should # Output-only. The language_code that the name is localized with. This should be
# be the language_code specified in the request, but may be a fallback. # the language_code specified in the request, but may be a fallback.
# Corresponds to the JSON property `languageCode` # Corresponds to the JSON property `languageCode`
# @return [String] # @return [String]
attr_accessor :language_code attr_accessor :language_code
@ -479,8 +457,8 @@ module Google
# @return [String] # @return [String]
attr_accessor :name attr_accessor :name
# Place identifier, as described in # Place identifier, as described in https://developers.google.com/places/place-
# https://developers.google.com/places/place-id. # id.
# Corresponds to the JSON property `placeId` # Corresponds to the JSON property `placeId`
# @return [String] # @return [String]
attr_accessor :place_id attr_accessor :place_id
@ -501,35 +479,31 @@ module Google
class Pose class Pose
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
# The estimated horizontal accuracy of this pose in meters with 68% # The estimated horizontal accuracy of this pose in meters with 68% confidence (
# confidence (one standard deviation). For example, on Android, this value is # one standard deviation). For example, on Android, this value is available from
# available from this method: # this method: https://developer.android.com/reference/android/location/Location#
# https://developer.android.com/reference/android/location/Location#getAccuracy() # getAccuracy(). Other platforms have different methods of obtaining similar
# . # accuracy estimations.
# Other platforms have different methods of obtaining similar accuracy
# estimations.
# Corresponds to the JSON property `accuracyMeters` # Corresponds to the JSON property `accuracyMeters`
# @return [Float] # @return [Float]
attr_accessor :accuracy_meters attr_accessor :accuracy_meters
# Altitude of the pose in meters above WGS84 ellipsoid. # Altitude of the pose in meters above WGS84 ellipsoid. NaN indicates an
# NaN indicates an unmeasured quantity. # unmeasured quantity.
# Corresponds to the JSON property `altitude` # Corresponds to the JSON property `altitude`
# @return [Float] # @return [Float]
attr_accessor :altitude attr_accessor :altitude
# Compass heading, measured at the center of the photo in degrees clockwise # Compass heading, measured at the center of the photo in degrees clockwise from
# from North. Value must be >=0 and <360. # North. Value must be >=0 and <360. NaN indicates an unmeasured quantity.
# NaN indicates an unmeasured quantity.
# Corresponds to the JSON property `heading` # Corresponds to the JSON property `heading`
# @return [Float] # @return [Float]
attr_accessor :heading attr_accessor :heading
# An object representing a latitude/longitude pair. This is expressed as a pair # An object representing a latitude/longitude pair. This is expressed as a pair
# of doubles representing degrees latitude and degrees longitude. Unless # of doubles representing degrees latitude and degrees longitude. Unless
# specified otherwise, this must conform to the # specified otherwise, this must conform to the WGS84 standard. Values must be
# <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 # within normalized ranges.
# standard</a>. Values must be within normalized ranges.
# Corresponds to the JSON property `latLngPair` # Corresponds to the JSON property `latLngPair`
# @return [Google::Apis::StreetviewpublishV1::LatLng] # @return [Google::Apis::StreetviewpublishV1::LatLng]
attr_accessor :lat_lng_pair attr_accessor :lat_lng_pair
@ -539,17 +513,15 @@ module Google
# @return [Google::Apis::StreetviewpublishV1::Level] # @return [Google::Apis::StreetviewpublishV1::Level]
attr_accessor :level attr_accessor :level
# Pitch, measured at the center of the photo in degrees. Value must be >=-90 # Pitch, measured at the center of the photo in degrees. Value must be >=-90 and
# and <= 90. A value of -90 means looking directly down, and a value of 90 # <= 90. A value of -90 means looking directly down, and a value of 90 means
# means looking directly up. # looking directly up. NaN indicates an unmeasured quantity.
# NaN indicates an unmeasured quantity.
# Corresponds to the JSON property `pitch` # Corresponds to the JSON property `pitch`
# @return [Float] # @return [Float]
attr_accessor :pitch attr_accessor :pitch
# Roll, measured in degrees. Value must be >= 0 and <360. A value of 0 # Roll, measured in degrees. Value must be >= 0 and <360. A value of 0 means
# means level with the horizon. # level with the horizon. NaN indicates an unmeasured quantity.
# NaN indicates an unmeasured quantity.
# Corresponds to the JSON property `roll` # Corresponds to the JSON property `roll`
# @return [Float] # @return [Float]
attr_accessor :roll attr_accessor :roll
@ -570,12 +542,12 @@ module Google
end end
end end
# The `Status` type defines a logical error model that is suitable for # The `Status` type defines a logical error model that is suitable for different
# different programming environments, including REST APIs and RPC APIs. It is # programming environments, including REST APIs and RPC APIs. It is used by [
# used by [gRPC](https://github.com/grpc). Each `Status` message contains # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
# three pieces of data: error code, error message, and error details. # data: error code, error message, and error details. You can find out more
# You can find out more about this error model and how to work with it in the # about this error model and how to work with it in the [API Design Guide](https:
# [API Design Guide](https://cloud.google.com/apis/design/errors). # //cloud.google.com/apis/design/errors).
class Status class Status
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
@ -590,9 +562,9 @@ module Google
# @return [Array<Hash<String,Object>>] # @return [Array<Hash<String,Object>>]
attr_accessor :details attr_accessor :details
# A developer-facing error message, which should be in English. Any # A developer-facing error message, which should be in English. Any user-facing
# user-facing error message should be localized and sent in the # error message should be localized and sent in the google.rpc.Status.details
# google.rpc.Status.details field, or localized by the client. # field, or localized by the client.
# Corresponds to the JSON property `message` # Corresponds to the JSON property `message`
# @return [String] # @return [String]
attr_accessor :message attr_accessor :message
@ -609,9 +581,8 @@ module Google
end end
end end
# Request to update the metadata of a # Request to update the metadata of a Photo. Updating the pixels of a photo is
# Photo. Updating the pixels of a photo # not supported.
# is not supported.
class UpdatePhotoRequest class UpdatePhotoRequest
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
@ -620,28 +591,16 @@ module Google
# @return [Google::Apis::StreetviewpublishV1::Photo] # @return [Google::Apis::StreetviewpublishV1::Photo]
attr_accessor :photo attr_accessor :photo
# Required. Mask that identifies fields on the photo metadata to update. # Required. Mask that identifies fields on the photo metadata to update. If not
# If not present, the old Photo # present, the old Photo metadata is entirely replaced with the new Photo
# metadata is entirely replaced with the # metadata in this request. The update fails if invalid fields are specified.
# new Photo metadata in this request. # Multiple fields can be specified in a comma-delimited list. The following
# The update fails if invalid fields are specified. Multiple fields can be # fields are valid: * `pose.heading` * `pose.latLngPair` * `pose.pitch` * `pose.
# specified in a comma-delimited list. # roll` * `pose.level` * `pose.altitude` * `connections` * `places` *Note:* When
# The following fields are valid: # updateMask contains repeated fields, the entire set of repeated values get
# * `pose.heading` # replaced with the new contents. For example, if updateMask contains `
# * `pose.latLngPair` # connections` and `UpdatePhotoRequest.photo.connections` is empty, all
# * `pose.pitch` # connections are removed.
# * `pose.roll`
# * `pose.level`
# * `pose.altitude`
# * `connections`
# * `places`
# <aside class="note"><b>Note:</b> When
# updateMask
# contains repeated fields, the entire set of repeated values get replaced
# with the new contents. For example, if
# updateMask
# contains `connections` and `UpdatePhotoRequest.photo.connections` is empty,
# all connections are removed.</aside>
# Corresponds to the JSON property `updateMask` # Corresponds to the JSON property `updateMask`
# @return [String] # @return [String]
attr_accessor :update_mask attr_accessor :update_mask
@ -661,9 +620,8 @@ module Google
class UploadRef class UploadRef
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
# Required. An upload reference should be unique for each user. It follows # Required. An upload reference should be unique for each user. It follows the
# the form: # form: "https://streetviewpublish.googleapis.com/media/user/`account_id`/photo/`
# "https://streetviewpublish.googleapis.com/media/user/`account_id`/photo/`
# upload_reference`" # upload_reference`"
# Corresponds to the JSON property `uploadUrl` # Corresponds to the JSON property `uploadUrl`
# @return [String] # @return [String]

271
generated/google/apis/streetviewpublish_v1/service.rb
View File

@ -49,21 +49,16 @@ module Google
@batch_path = 'batch' @batch_path = 'batch'
end end
# After the client finishes uploading the photo with the returned # After the client finishes uploading the photo with the returned UploadRef,
# UploadRef, # CreatePhoto publishes the uploaded Photo to Street View on Google Maps.
# CreatePhoto
# publishes the uploaded Photo to
# Street View on Google Maps.
# Currently, the only way to set heading, pitch, and roll in CreatePhoto is # Currently, the only way to set heading, pitch, and roll in CreatePhoto is
# through the [Photo Sphere XMP # through the [Photo Sphere XMP metadata](https://developers.google.com/
# metadata](https://developers.google.com/streetview/spherical-metadata) in # streetview/spherical-metadata) in the photo bytes. CreatePhoto ignores the `
# the photo bytes. CreatePhoto ignores the `pose.heading`, `pose.pitch`, # pose.heading`, `pose.pitch`, `pose.roll`, `pose.altitude`, and `pose.level`
# `pose.roll`, `pose.altitude`, and `pose.level` fields in Pose. # fields in Pose. This method returns the following error codes: * google.rpc.
# This method returns the following error codes: # Code.INVALID_ARGUMENT if the request is malformed or if the uploaded photo is
# * google.rpc.Code.INVALID_ARGUMENT if the request is malformed or if # not a 360 photo. * google.rpc.Code.NOT_FOUND if the upload reference does not
# the uploaded photo is not a 360 photo. # exist. * google.rpc.Code.RESOURCE_EXHAUSTED if the account has reached the
# * google.rpc.Code.NOT_FOUND if the upload reference does not exist.
# * google.rpc.Code.RESOURCE_EXHAUSTED if the account has reached the
# storage limit. # storage limit.
# @param [Google::Apis::StreetviewpublishV1::Photo] photo_object # @param [Google::Apis::StreetviewpublishV1::Photo] photo_object
# @param [String] fields # @param [String] fields
@ -94,11 +89,10 @@ module Google
execute_or_queue_command(command, &block) execute_or_queue_command(command, &block)
end end
# Deletes a Photo and its metadata. # Deletes a Photo and its metadata. This method returns the following error
# This method returns the following error codes: # codes: * google.rpc.Code.PERMISSION_DENIED if the requesting user did not
# * google.rpc.Code.PERMISSION_DENIED if the requesting user did not # create the requested photo. * google.rpc.Code.NOT_FOUND if the photo ID does
# create the requested photo. # not exist.
# * google.rpc.Code.NOT_FOUND if the photo ID does not exist.
# @param [String] photo_id # @param [String] photo_id
# Required. ID of the Photo. # Required. ID of the Photo.
# @param [String] fields # @param [String] fields
@ -128,27 +122,21 @@ module Google
execute_or_queue_command(command, &block) execute_or_queue_command(command, &block)
end end
# Gets the metadata of the specified # Gets the metadata of the specified Photo. This method returns the following
# Photo. # error codes: * google.rpc.Code.PERMISSION_DENIED if the requesting user did
# This method returns the following error codes: # not create the requested Photo. * google.rpc.Code.NOT_FOUND if the requested
# * google.rpc.Code.PERMISSION_DENIED if the requesting user did not # Photo does not exist. * google.rpc.Code.UNAVAILABLE if the requested Photo is
# create the requested Photo. # still being indexed.
# * google.rpc.Code.NOT_FOUND if the requested
# Photo does not exist.
# * google.rpc.Code.UNAVAILABLE if the requested
# Photo is still being indexed.
# @param [String] photo_id # @param [String] photo_id
# Required. ID of the Photo. # Required. ID of the Photo.
# @param [String] language_code # @param [String] language_code
# The BCP-47 language code, such as "en-US" or "sr-Latn". For more # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information,
# information, see # see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. If
# http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. # language_code is unspecified, the user's language preference for Google
# If language_code is unspecified, the user's language preference for Google
# services is used. # services is used.
# @param [String] view # @param [String] view
# Required. Specifies if a download URL for the photo bytes should be returned # Required. Specifies if a download URL for the photo bytes should be returned
# in the # in the Photo response.
# Photo response.
# @param [String] fields # @param [String] fields
# Selector specifying which fields to include in a partial response. # Selector specifying which fields to include in a partial response.
# @param [String] quota_user # @param [String] quota_user
@ -178,23 +166,17 @@ module Google
execute_or_queue_command(command, &block) execute_or_queue_command(command, &block)
end end
# Creates an upload session to start uploading photo bytes. The method uses # Creates an upload session to start uploading photo bytes. The method uses the
# the upload URL of the returned # upload URL of the returned UploadRef to upload the bytes for the Photo. In
# UploadRef to upload the bytes for # addition to the photo requirements shown in https://support.google.com/maps/
# the Photo. # answer/7012050?hl=en&ref_topic=6275604, the photo must meet the following
# In addition to the photo requirements shown in # requirements: * Photo Sphere XMP metadata must be included in the photo
# https://support.google.com/maps/answer/7012050?hl=en&ref_topic=6275604, # metadata. See https://developers.google.com/streetview/spherical-metadata for
# the photo must meet the following requirements: # the required fields. * The pixel size of the photo must meet the size
# * Photo Sphere XMP metadata must be included in the photo metadata. See # requirements listed in https://support.google.com/maps/answer/7012050?hl=en&
# https://developers.google.com/streetview/spherical-metadata for the # ref_topic=6275604, and the photo must be a full 360 horizontally. After the
# required fields. # upload completes, the method uses UploadRef with CreatePhoto to create the
# * The pixel size of the photo must meet the size requirements listed in # Photo object entry.
# https://support.google.com/maps/answer/7012050?hl=en&ref_topic=6275604, and
# the photo must be a full 360 horizontally.
# After the upload completes, the method uses
# UploadRef with
# CreatePhoto
# to create the Photo object entry.
# @param [Google::Apis::StreetviewpublishV1::Empty] empty_object # @param [Google::Apis::StreetviewpublishV1::Empty] empty_object
# @param [String] fields # @param [String] fields
# Selector specifying which fields to include in a partial response. # Selector specifying which fields to include in a partial response.
@ -224,46 +206,29 @@ module Google
execute_or_queue_command(command, &block) execute_or_queue_command(command, &block)
end end
# Updates the metadata of a Photo, such # Updates the metadata of a Photo, such as pose, place association, connections,
# as pose, place association, connections, etc. Changing the pixels of a # etc. Changing the pixels of a photo is not supported. Only the fields
# photo is not supported. # specified in the updateMask field are used. If `updateMask` is not present,
# Only the fields specified in the # the update applies to all fields. This method returns the following error
# updateMask # codes: * google.rpc.Code.PERMISSION_DENIED if the requesting user did not
# field are used. If `updateMask` is not present, the update applies to all # create the requested photo. * google.rpc.Code.INVALID_ARGUMENT if the request
# fields. # is malformed. * google.rpc.Code.NOT_FOUND if the requested photo does not
# This method returns the following error codes: # exist. * google.rpc.Code.UNAVAILABLE if the requested Photo is still being
# * google.rpc.Code.PERMISSION_DENIED if the requesting user did not # indexed.
# create the requested photo.
# * google.rpc.Code.INVALID_ARGUMENT if the request is malformed.
# * google.rpc.Code.NOT_FOUND if the requested photo does not exist.
# * google.rpc.Code.UNAVAILABLE if the requested
# Photo is still being indexed.
# @param [String] id # @param [String] id
# Required. A unique identifier for a photo. # Required. A unique identifier for a photo.
# @param [Google::Apis::StreetviewpublishV1::Photo] photo_object # @param [Google::Apis::StreetviewpublishV1::Photo] photo_object
# @param [String] update_mask # @param [String] update_mask
# Required. Mask that identifies fields on the photo metadata to update. # Required. Mask that identifies fields on the photo metadata to update. If not
# If not present, the old Photo # present, the old Photo metadata is entirely replaced with the new Photo
# metadata is entirely replaced with the # metadata in this request. The update fails if invalid fields are specified.
# new Photo metadata in this request. # Multiple fields can be specified in a comma-delimited list. The following
# The update fails if invalid fields are specified. Multiple fields can be # fields are valid: * `pose.heading` * `pose.latLngPair` * `pose.pitch` * `pose.
# specified in a comma-delimited list. # roll` * `pose.level` * `pose.altitude` * `connections` * `places` *Note:* When
# The following fields are valid: # updateMask contains repeated fields, the entire set of repeated values get
# * `pose.heading` # replaced with the new contents. For example, if updateMask contains `
# * `pose.latLngPair` # connections` and `UpdatePhotoRequest.photo.connections` is empty, all
# * `pose.pitch` # connections are removed.
# * `pose.roll`
# * `pose.level`
# * `pose.altitude`
# * `connections`
# * `places`
# <aside class="note"><b>Note:</b> When
# updateMask
# contains repeated fields, the entire set of repeated values get replaced
# with the new contents. For example, if
# updateMask
# contains `connections` and `UpdatePhotoRequest.photo.connections` is empty,
# all connections are removed.</aside>
# @param [String] fields # @param [String] fields
# Selector specifying which fields to include in a partial response. # Selector specifying which fields to include in a partial response.
# @param [String] quota_user # @param [String] quota_user
@ -294,21 +259,12 @@ module Google
execute_or_queue_command(command, &block) execute_or_queue_command(command, &block)
end end
# Deletes a list of Photos and their # Deletes a list of Photos and their metadata. Note that if BatchDeletePhotos
# metadata. # fails, either critical fields are missing or there is an authentication error.
# Note that if # Even if BatchDeletePhotos succeeds, individual photos in the batch may have
# BatchDeletePhotos # failures. These failures are specified in each PhotoResponse.status in
# fails, either critical fields are missing or there is an authentication # BatchDeletePhotosResponse.results. See DeletePhoto for specific failures that
# error. Even if # can occur per photo.
# BatchDeletePhotos
# succeeds, individual photos in the batch may have failures.
# These failures are specified in each
# PhotoResponse.status
# in
# BatchDeletePhotosResponse.results.
# See
# DeletePhoto
# for specific failures that can occur per photo.
# @param [Google::Apis::StreetviewpublishV1::BatchDeletePhotosRequest] batch_delete_photos_request_object # @param [Google::Apis::StreetviewpublishV1::BatchDeletePhotosRequest] batch_delete_photos_request_object
# @param [String] fields # @param [String] fields
# Selector specifying which fields to include in a partial response. # Selector specifying which fields to include in a partial response.
@ -338,35 +294,23 @@ module Google
execute_or_queue_command(command, &block) execute_or_queue_command(command, &block)
end end
# Gets the metadata of the specified # Gets the metadata of the specified Photo batch. Note that if BatchGetPhotos
# Photo batch. # fails, either critical fields are missing or there is an authentication error.
# Note that if # Even if BatchGetPhotos succeeds, individual photos in the batch may have
# BatchGetPhotos # failures. These failures are specified in each PhotoResponse.status in
# fails, either critical fields are missing or there is an authentication # BatchGetPhotosResponse.results. See GetPhoto for specific failures that can
# error. Even if # occur per photo.
# BatchGetPhotos
# succeeds, individual photos in the batch may have failures.
# These failures are specified in each
# PhotoResponse.status
# in
# BatchGetPhotosResponse.results.
# See
# GetPhoto
# for specific failures that can occur per photo.
# @param [String] language_code # @param [String] language_code
# The BCP-47 language code, such as "en-US" or "sr-Latn". For more # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information,
# information, see # see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. If
# http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. # language_code is unspecified, the user's language preference for Google
# If language_code is unspecified, the user's language preference for Google
# services is used. # services is used.
# @param [Array<String>, String] photo_ids # @param [Array<String>, String] photo_ids
# Required. IDs of the Photos. For HTTP # Required. IDs of the Photos. For HTTP GET requests, the URL query parameter
# GET requests, the URL query parameter should be # should be `photoIds=&photoIds=&...`.
# `photoIds=<id1>&photoIds=<id2>&...`.
# @param [String] view # @param [String] view
# Required. Specifies if a download URL for the photo bytes should be returned # Required. Specifies if a download URL for the photo bytes should be returned
# in the # in the Photo response.
# Photo response.
# @param [String] fields # @param [String] fields
# Selector specifying which fields to include in a partial response. # Selector specifying which fields to include in a partial response.
# @param [String] quota_user # @param [String] quota_user
@ -396,35 +340,17 @@ module Google
execute_or_queue_command(command, &block) execute_or_queue_command(command, &block)
end end
# Updates the metadata of Photos, such # Updates the metadata of Photos, such as pose, place association, connections,
# as pose, place association, connections, etc. Changing the pixels of photos # etc. Changing the pixels of photos is not supported. Note that if
# is not supported. # BatchUpdatePhotos fails, either critical fields are missing or there is an
# Note that if # authentication error. Even if BatchUpdatePhotos succeeds, individual photos in
# BatchUpdatePhotos # the batch may have failures. These failures are specified in each
# fails, either critical fields are missing or there is an authentication # PhotoResponse.status in BatchUpdatePhotosResponse.results. See UpdatePhoto for
# error. Even if # specific failures that can occur per photo. Only the fields specified in
# BatchUpdatePhotos # updateMask field are used. If `updateMask` is not present, the update applies
# succeeds, individual photos in the batch may have failures. # to all fields. The number of UpdatePhotoRequest messages in a
# These failures are specified in each # BatchUpdatePhotosRequest must not exceed 20. *Note:* To update Pose.altitude,
# PhotoResponse.status # Pose.latLngPair has to be filled as well. Otherwise, the request will fail.
# in
# BatchUpdatePhotosResponse.results.
# See
# UpdatePhoto
# for specific failures that can occur per photo.
# Only the fields specified in
# updateMask
# field are used. If `updateMask` is not present, the update applies to all
# fields.
# The number of
# UpdatePhotoRequest
# messages in a
# BatchUpdatePhotosRequest
# must not exceed 20.
# <aside class="note"><b>Note:</b> To update
# Pose.altitude,
# Pose.latLngPair has to be
# filled as well. Otherwise, the request will fail.</aside>
# @param [Google::Apis::StreetviewpublishV1::BatchUpdatePhotosRequest] batch_update_photos_request_object # @param [Google::Apis::StreetviewpublishV1::BatchUpdatePhotosRequest] batch_update_photos_request_object
# @param [String] fields # @param [String] fields
# Selector specifying which fields to include in a partial response. # Selector specifying which fields to include in a partial response.
@ -454,36 +380,27 @@ module Google
execute_or_queue_command(command, &block) execute_or_queue_command(command, &block)
end end
# Lists all the Photos that belong to # Lists all the Photos that belong to the user. *Note:* Recently created photos
# the user. # that are still being indexed are not returned in the response.
# <aside class="note"><b>Note:</b> Recently created photos that are still
# being indexed are not returned in the response.</aside>
# @param [String] filter # @param [String] filter
# Required. The filter expression. For example: `placeId= # Required. The filter expression. For example: `placeId=
# ChIJj61dQgK6j4AR4GeTYWZsKWw`. # ChIJj61dQgK6j4AR4GeTYWZsKWw`. The only filter supported at the moment is `
# The only filter supported at the moment is `placeId`. # placeId`.
# @param [String] language_code # @param [String] language_code
# The BCP-47 language code, such as "en-US" or "sr-Latn". For more # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information,
# information, see # see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. If
# http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. # language_code is unspecified, the user's language preference for Google
# If language_code is unspecified, the user's language preference for Google
# services is used. # services is used.
# @param [Fixnum] page_size # @param [Fixnum] page_size
# The maximum number of photos to return. # The maximum number of photos to return. `pageSize` must be non-negative. If `
# `pageSize` must be non-negative. If `pageSize` is zero or is not provided, # pageSize` is zero or is not provided, the default page size of 100 is used.
# the default page size of 100 is used. # The number of photos returned in the response may be less than `pageSize` if
# The number of photos returned in the response may be less than `pageSize` # the number of photos that belong to the user is less than `pageSize`.
# if the number of photos that belong to the user is less than `pageSize`.
# @param [String] page_token # @param [String] page_token
# The # The nextPageToken value returned from a previous ListPhotos request, if any.
# nextPageToken
# value returned from a previous
# ListPhotos
# request, if any.
# @param [String] view # @param [String] view
# Required. Specifies if a download URL for the photos bytes should be returned # Required. Specifies if a download URL for the photos bytes should be returned
# in the # in the Photos response.
# Photos response.
# @param [String] fields # @param [String] fields
# Selector specifying which fields to include in a partial response. # Selector specifying which fields to include in a partial response.
# @param [String] quota_user # @param [String] quota_user

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

@ -25,7 +25,7 @@ module Google
# @see # @see
module TasksV1 module TasksV1
VERSION = 'V1' VERSION = 'V1'
REVISION = '20200516' REVISION = '20200809'
# Create, edit, organize, and delete all your tasks # Create, edit, organize, and delete all your tasks
AUTH_TASKS = 'https://www.googleapis.com/auth/tasks' AUTH_TASKS = 'https://www.googleapis.com/auth/tasks'

41
generated/google/apis/tasks_v1/classes.rb
View File

@ -26,8 +26,8 @@ module Google
class Task class Task
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
# Completion date of the task (as a RFC 3339 timestamp). This field is # Completion date of the task (as a RFC 3339 timestamp). This field is omitted
# omitted if the task has not been completed. # if the task has not been completed.
# Corresponds to the JSON property `completed` # Corresponds to the JSON property `completed`
# @return [String] # @return [String]
attr_accessor :completed attr_accessor :completed
@ -39,9 +39,9 @@ module Google
alias_method :deleted?, :deleted alias_method :deleted?, :deleted
# Due date of the task (as a RFC 3339 timestamp). Optional. The due date only # Due date of the task (as a RFC 3339 timestamp). Optional. The due date only
# records date information; the time portion of the timestamp is discarded # records date information; the time portion of the timestamp is discarded when
# when setting the due date. It isn't possible to read or write the time that # setting the due date. It isn't possible to read or write the time that a task
# a task is due via the API. # is due via the API.
# Corresponds to the JSON property `due` # Corresponds to the JSON property `due`
# @return [String] # @return [String]
attr_accessor :due attr_accessor :due
@ -51,9 +51,9 @@ module Google
# @return [String] # @return [String]
attr_accessor :etag attr_accessor :etag
# Flag indicating whether the task is hidden. This is the case if the task # Flag indicating whether the task is hidden. This is the case if the task had
# had been marked completed when the task list was last cleared. The default # been marked completed when the task list was last cleared. The default is
# is False. This field is read-only. # False. This field is read-only.
# Corresponds to the JSON property `hidden` # Corresponds to the JSON property `hidden`
# @return [Boolean] # @return [Boolean]
attr_accessor :hidden attr_accessor :hidden
@ -79,19 +79,19 @@ module Google
# @return [String] # @return [String]
attr_accessor :notes attr_accessor :notes
# Parent task identifier. This field is omitted if it is a top-level task. # Parent task identifier. This field is omitted if it is a top-level task. This
# This field is read-only. Use the "move" method to move the task under a # field is read-only. Use the "move" method to move the task under a different
# different parent or to the top level. # parent or to the top level.
# Corresponds to the JSON property `parent` # Corresponds to the JSON property `parent`
# @return [String] # @return [String]
attr_accessor :parent attr_accessor :parent
# String indicating the position of the task among its sibling tasks under # String indicating the position of the task among its sibling tasks under the
# the same parent task or at the top level. If this string is greater than # same parent task or at the top level. If this string is greater than another
# another task's corresponding position string according to lexicographical # task's corresponding position string according to lexicographical ordering,
# ordering, the task is positioned after the other task under the same parent # the task is positioned after the other task under the same parent task (or at
# task (or at the top level). This field is read-only. Use the "move" method # the top level). This field is read-only. Use the "move" method to move the
# to move the task to another position. # task to another position.
# Corresponds to the JSON property `position` # Corresponds to the JSON property `position`
# @return [String] # @return [String]
attr_accessor :position attr_accessor :position
@ -143,8 +143,7 @@ module Google
class Link class Link
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
# The description. In HTML speak: Everything between &lt;a&gt; and # The description. In HTML speak: Everything between <a> and </a>.
# &lt;/a&gt;.
# Corresponds to the JSON property `description` # Corresponds to the JSON property `description`
# @return [String] # @return [String]
attr_accessor :description attr_accessor :description
@ -191,8 +190,8 @@ module Google
# @return [String] # @return [String]
attr_accessor :kind attr_accessor :kind
# URL pointing to this task list. Used to retrieve, update, or delete this # URL pointing to this task list. Used to retrieve, update, or delete this task
# task list. # list.
# Corresponds to the JSON property `selfLink` # Corresponds to the JSON property `selfLink`
# @return [String] # @return [String]
attr_accessor :self_link attr_accessor :self_link

33
generated/google/apis/tasks_v1/service.rb
View File

@ -137,8 +137,8 @@ module Google
# Returns all the authenticated user's task lists. # Returns all the authenticated user's task lists.
# @param [Fixnum] max_results # @param [Fixnum] max_results
# Maximum number of task lists returned on one page. Optional. The default is # Maximum number of task lists returned on one page. Optional. The default is 20
# 20 (max allowed: 100). # (max allowed: 100).
# @param [String] page_token # @param [String] page_token
# Token specifying the result page to return. Optional. # Token specifying the result page to return. Optional.
# @param [String] fields # @param [String] fields
@ -338,8 +338,8 @@ module Google
# Parent task identifier. If the task is created at the top level, this # Parent task identifier. If the task is created at the top level, this
# parameter is omitted. Optional. # parameter is omitted. Optional.
# @param [String] previous # @param [String] previous
# Previous sibling task identifier. If the task is created at the first # Previous sibling task identifier. If the task is created at the first position
# position among its siblings, this parameter is omitted. Optional. # among its siblings, this parameter is omitted. Optional.
# @param [String] fields # @param [String] fields
# Selector specifying which fields to include in a partial response. # Selector specifying which fields to include in a partial response.
# @param [String] quota_user # @param [String] quota_user
@ -375,11 +375,11 @@ module Google
# @param [String] tasklist # @param [String] tasklist
# Task list identifier. # Task list identifier.
# @param [String] completed_max # @param [String] completed_max
# Upper bound for a task's completion date (as a RFC 3339 timestamp) to # Upper bound for a task's completion date (as a RFC 3339 timestamp) to filter
# filter by. Optional. The default is not to filter by completion date. # by. Optional. The default is not to filter by completion date.
# @param [String] completed_min # @param [String] completed_min
# Lower bound for a task's completion date (as a RFC 3339 timestamp) to # Lower bound for a task's completion date (as a RFC 3339 timestamp) to filter
# filter by. Optional. The default is not to filter by completion date. # by. Optional. The default is not to filter by completion date.
# @param [String] due_max # @param [String] due_max
# Upper bound for a task's due date (as a RFC 3339 timestamp) to filter by. # Upper bound for a task's due date (as a RFC 3339 timestamp) to filter by.
# Optional. The default is not to filter by due date. # Optional. The default is not to filter by due date.
@ -387,23 +387,22 @@ module Google
# Lower bound for a task's due date (as a RFC 3339 timestamp) to filter by. # Lower bound for a task's due date (as a RFC 3339 timestamp) to filter by.
# Optional. The default is not to filter by due date. # Optional. The default is not to filter by due date.
# @param [Fixnum] max_results # @param [Fixnum] max_results
# Maximum number of task lists returned on one page. Optional. The default is # Maximum number of task lists returned on one page. Optional. The default is 20
# 20 (max allowed: 100). # (max allowed: 100).
# @param [String] page_token # @param [String] page_token
# Token specifying the result page to return. Optional. # Token specifying the result page to return. Optional.
# @param [Boolean] show_completed # @param [Boolean] show_completed
# Flag indicating whether completed tasks are returned in the result. # Flag indicating whether completed tasks are returned in the result. Optional.
# Optional. The default is True. # The default is True.
# @param [Boolean] show_deleted # @param [Boolean] show_deleted
# Flag indicating whether deleted tasks are returned in the result. Optional. # Flag indicating whether deleted tasks are returned in the result. Optional.
# The default is False. # The default is False.
# @param [Boolean] show_hidden # @param [Boolean] show_hidden
# Flag indicating whether hidden tasks are returned in the result. Optional. # Flag indicating whether hidden tasks are returned in the result. Optional. The
# The default is False. # default is False.
# @param [String] updated_min # @param [String] updated_min
# Lower bound for a task's last modification time (as a RFC 3339 timestamp) # Lower bound for a task's last modification time (as a RFC 3339 timestamp) to
# to filter by. Optional. The default is not to filter by last modification # filter by. Optional. The default is not to filter by last modification time.
# time.
# @param [String] fields # @param [String] fields
# Selector specifying which fields to include in a partial response. # Selector specifying which fields to include in a partial response.
# @param [String] quota_user # @param [String] quota_user

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

@ -25,7 +25,7 @@ module Google
# @see https://cloud.google.com/translate/docs/quickstarts # @see https://cloud.google.com/translate/docs/quickstarts
module TranslateV3 module TranslateV3
VERSION = 'V3' VERSION = 'V3'
REVISION = '20200730' REVISION = '20200807'
# View and manage your data across Google Cloud Platform services # View and manage your data across Google Cloud Platform services
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'

319
generated/google/apis/translate_v3/classes.rb
View File

@ -26,42 +26,38 @@ module Google
class BatchTranslateTextRequest class BatchTranslateTextRequest
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
# Optional. Glossaries to be applied for translation. # Optional. Glossaries to be applied for translation. It's keyed by target
# It's keyed by target language code. # language code.
# Corresponds to the JSON property `glossaries` # Corresponds to the JSON property `glossaries`
# @return [Hash<String,Google::Apis::TranslateV3::TranslateTextGlossaryConfig>] # @return [Hash<String,Google::Apis::TranslateV3::TranslateTextGlossaryConfig>]
attr_accessor :glossaries attr_accessor :glossaries
# Required. Input configurations. # Required. Input configurations. The total number of files matched should be <=
# The total number of files matched should be <= 1000. # 1000. The total content size should be <= 100M Unicode codepoints. The files
# The total content size should be <= 100M Unicode codepoints. # must use UTF-8 encoding.
# The files must use UTF-8 encoding.
# Corresponds to the JSON property `inputConfigs` # Corresponds to the JSON property `inputConfigs`
# @return [Array<Google::Apis::TranslateV3::InputConfig>] # @return [Array<Google::Apis::TranslateV3::InputConfig>]
attr_accessor :input_configs attr_accessor :input_configs
# Optional. The labels with user-defined metadata for the request. # Optional. The labels with user-defined metadata for the request. Label keys
# Label keys and values can be no longer than 63 characters # and values can be no longer than 63 characters (Unicode codepoints), can only
# (Unicode codepoints), can only contain lowercase letters, numeric # contain lowercase letters, numeric characters, underscores and dashes.
# characters, underscores and dashes. International characters are allowed. # International characters are allowed. Label values are optional. Label keys
# Label values are optional. Label keys must start with a letter. # must start with a letter. See https://cloud.google.com/translate/docs/advanced/
# See https://cloud.google.com/translate/docs/advanced/labels for more # labels for more information.
# information.
# Corresponds to the JSON property `labels` # Corresponds to the JSON property `labels`
# @return [Hash<String,String>] # @return [Hash<String,String>]
attr_accessor :labels attr_accessor :labels
# Optional. The models to use for translation. Map's key is target language # Optional. The models to use for translation. Map's key is target language code.
# code. Map's value is model name. Value can be a built-in general model, # Map's value is model name. Value can be a built-in general model, or an
# or an AutoML Translation model. # AutoML Translation model. The value format depends on model type: - AutoML
# The value format depends on model type: # Translation models: `projects/`project-number-or-id`/locations/`location-id`/
# - AutoML Translation models: # models/`model-id`` - General (built-in) models: `projects/`project-number-or-
# `projects/`project-number-or-id`/locations/`location-id`/models/`model-id`` # id`/locations/`location-id`/models/general/nmt`, `projects/`project-number-or-
# - General (built-in) models: # id`/locations/`location-id`/models/general/base` If the map is empty or a
# `projects/`project-number-or-id`/locations/`location-id`/models/general/nmt`, # specific model is not requested for a language pair, then default google model
# `projects/`project-number-or-id`/locations/`location-id`/models/general/base` # (nmt) is used.
# If the map is empty or a specific model is
# not requested for a language pair, then default google model (nmt) is used.
# Corresponds to the JSON property `models` # Corresponds to the JSON property `models`
# @return [Hash<String,String>] # @return [Hash<String,String>]
attr_accessor :models attr_accessor :models
@ -119,31 +115,27 @@ module Google
# @return [String] # @return [String]
attr_accessor :content attr_accessor :content
# Optional. The labels with user-defined metadata for the request. # Optional. The labels with user-defined metadata for the request. Label keys
# Label keys and values can be no longer than 63 characters # and values can be no longer than 63 characters (Unicode codepoints), can only
# (Unicode codepoints), can only contain lowercase letters, numeric # contain lowercase letters, numeric characters, underscores and dashes.
# characters, underscores and dashes. International characters are allowed. # International characters are allowed. Label values are optional. Label keys
# Label values are optional. Label keys must start with a letter. # must start with a letter. See https://cloud.google.com/translate/docs/advanced/
# See https://cloud.google.com/translate/docs/advanced/labels for more # labels for more information.
# information.
# Corresponds to the JSON property `labels` # Corresponds to the JSON property `labels`
# @return [Hash<String,String>] # @return [Hash<String,String>]
attr_accessor :labels attr_accessor :labels
# Optional. The format of the source text, for example, "text/html", # Optional. The format of the source text, for example, "text/html", "text/plain"
# "text/plain". If left blank, the MIME type defaults to "text/html". # . If left blank, the MIME type defaults to "text/html".
# Corresponds to the JSON property `mimeType` # Corresponds to the JSON property `mimeType`
# @return [String] # @return [String]
attr_accessor :mime_type attr_accessor :mime_type
# Optional. The language detection model to be used. # Optional. The language detection model to be used. Format: `projects/`project-
# Format: # number-or-id`/locations/`location-id`/models/language-detection/`model-id``
# `projects/`project-number-or-id`/locations/`location-id`/models/language- # Only one language detection model is currently supported: `projects/`project-
# detection/`model-id`` # number-or-id`/locations/`location-id`/models/language-detection/default`. If
# Only one language detection model is currently supported: # not specified, the default model is used.
# `projects/`project-number-or-id`/locations/`location-id`/models/language-
# detection/default`.
# If not specified, the default model is used.
# Corresponds to the JSON property `model` # Corresponds to the JSON property `model`
# @return [String] # @return [String]
attr_accessor :model attr_accessor :model
@ -207,13 +199,11 @@ module Google
end end
end end
# A generic empty message that you can re-use to avoid defining duplicated # A generic empty message that you can re-use to avoid defining duplicated empty
# empty messages in your APIs. A typical example is to use it as the request # messages in your APIs. A typical example is to use it as the request or the
# or the response type of an API method. For instance: # response type of an API method. For instance: service Foo ` rpc Bar(google.
# service Foo ` # protobuf.Empty) returns (google.protobuf.Empty); ` The JSON representation for
# rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); # `Empty` is empty JSON object ````.
# `
# The JSON representation for `Empty` is empty JSON object ````.
class Empty class Empty
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
@ -231,8 +221,7 @@ module Google
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
# Required. The bucket used in 'output_uri_prefix' must exist and there must be # Required. The bucket used in 'output_uri_prefix' must exist and there must be
# no # no files under 'output_uri_prefix'. 'output_uri_prefix' must end with "/" and
# files under 'output_uri_prefix'. 'output_uri_prefix' must end with "/" and
# start with "gs://". One 'output_uri_prefix' can only be used by one batch # start with "gs://". One 'output_uri_prefix' can only be used by one batch
# translation job at a time. Otherwise an INVALID_ARGUMENT (400) error is # translation job at a time. Otherwise an INVALID_ARGUMENT (400) error is
# returned. # returned.
@ -298,8 +287,8 @@ module Google
# @return [Google::Apis::TranslateV3::LanguageCodePair] # @return [Google::Apis::TranslateV3::LanguageCodePair]
attr_accessor :language_pair attr_accessor :language_pair
# Required. The resource name of the glossary. Glossary names have the form # Required. The resource name of the glossary. Glossary names have the form `
# `projects/`project-number-or-id`/locations/`location-id`/glossaries/`glossary- # projects/`project-number-or-id`/locations/`location-id`/glossaries/`glossary-
# id``. # id``.
# Corresponds to the JSON property `name` # Corresponds to the JSON property `name`
# @return [String] # @return [String]
@ -354,9 +343,8 @@ module Google
# @return [Google::Apis::TranslateV3::GcsSource] # @return [Google::Apis::TranslateV3::GcsSource]
attr_accessor :gcs_source attr_accessor :gcs_source
# Optional. Can be "text/plain" or "text/html". # Optional. Can be "text/plain" or "text/html". For `.tsv`, "text/html" is used
# For `.tsv`, "text/html" is used if mime_type is missing. # if mime_type is missing. For `.html`, this field must be "text/html" or empty.
# For `.html`, this field must be "text/html" or empty.
# For `.txt`, this field must be "text/plain" or empty. # For `.txt`, this field must be "text/plain" or empty.
# Corresponds to the JSON property `mimeType` # Corresponds to the JSON property `mimeType`
# @return [String] # @return [String]
@ -377,14 +365,14 @@ module Google
class LanguageCodePair class LanguageCodePair
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
# Required. The BCP-47 language code of the input text, for example, # Required. The BCP-47 language code of the input text, for example, "en-US".
# "en-US". Expected to be an exact match for GlossaryTerm.language_code. # Expected to be an exact match for GlossaryTerm.language_code.
# Corresponds to the JSON property `sourceLanguageCode` # Corresponds to the JSON property `sourceLanguageCode`
# @return [String] # @return [String]
attr_accessor :source_language_code attr_accessor :source_language_code
# Required. The BCP-47 language code for translation output, for example, # Required. The BCP-47 language code for translation output, for example, "zh-CN"
# "zh-CN". Expected to be an exact match for GlossaryTerm.language_code. # . Expected to be an exact match for GlossaryTerm.language_code.
# Corresponds to the JSON property `targetLanguageCode` # Corresponds to the JSON property `targetLanguageCode`
# @return [String] # @return [String]
attr_accessor :target_language_code attr_accessor :target_language_code
@ -404,9 +392,9 @@ module Google
class LanguageCodesSet class LanguageCodesSet
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
# The BCP-47 language code(s) for terms defined in the glossary. # The BCP-47 language code(s) for terms defined in the glossary. All entries are
# All entries are unique. The list contains at least two entries. # unique. The list contains at least two entries. Expected to be an exact match
# Expected to be an exact match for GlossaryTerm.language_code. # for GlossaryTerm.language_code.
# Corresponds to the JSON property `languageCodes` # Corresponds to the JSON property `languageCodes`
# @return [Array<String>] # @return [Array<String>]
attr_accessor :language_codes attr_accessor :language_codes
@ -430,9 +418,9 @@ module Google
# @return [Array<Google::Apis::TranslateV3::Glossary>] # @return [Array<Google::Apis::TranslateV3::Glossary>]
attr_accessor :glossaries attr_accessor :glossaries
# A token to retrieve a page of results. Pass this value in the # A token to retrieve a page of results. Pass this value in the [
# [ListGlossariesRequest.page_token] field in the subsequent call to # ListGlossariesRequest.page_token] field in the subsequent call to `
# `ListGlossaries` method to retrieve the next page of results. # ListGlossaries` method to retrieve the next page of results.
# Corresponds to the JSON property `nextPageToken` # Corresponds to the JSON property `nextPageToken`
# @return [String] # @return [String]
attr_accessor :next_page_token attr_accessor :next_page_token
@ -502,14 +490,14 @@ module Google
class Location class Location
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
# The friendly name for this location, typically a nearby city name. # The friendly name for this location, typically a nearby city name. For example,
# For example, "Tokyo". # "Tokyo".
# Corresponds to the JSON property `displayName` # Corresponds to the JSON property `displayName`
# @return [String] # @return [String]
attr_accessor :display_name attr_accessor :display_name
# Cross-service attributes for the location. For example # Cross-service attributes for the location. For example `"cloud.googleapis.com/
# `"cloud.googleapis.com/region": "us-east1"` # region": "us-east1"`
# Corresponds to the JSON property `labels` # Corresponds to the JSON property `labels`
# @return [Hash<String,String>] # @return [Hash<String,String>]
attr_accessor :labels attr_accessor :labels
@ -525,8 +513,8 @@ module Google
# @return [Hash<String,Object>] # @return [Hash<String,Object>]
attr_accessor :metadata attr_accessor :metadata
# Resource name for the location, which may vary between implementations. # Resource name for the location, which may vary between implementations. For
# For example: `"projects/example-project/locations/us-east1"` # example: `"projects/example-project/locations/us-east1"`
# Corresponds to the JSON property `name` # Corresponds to the JSON property `name`
# @return [String] # @return [String]
attr_accessor :name attr_accessor :name
@ -550,47 +538,45 @@ module Google
class Operation class Operation
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
# If the value is `false`, it means the operation is still in progress. # If the value is `false`, it means the operation is still in progress. If `true`
# If `true`, the operation is completed, and either `error` or `response` is # , the operation is completed, and either `error` or `response` is available.
# available.
# Corresponds to the JSON property `done` # Corresponds to the JSON property `done`
# @return [Boolean] # @return [Boolean]
attr_accessor :done attr_accessor :done
alias_method :done?, :done alias_method :done?, :done
# The `Status` type defines a logical error model that is suitable for # The `Status` type defines a logical error model that is suitable for different
# different programming environments, including REST APIs and RPC APIs. It is # programming environments, including REST APIs and RPC APIs. It is used by [
# used by [gRPC](https://github.com/grpc). Each `Status` message contains # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
# three pieces of data: error code, error message, and error details. # data: error code, error message, and error details. You can find out more
# You can find out more about this error model and how to work with it in the # about this error model and how to work with it in the [API Design Guide](https:
# [API Design Guide](https://cloud.google.com/apis/design/errors). # //cloud.google.com/apis/design/errors).
# Corresponds to the JSON property `error` # Corresponds to the JSON property `error`
# @return [Google::Apis::TranslateV3::Status] # @return [Google::Apis::TranslateV3::Status]
attr_accessor :error attr_accessor :error
# Service-specific metadata associated with the operation. It typically # Service-specific metadata associated with the operation. It typically contains
# contains progress information and common metadata such as create time. # progress information and common metadata such as create time. Some services
# Some services might not provide such metadata. Any method that returns a # might not provide such metadata. Any method that returns a long-running
# long-running operation should document the metadata type, if any. # operation should document the metadata type, if any.
# Corresponds to the JSON property `metadata` # Corresponds to the JSON property `metadata`
# @return [Hash<String,Object>] # @return [Hash<String,Object>]
attr_accessor :metadata attr_accessor :metadata
# The server-assigned name, which is only unique within the same service that # The server-assigned name, which is only unique within the same service that
# originally returns it. If you use the default HTTP mapping, the # originally returns it. If you use the default HTTP mapping, the `name` should
# `name` should be a resource name ending with `operations/`unique_id``. # be a resource name ending with `operations/`unique_id``.
# Corresponds to the JSON property `name` # Corresponds to the JSON property `name`
# @return [String] # @return [String]
attr_accessor :name attr_accessor :name
# The normal response of the operation in case of success. If the original # 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 # method returns no data on success, such as `Delete`, the response is `google.
# `google.protobuf.Empty`. If the original method is standard # protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`,
# `Get`/`Create`/`Update`, the response should be the resource. For other # the response should be the resource. For other methods, the response should
# methods, the response should have the type `XxxResponse`, where `Xxx` # have the type `XxxResponse`, where `Xxx` is the original method name. For
# is the original method name. For example, if the original method name # example, if the original method name is `TakeSnapshot()`, the inferred
# is `TakeSnapshot()`, the inferred response type is # response type is `TakeSnapshotResponse`.
# `TakeSnapshotResponse`.
# Corresponds to the JSON property `response` # Corresponds to the JSON property `response`
# @return [Hash<String,Object>] # @return [Hash<String,Object>]
attr_accessor :response attr_accessor :response
@ -628,12 +614,12 @@ module Google
end end
end end
# The `Status` type defines a logical error model that is suitable for # The `Status` type defines a logical error model that is suitable for different
# different programming environments, including REST APIs and RPC APIs. It is # programming environments, including REST APIs and RPC APIs. It is used by [
# used by [gRPC](https://github.com/grpc). Each `Status` message contains # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
# three pieces of data: error code, error message, and error details. # data: error code, error message, and error details. You can find out more
# You can find out more about this error model and how to work with it in the # about this error model and how to work with it in the [API Design Guide](https:
# [API Design Guide](https://cloud.google.com/apis/design/errors). # //cloud.google.com/apis/design/errors).
class Status class Status
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
@ -648,9 +634,9 @@ module Google
# @return [Array<Hash<String,Object>>] # @return [Array<Hash<String,Object>>]
attr_accessor :details attr_accessor :details
# A developer-facing error message, which should be in English. Any # A developer-facing error message, which should be in English. Any user-facing
# user-facing error message should be localized and sent in the # error message should be localized and sent in the google.rpc.Status.details
# google.rpc.Status.details field, or localized by the client. # field, or localized by the client.
# Corresponds to the JSON property `message` # Corresponds to the JSON property `message`
# @return [String] # @return [String]
attr_accessor :message attr_accessor :message
@ -667,8 +653,8 @@ module Google
end end
end end
# A single supported language response corresponds to information related # A single supported language response corresponds to information related to one
# to one supported language. # supported language.
class SupportedLanguage class SupportedLanguage
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
@ -678,10 +664,9 @@ module Google
# @return [String] # @return [String]
attr_accessor :display_name attr_accessor :display_name
# Supported language code, generally consisting of its ISO 639-1 # Supported language code, generally consisting of its ISO 639-1 identifier, for
# identifier, for example, 'en', 'ja'. In certain cases, BCP-47 codes # example, 'en', 'ja'. In certain cases, BCP-47 codes including language and
# including language and region identifiers are returned (for example, # region identifiers are returned (for example, 'zh-TW' and 'zh-CN')
# 'zh-TW' and 'zh-CN')
# Corresponds to the JSON property `languageCode` # Corresponds to the JSON property `languageCode`
# @return [String] # @return [String]
attr_accessor :language_code attr_accessor :language_code
@ -715,8 +700,8 @@ module Google
class SupportedLanguages class SupportedLanguages
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
# A list of supported language responses. This list contains an entry # A list of supported language responses. This list contains an entry for each
# for each language the Translation API supports. # language the Translation API supports.
# Corresponds to the JSON property `languages` # Corresponds to the JSON property `languages`
# @return [Array<Google::Apis::TranslateV3::SupportedLanguage>] # @return [Array<Google::Apis::TranslateV3::SupportedLanguage>]
attr_accessor :languages attr_accessor :languages
@ -731,22 +716,20 @@ module Google
end end
end end
# Configures which glossary should be used for a specific target language, # Configures which glossary should be used for a specific target language, and
# and defines options for applying that glossary. # defines options for applying that glossary.
class TranslateTextGlossaryConfig class TranslateTextGlossaryConfig
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
# Required. The `glossary` to be applied for this translation. # Required. The `glossary` to be applied for this translation. The format
# The format depends on glossary: # depends on glossary: - User provided custom glossary: `projects/`project-
# - User provided custom glossary: # number-or-id`/locations/`location-id`/glossaries/`glossary-id``
# `projects/`project-number-or-id`/locations/`location-id`/glossaries/`
# glossary-id``
# Corresponds to the JSON property `glossary` # Corresponds to the JSON property `glossary`
# @return [String] # @return [String]
attr_accessor :glossary attr_accessor :glossary
# Optional. Indicates match is case-insensitive. # Optional. Indicates match is case-insensitive. Default value is false if
# Default value is false if missing. # missing.
# Corresponds to the JSON property `ignoreCase` # Corresponds to the JSON property `ignoreCase`
# @return [Boolean] # @return [Boolean]
attr_accessor :ignore_case attr_accessor :ignore_case
@ -767,62 +750,57 @@ module Google
class TranslateTextRequest class TranslateTextRequest
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
# Required. The content of the input in string format. # Required. The content of the input in string format. We recommend the total
# We recommend the total content be less than 30k codepoints. # content be less than 30k codepoints. Use BatchTranslateText for larger text.
# Use BatchTranslateText for larger text.
# Corresponds to the JSON property `contents` # Corresponds to the JSON property `contents`
# @return [Array<String>] # @return [Array<String>]
attr_accessor :contents attr_accessor :contents
# Configures which glossary should be used for a specific target language, # Configures which glossary should be used for a specific target language, and
# and defines options for applying that glossary. # defines options for applying that glossary.
# Corresponds to the JSON property `glossaryConfig` # Corresponds to the JSON property `glossaryConfig`
# @return [Google::Apis::TranslateV3::TranslateTextGlossaryConfig] # @return [Google::Apis::TranslateV3::TranslateTextGlossaryConfig]
attr_accessor :glossary_config attr_accessor :glossary_config
# Optional. The labels with user-defined metadata for the request. # Optional. The labels with user-defined metadata for the request. Label keys
# Label keys and values can be no longer than 63 characters # and values can be no longer than 63 characters (Unicode codepoints), can only
# (Unicode codepoints), can only contain lowercase letters, numeric # contain lowercase letters, numeric characters, underscores and dashes.
# characters, underscores and dashes. International characters are allowed. # International characters are allowed. Label values are optional. Label keys
# Label values are optional. Label keys must start with a letter. # must start with a letter. See https://cloud.google.com/translate/docs/advanced/
# See https://cloud.google.com/translate/docs/advanced/labels for more # labels for more information.
# information.
# Corresponds to the JSON property `labels` # Corresponds to the JSON property `labels`
# @return [Hash<String,String>] # @return [Hash<String,String>]
attr_accessor :labels attr_accessor :labels
# Optional. The format of the source text, for example, "text/html", # Optional. The format of the source text, for example, "text/html", "text/plain"
# "text/plain". If left blank, the MIME type defaults to "text/html". # . If left blank, the MIME type defaults to "text/html".
# Corresponds to the JSON property `mimeType` # Corresponds to the JSON property `mimeType`
# @return [String] # @return [String]
attr_accessor :mime_type attr_accessor :mime_type
# Optional. The `model` type requested for this translation. # Optional. The `model` type requested for this translation. The format depends
# The format depends on model type: # on model type: - AutoML Translation models: `projects/`project-number-or-id`/
# - AutoML Translation models: # locations/`location-id`/models/`model-id`` - General (built-in) models: `
# `projects/`project-number-or-id`/locations/`location-id`/models/`model-id`` # projects/`project-number-or-id`/locations/`location-id`/models/general/nmt`, `
# - General (built-in) models: # projects/`project-number-or-id`/locations/`location-id`/models/general/base`
# `projects/`project-number-or-id`/locations/`location-id`/models/general/nmt`, # For global (non-regionalized) requests, use `location-id` `global`. For
# `projects/`project-number-or-id`/locations/`location-id`/models/general/base` # example, `projects/`project-number-or-id`/locations/global/models/general/nmt`.
# For global (non-regionalized) requests, use `location-id` `global`.
# For example,
# `projects/`project-number-or-id`/locations/global/models/general/nmt`.
# If missing, the system decides which google base model to use. # If missing, the system decides which google base model to use.
# Corresponds to the JSON property `model` # Corresponds to the JSON property `model`
# @return [String] # @return [String]
attr_accessor :model attr_accessor :model
# Optional. The BCP-47 language code of the input text if # Optional. The BCP-47 language code of the input text if known, for example, "
# known, for example, "en-US" or "sr-Latn". Supported language codes are # en-US" or "sr-Latn". Supported language codes are listed in Language Support.
# listed in Language Support. If the source language isn't specified, the API # If the source language isn't specified, the API attempts to identify the
# attempts to identify the source language automatically and returns the # source language automatically and returns the source language within the
# source language within the response. # response.
# Corresponds to the JSON property `sourceLanguageCode` # Corresponds to the JSON property `sourceLanguageCode`
# @return [String] # @return [String]
attr_accessor :source_language_code attr_accessor :source_language_code
# Required. The BCP-47 language code to use for translation of the input # Required. The BCP-47 language code to use for translation of the input text,
# text, set to one of the language codes listed in Language Support. # set to one of the language codes listed in Language Support.
# Corresponds to the JSON property `targetLanguageCode` # Corresponds to the JSON property `targetLanguageCode`
# @return [String] # @return [String]
attr_accessor :target_language_code attr_accessor :target_language_code
@ -847,18 +825,15 @@ module Google
class TranslateTextResponse class TranslateTextResponse
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
# Text translation responses if a glossary is provided in the request. # Text translation responses if a glossary is provided in the request. This can
# This can be the same as # be the same as `translations` if no terms apply. This field has the same
# `translations` if no terms apply. # length as `contents`.
# This field has the same length as
# `contents`.
# Corresponds to the JSON property `glossaryTranslations` # Corresponds to the JSON property `glossaryTranslations`
# @return [Array<Google::Apis::TranslateV3::Translation>] # @return [Array<Google::Apis::TranslateV3::Translation>]
attr_accessor :glossary_translations attr_accessor :glossary_translations
# Text translation responses with no glossary applied. # Text translation responses with no glossary applied. This field has the same
# This field has the same length as # length as `contents`.
# `contents`.
# Corresponds to the JSON property `translations` # Corresponds to the JSON property `translations`
# @return [Array<Google::Apis::TranslateV3::Translation>] # @return [Array<Google::Apis::TranslateV3::Translation>]
attr_accessor :translations attr_accessor :translations
@ -879,26 +854,24 @@ module Google
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
# The BCP-47 language code of source text in the initial request, detected # The BCP-47 language code of source text in the initial request, detected
# automatically, if no source language was passed within the initial # automatically, if no source language was passed within the initial request. If
# request. If the source language was passed, auto-detection of the language # the source language was passed, auto-detection of the language does not occur
# does not occur and this field is empty. # and this field is empty.
# Corresponds to the JSON property `detectedLanguageCode` # Corresponds to the JSON property `detectedLanguageCode`
# @return [String] # @return [String]
attr_accessor :detected_language_code attr_accessor :detected_language_code
# Configures which glossary should be used for a specific target language, # Configures which glossary should be used for a specific target language, and
# and defines options for applying that glossary. # defines options for applying that glossary.
# Corresponds to the JSON property `glossaryConfig` # Corresponds to the JSON property `glossaryConfig`
# @return [Google::Apis::TranslateV3::TranslateTextGlossaryConfig] # @return [Google::Apis::TranslateV3::TranslateTextGlossaryConfig]
attr_accessor :glossary_config attr_accessor :glossary_config
# Only present when `model` is present in the request. # Only present when `model` is present in the request. `model` here is
# `model` here is normalized to have project number. # normalized to have project number. For example: If the `model` requested in
# For example: # TranslationTextRequest is `projects/`project-id`/locations/`location-id`/
# If the `model` requested in TranslationTextRequest is # models/general/nmt` then `model` here would be normalized to `projects/`
# `projects/`project-id`/locations/`location-id`/models/general/nmt` then # project-number`/locations/`location-id`/models/general/nmt`.
# `model` here would be normalized to
# `projects/`project-number`/locations/`location-id`/models/general/nmt`.
# Corresponds to the JSON property `model` # Corresponds to the JSON property `model`
# @return [String] # @return [String]
attr_accessor :model attr_accessor :model
@ -925,9 +898,9 @@ module Google
class WaitOperationRequest class WaitOperationRequest
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
# The maximum duration to wait before timing out. If left blank, the wait # The maximum duration to wait before timing out. If left blank, the wait will
# will be at most the time permitted by the underlying HTTP/RPC protocol. # be at most the time permitted by the underlying HTTP/RPC protocol. If RPC
# If RPC context deadline is also specified, the shorter one will be used. # context deadline is also specified, the shorter one will be used.
# Corresponds to the JSON property `timeout` # Corresponds to the JSON property `timeout`
# @return [String] # @return [String]
attr_accessor :timeout attr_accessor :timeout

273
generated/google/apis/translate_v3/service.rb
View File

@ -49,14 +49,12 @@ module Google
# Detects the language of text within a request. # Detects the language of text within a request.
# @param [String] parent # @param [String] parent
# Required. Project or location to make a call. Must refer to a caller's # Required. Project or location to make a call. Must refer to a caller's project.
# project. # Format: `projects/`project-number-or-id`/locations/`location-id`` or `
# Format: `projects/`project-number-or-id`/locations/`location-id`` or # projects/`project-number-or-id``. For global calls, use `projects/`project-
# `projects/`project-number-or-id``. # number-or-id`/locations/global` or `projects/`project-number-or-id``. Only
# For global calls, use `projects/`project-number-or-id`/locations/global` or # models within the same region (has same location-id) can be used. Otherwise an
# `projects/`project-number-or-id``. # INVALID_ARGUMENT (400) error is returned.
# Only models within the same region (has same location-id) can be used.
# Otherwise an INVALID_ARGUMENT (400) error is returned.
# @param [Google::Apis::TranslateV3::DetectLanguageRequest] detect_language_request_object # @param [Google::Apis::TranslateV3::DetectLanguageRequest] detect_language_request_object
# @param [String] fields # @param [String] fields
# Selector specifying which fields to include in a partial response. # Selector specifying which fields to include in a partial response.
@ -89,29 +87,25 @@ module Google
# Returns a list of supported languages for translation. # Returns a list of supported languages for translation.
# @param [String] parent # @param [String] parent
# Required. Project or location to make a call. Must refer to a caller's # Required. Project or location to make a call. Must refer to a caller's project.
# project. # Format: `projects/`project-number-or-id`` or `projects/`project-number-or-id`/
# Format: `projects/`project-number-or-id`` or # locations/`location-id``. For global calls, use `projects/`project-number-or-
# `projects/`project-number-or-id`/locations/`location-id``. # id`/locations/global` or `projects/`project-number-or-id``. Non-global
# For global calls, use `projects/`project-number-or-id`/locations/global` or # location is required for AutoML models. Only models within the same region (
# `projects/`project-number-or-id``. # have same location-id) can be used, otherwise an INVALID_ARGUMENT (400) error
# Non-global location is required for AutoML models. # is returned.
# Only models within the same region (have same location-id) can be used,
# otherwise an INVALID_ARGUMENT (400) error is returned.
# @param [String] display_language_code # @param [String] display_language_code
# Optional. The language to use to return localized, human readable names # Optional. The language to use to return localized, human readable names of
# of supported languages. If missing, then display names are not returned # supported languages. If missing, then display names are not returned in a
# in a response. # response.
# @param [String] model # @param [String] model
# Optional. Get supported languages of this model. # Optional. Get supported languages of this model. The format depends on model
# The format depends on model type: # type: - AutoML Translation models: `projects/`project-number-or-id`/locations/`
# - AutoML Translation models: # location-id`/models/`model-id`` - General (built-in) models: `projects/`
# `projects/`project-number-or-id`/locations/`location-id`/models/`model-id`` # project-number-or-id`/locations/`location-id`/models/general/nmt`, `projects/`
# - General (built-in) models: # project-number-or-id`/locations/`location-id`/models/general/base` Returns
# `projects/`project-number-or-id`/locations/`location-id`/models/general/nmt`, # languages supported by the specified model. If missing, we get supported
# `projects/`project-number-or-id`/locations/`location-id`/models/general/base` # languages of Google general base (PBMT) model.
# Returns languages supported by the specified model.
# If missing, we get supported languages of Google general base (PBMT) model.
# @param [String] fields # @param [String] fields
# Selector specifying which fields to include in a partial response. # Selector specifying which fields to include in a partial response.
# @param [String] quota_user # @param [String] quota_user
@ -143,16 +137,13 @@ module Google
# Translates input text and returns translated text. # Translates input text and returns translated text.
# @param [String] parent # @param [String] parent
# Required. Project or location to make a call. Must refer to a caller's # Required. Project or location to make a call. Must refer to a caller's project.
# project. # Format: `projects/`project-number-or-id`` or `projects/`project-number-or-id`/
# Format: `projects/`project-number-or-id`` or # locations/`location-id``. For global calls, use `projects/`project-number-or-
# `projects/`project-number-or-id`/locations/`location-id``. # id`/locations/global` or `projects/`project-number-or-id``. Non-global
# For global calls, use `projects/`project-number-or-id`/locations/global` or # location is required for requests using AutoML models or custom glossaries.
# `projects/`project-number-or-id``. # Models and glossaries must be within the same region (have same location-id),
# Non-global location is required for requests using AutoML models or # otherwise an INVALID_ARGUMENT (400) error is returned.
# custom glossaries.
# Models and glossaries must be within the same region (have same
# location-id), otherwise an INVALID_ARGUMENT (400) error is returned.
# @param [Google::Apis::TranslateV3::TranslateTextRequest] translate_text_request_object # @param [Google::Apis::TranslateV3::TranslateTextRequest] translate_text_request_object
# @param [String] fields # @param [String] fields
# Selector specifying which fields to include in a partial response. # Selector specifying which fields to include in a partial response.
@ -183,19 +174,18 @@ module Google
execute_or_queue_command(command, &block) execute_or_queue_command(command, &block)
end end
# Translates a large volume of text in asynchronous batch mode. # Translates a large volume of text in asynchronous batch mode. This function
# This function provides real-time output as the inputs are being processed. # provides real-time output as the inputs are being processed. If caller cancels
# If caller cancels a request, the partial results (for an input file, it's # a request, the partial results (for an input file, it's all or nothing) may
# all or nothing) may still be available on the specified output location. # still be available on the specified output location. This call returns
# This call returns immediately and you can # immediately and you can use google.longrunning.Operation.name to poll the
# use google.longrunning.Operation.name to poll the status of the call. # status of the call.
# @param [String] parent # @param [String] parent
# Required. Location to make a call. Must refer to a caller's project. # Required. Location to make a call. Must refer to a caller's project. Format: `
# Format: `projects/`project-number-or-id`/locations/`location-id``. # projects/`project-number-or-id`/locations/`location-id``. The `global`
# The `global` location is not supported for batch translation. # location is not supported for batch translation. Only AutoML Translation
# Only AutoML Translation models or glossaries within the same region (have # models or glossaries within the same region (have the same location-id) can be
# the same location-id) can be used, otherwise an INVALID_ARGUMENT (400) # used, otherwise an INVALID_ARGUMENT (400) error is returned.
# error is returned.
# @param [Google::Apis::TranslateV3::BatchTranslateTextRequest] batch_translate_text_request_object # @param [Google::Apis::TranslateV3::BatchTranslateTextRequest] batch_translate_text_request_object
# @param [String] fields # @param [String] fields
# Selector specifying which fields to include in a partial response. # Selector specifying which fields to include in a partial response.
@ -228,14 +218,12 @@ module Google
# Detects the language of text within a request. # Detects the language of text within a request.
# @param [String] parent # @param [String] parent
# Required. Project or location to make a call. Must refer to a caller's # Required. Project or location to make a call. Must refer to a caller's project.
# project. # Format: `projects/`project-number-or-id`/locations/`location-id`` or `
# Format: `projects/`project-number-or-id`/locations/`location-id`` or # projects/`project-number-or-id``. For global calls, use `projects/`project-
# `projects/`project-number-or-id``. # number-or-id`/locations/global` or `projects/`project-number-or-id``. Only
# For global calls, use `projects/`project-number-or-id`/locations/global` or # models within the same region (has same location-id) can be used. Otherwise an
# `projects/`project-number-or-id``. # INVALID_ARGUMENT (400) error is returned.
# Only models within the same region (has same location-id) can be used.
# Otherwise an INVALID_ARGUMENT (400) error is returned.
# @param [Google::Apis::TranslateV3::DetectLanguageRequest] detect_language_request_object # @param [Google::Apis::TranslateV3::DetectLanguageRequest] detect_language_request_object
# @param [String] fields # @param [String] fields
# Selector specifying which fields to include in a partial response. # Selector specifying which fields to include in a partial response.
@ -298,29 +286,25 @@ module Google
# Returns a list of supported languages for translation. # Returns a list of supported languages for translation.
# @param [String] parent # @param [String] parent
# Required. Project or location to make a call. Must refer to a caller's # Required. Project or location to make a call. Must refer to a caller's project.
# project. # Format: `projects/`project-number-or-id`` or `projects/`project-number-or-id`/
# Format: `projects/`project-number-or-id`` or # locations/`location-id``. For global calls, use `projects/`project-number-or-
# `projects/`project-number-or-id`/locations/`location-id``. # id`/locations/global` or `projects/`project-number-or-id``. Non-global
# For global calls, use `projects/`project-number-or-id`/locations/global` or # location is required for AutoML models. Only models within the same region (
# `projects/`project-number-or-id``. # have same location-id) can be used, otherwise an INVALID_ARGUMENT (400) error
# Non-global location is required for AutoML models. # is returned.
# Only models within the same region (have same location-id) can be used,
# otherwise an INVALID_ARGUMENT (400) error is returned.
# @param [String] display_language_code # @param [String] display_language_code
# Optional. The language to use to return localized, human readable names # Optional. The language to use to return localized, human readable names of
# of supported languages. If missing, then display names are not returned # supported languages. If missing, then display names are not returned in a
# in a response. # response.
# @param [String] model # @param [String] model
# Optional. Get supported languages of this model. # Optional. Get supported languages of this model. The format depends on model
# The format depends on model type: # type: - AutoML Translation models: `projects/`project-number-or-id`/locations/`
# - AutoML Translation models: # location-id`/models/`model-id`` - General (built-in) models: `projects/`
# `projects/`project-number-or-id`/locations/`location-id`/models/`model-id`` # project-number-or-id`/locations/`location-id`/models/general/nmt`, `projects/`
# - General (built-in) models: # project-number-or-id`/locations/`location-id`/models/general/base` Returns
# `projects/`project-number-or-id`/locations/`location-id`/models/general/nmt`, # languages supported by the specified model. If missing, we get supported
# `projects/`project-number-or-id`/locations/`location-id`/models/general/base` # languages of Google general base (PBMT) model.
# Returns languages supported by the specified model.
# If missing, we get supported languages of Google general base (PBMT) model.
# @param [String] fields # @param [String] fields
# Selector specifying which fields to include in a partial response. # Selector specifying which fields to include in a partial response.
# @param [String] quota_user # @param [String] quota_user
@ -391,16 +375,13 @@ module Google
# Translates input text and returns translated text. # Translates input text and returns translated text.
# @param [String] parent # @param [String] parent
# Required. Project or location to make a call. Must refer to a caller's # Required. Project or location to make a call. Must refer to a caller's project.
# project. # Format: `projects/`project-number-or-id`` or `projects/`project-number-or-id`/
# Format: `projects/`project-number-or-id`` or # locations/`location-id``. For global calls, use `projects/`project-number-or-
# `projects/`project-number-or-id`/locations/`location-id``. # id`/locations/global` or `projects/`project-number-or-id``. Non-global
# For global calls, use `projects/`project-number-or-id`/locations/global` or # location is required for requests using AutoML models or custom glossaries.
# `projects/`project-number-or-id``. # Models and glossaries must be within the same region (have same location-id),
# Non-global location is required for requests using AutoML models or # otherwise an INVALID_ARGUMENT (400) error is returned.
# custom glossaries.
# Models and glossaries must be within the same region (have same
# location-id), otherwise an INVALID_ARGUMENT (400) error is returned.
# @param [Google::Apis::TranslateV3::TranslateTextRequest] translate_text_request_object # @param [Google::Apis::TranslateV3::TranslateTextRequest] translate_text_request_object
# @param [String] fields # @param [String] fields
# Selector specifying which fields to include in a partial response. # Selector specifying which fields to include in a partial response.
@ -431,8 +412,8 @@ module Google
execute_or_queue_command(command, &block) execute_or_queue_command(command, &block)
end end
# Creates a glossary and returns the long-running operation. Returns # Creates a glossary and returns the long-running operation. Returns NOT_FOUND,
# NOT_FOUND, if the project doesn't exist. # if the project doesn't exist.
# @param [String] parent # @param [String] parent
# Required. The project name. # Required. The project name.
# @param [Google::Apis::TranslateV3::Glossary] glossary_object # @param [Google::Apis::TranslateV3::Glossary] glossary_object
@ -465,9 +446,8 @@ module Google
execute_or_queue_command(command, &block) execute_or_queue_command(command, &block)
end end
# Deletes a glossary, or cancels glossary construction # Deletes a glossary, or cancels glossary construction if the glossary isn't
# if the glossary isn't created yet. # created yet. Returns NOT_FOUND, if the glossary doesn't exist.
# Returns NOT_FOUND, if the glossary doesn't exist.
# @param [String] name # @param [String] name
# Required. The name of the glossary to delete. # Required. The name of the glossary to delete.
# @param [String] fields # @param [String] fields
@ -497,8 +477,7 @@ module Google
execute_or_queue_command(command, &block) execute_or_queue_command(command, &block)
end end
# Gets a glossary. Returns NOT_FOUND, if the glossary doesn't # Gets a glossary. Returns NOT_FOUND, if the glossary doesn't exist.
# exist.
# @param [String] name # @param [String] name
# Required. The name of the glossary to retrieve. # Required. The name of the glossary to retrieve.
# @param [String] fields # @param [String] fields
@ -528,35 +507,32 @@ module Google
execute_or_queue_command(command, &block) execute_or_queue_command(command, &block)
end end
# Lists glossaries in a project. Returns NOT_FOUND, if the project doesn't # Lists glossaries in a project. Returns NOT_FOUND, if the project doesn't exist.
# exist.
# @param [String] parent # @param [String] parent
# Required. The name of the project from which to list all of the glossaries. # Required. The name of the project from which to list all of the glossaries.
# @param [String] filter # @param [String] filter
# Optional. Filter specifying constraints of a list operation. # Optional. Filter specifying constraints of a list operation. Specify the
# Specify the constraint by the format of "key=value", where key must be # constraint by the format of "key=value", where key must be "src" or "tgt", and
# "src" or "tgt", and the value must be a valid language code. # the value must be a valid language code. For multiple restrictions,
# For multiple restrictions, concatenate them by "AND" (uppercase only), # concatenate them by "AND" (uppercase only), such as: "src=en-US AND tgt=zh-CN".
# such as: "src=en-US AND tgt=zh-CN". Notice that the exact match is used # Notice that the exact match is used here, which means using 'en-US' and 'en'
# here, which means using 'en-US' and 'en' can lead to different results, # can lead to different results, which depends on the language code you used
# which depends on the language code you used when you create the glossary. # when you create the glossary. For the unidirectional glossaries, the "src" and
# For the unidirectional glossaries, the "src" and "tgt" add restrictions # "tgt" add restrictions on the source and target language code separately. For
# on the source and target language code separately. # the equivalent term set glossaries, the "src" and/or "tgt" add restrictions on
# For the equivalent term set glossaries, the "src" and/or "tgt" add # the term set. For example: "src=en-US AND tgt=zh-CN" will only pick the
# restrictions on the term set. # unidirectional glossaries which exactly match the source language code as "en-
# For example: "src=en-US AND tgt=zh-CN" will only pick the unidirectional # US" and the target language code "zh-CN", but all equivalent term set
# glossaries which exactly match the source language code as "en-US" and the # glossaries which contain "en-US" and "zh-CN" in their language set will be
# target language code "zh-CN", but all equivalent term set glossaries which # picked. If missing, no filtering is performed.
# contain "en-US" and "zh-CN" in their language set will be picked.
# If missing, no filtering is performed.
# @param [Fixnum] page_size # @param [Fixnum] page_size
# Optional. Requested page size. The server may return fewer glossaries than # Optional. Requested page size. The server may return fewer glossaries than
# requested. If unspecified, the server picks an appropriate default. # requested. If unspecified, the server picks an appropriate default.
# @param [String] page_token # @param [String] page_token
# Optional. A token identifying a page of results the server should return. # Optional. A token identifying a page of results the server should return.
# Typically, this is the value of [ListGlossariesResponse.next_page_token] # Typically, this is the value of [ListGlossariesResponse.next_page_token]
# returned from the previous call to `ListGlossaries` method. # returned from the previous call to `ListGlossaries` method. The first page is
# The first page is returned if `page_token`is empty or missing. # returned if `page_token`is empty or missing.
# @param [String] fields # @param [String] fields
# Selector specifying which fields to include in a partial response. # Selector specifying which fields to include in a partial response.
# @param [String] quota_user # @param [String] quota_user
@ -587,15 +563,13 @@ module Google
execute_or_queue_command(command, &block) execute_or_queue_command(command, &block)
end end
# Starts asynchronous cancellation on a long-running operation. The server # Starts asynchronous cancellation on a long-running operation. The server makes
# makes a best effort to cancel the operation, but success is not # a best effort to cancel the operation, but success is not guaranteed. If the
# guaranteed. If the server doesn't support this method, it returns # server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
# `google.rpc.Code.UNIMPLEMENTED`. Clients can use # Clients can use Operations.GetOperation or other methods to check whether the
# Operations.GetOperation or # cancellation succeeded or whether the operation completed despite cancellation.
# other methods to check whether the cancellation succeeded or whether the # On successful cancellation, the operation is not deleted; instead, it becomes
# operation completed despite cancellation. On successful cancellation, # an operation with an Operation.error value with a google.rpc.Status.code of 1,
# 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`. # corresponding to `Code.CANCELLED`.
# @param [String] name # @param [String] name
# The name of the operation resource to be cancelled. # The name of the operation resource to be cancelled.
@ -629,10 +603,10 @@ module Google
execute_or_queue_command(command, &block) execute_or_queue_command(command, &block)
end end
# Deletes a long-running operation. This method indicates that the client is # Deletes a long-running operation. This method indicates that the client is no
# no longer interested in the operation result. It does not cancel the # longer interested in the operation result. It does not cancel the operation.
# operation. If the server doesn't support this method, it returns # If the server doesn't support this method, it returns `google.rpc.Code.
# `google.rpc.Code.UNIMPLEMENTED`. # UNIMPLEMENTED`.
# @param [String] name # @param [String] name
# The name of the operation resource to be deleted. # The name of the operation resource to be deleted.
# @param [String] fields # @param [String] fields
@ -662,9 +636,8 @@ module Google
execute_or_queue_command(command, &block) execute_or_queue_command(command, &block)
end end
# Gets the latest state of a long-running operation. Clients can use this # Gets the latest state of a long-running operation. Clients can use this method
# method to poll the operation result at intervals as recommended by the API # to poll the operation result at intervals as recommended by the API service.
# service.
# @param [String] name # @param [String] name
# The name of the operation resource. # The name of the operation resource.
# @param [String] fields # @param [String] fields
@ -694,15 +667,14 @@ module Google
execute_or_queue_command(command, &block) execute_or_queue_command(command, &block)
end end
# Lists operations that match the specified filter in the request. If the # Lists operations that match the specified filter in the request. If the server
# server doesn't support this method, it returns `UNIMPLEMENTED`. # doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name`
# NOTE: the `name` binding allows API services to override the binding # binding allows API services to override the binding to use different resource
# to use different resource name schemes, such as `users/*/operations`. To # name schemes, such as `users/*/operations`. To override the binding, API
# override the binding, API services can add a binding such as # services can add a binding such as `"/v1/`name=users/*`/operations"` to their
# `"/v1/`name=users/*`/operations"` to their service configuration. # service configuration. For backwards compatibility, the default name includes
# For backwards compatibility, the default name includes the operations # the operations collection id, however overriding users must ensure the name
# collection id, however overriding users must ensure the name binding # binding is the parent resource, without the operations collection id.
# is the parent resource, without the operations collection id.
# @param [String] name # @param [String] name
# The name of the operation's parent resource. # The name of the operation's parent resource.
# @param [String] filter # @param [String] filter
@ -741,15 +713,14 @@ module Google
execute_or_queue_command(command, &block) execute_or_queue_command(command, &block)
end end
# Waits for the specified long-running operation until it is done or reaches # Waits for the specified long-running operation until it is done or reaches at
# at most a specified timeout, returning the latest state. If the operation # most a specified timeout, returning the latest state. If the operation is
# is already done, the latest state is immediately returned. If the timeout # already done, the latest state is immediately returned. If the timeout
# specified is greater than the default HTTP/RPC timeout, the HTTP/RPC # specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout
# timeout is used. If the server does not support this method, it returns # is used. If the server does not support this method, it returns `google.rpc.
# `google.rpc.Code.UNIMPLEMENTED`. # Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may
# Note that this method is on a best-effort basis. It may return the latest # return the latest state before the specified timeout (including immediately),
# state before the specified timeout (including immediately), meaning even an # meaning even an immediate response is no guarantee that the operation is done.
# immediate response is no guarantee that the operation is done.
# @param [String] name # @param [String] name
# The name of the operation resource to wait on. # The name of the operation resource to wait on.
# @param [Google::Apis::TranslateV3::WaitOperationRequest] wait_operation_request_object # @param [Google::Apis::TranslateV3::WaitOperationRequest] wait_operation_request_object

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

@ -25,7 +25,7 @@ module Google
# @see https://cloud.google.com/translate/docs/quickstarts # @see https://cloud.google.com/translate/docs/quickstarts
module TranslateV3beta1 module TranslateV3beta1
VERSION = 'V3beta1' VERSION = 'V3beta1'
REVISION = '20200730' REVISION = '20200807'
# View and manage your data across Google Cloud Platform services # View and manage your data across Google Cloud Platform services
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'

315
generated/google/apis/translate_v3beta1/classes.rb
View File

@ -26,41 +26,38 @@ module Google
class BatchTranslateTextRequest class BatchTranslateTextRequest
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
# Optional. Glossaries to be applied for translation. # Optional. Glossaries to be applied for translation. It's keyed by target
# It's keyed by target language code. # language code.
# Corresponds to the JSON property `glossaries` # Corresponds to the JSON property `glossaries`
# @return [Hash<String,Google::Apis::TranslateV3beta1::TranslateTextGlossaryConfig>] # @return [Hash<String,Google::Apis::TranslateV3beta1::TranslateTextGlossaryConfig>]
attr_accessor :glossaries attr_accessor :glossaries
# Required. Input configurations. # Required. Input configurations. The total number of files matched should be <=
# The total number of files matched should be <= 1000. # 1000. The total content size should be <= 100M Unicode codepoints. The files
# The total content size should be <= 100M Unicode codepoints. # must use UTF-8 encoding.
# The files must use UTF-8 encoding.
# Corresponds to the JSON property `inputConfigs` # Corresponds to the JSON property `inputConfigs`
# @return [Array<Google::Apis::TranslateV3beta1::InputConfig>] # @return [Array<Google::Apis::TranslateV3beta1::InputConfig>]
attr_accessor :input_configs attr_accessor :input_configs
# Optional. The labels with user-defined metadata for the request. # Optional. The labels with user-defined metadata for the request. Label keys
# Label keys and values can be no longer than 63 characters # and values can be no longer than 63 characters (Unicode codepoints), can only
# (Unicode codepoints), can only contain lowercase letters, numeric # contain lowercase letters, numeric characters, underscores and dashes.
# characters, underscores and dashes. International characters are allowed. # International characters are allowed. Label values are optional. Label keys
# Label values are optional. Label keys must start with a letter. # must start with a letter. See https://cloud.google.com/translate/docs/labels
# See https://cloud.google.com/translate/docs/labels for more information. # for more information.
# Corresponds to the JSON property `labels` # Corresponds to the JSON property `labels`
# @return [Hash<String,String>] # @return [Hash<String,String>]
attr_accessor :labels attr_accessor :labels
# Optional. The models to use for translation. Map's key is target language # Optional. The models to use for translation. Map's key is target language code.
# code. Map's value is model name. Value can be a built-in general model, # Map's value is model name. Value can be a built-in general model, or an
# or an AutoML Translation model. # AutoML Translation model. The value format depends on model type: - AutoML
# The value format depends on model type: # Translation models: `projects/`project-number-or-id`/locations/`location-id`/
# - AutoML Translation models: # models/`model-id`` - General (built-in) models: `projects/`project-number-or-
# `projects/`project-number-or-id`/locations/`location-id`/models/`model-id`` # id`/locations/`location-id`/models/general/nmt`, `projects/`project-number-or-
# - General (built-in) models: # id`/locations/`location-id`/models/general/base` If the map is empty or a
# `projects/`project-number-or-id`/locations/`location-id`/models/general/nmt`, # specific model is not requested for a language pair, then default google model
# `projects/`project-number-or-id`/locations/`location-id`/models/general/base` # (nmt) is used.
# If the map is empty or a specific model is
# not requested for a language pair, then default google model (nmt) is used.
# Corresponds to the JSON property `models` # Corresponds to the JSON property `models`
# @return [Hash<String,String>] # @return [Hash<String,String>]
attr_accessor :models attr_accessor :models
@ -118,30 +115,27 @@ module Google
# @return [String] # @return [String]
attr_accessor :content attr_accessor :content
# Optional. The labels with user-defined metadata for the request. # Optional. The labels with user-defined metadata for the request. Label keys
# Label keys and values can be no longer than 63 characters # and values can be no longer than 63 characters (Unicode codepoints), can only
# (Unicode codepoints), can only contain lowercase letters, numeric # contain lowercase letters, numeric characters, underscores and dashes.
# characters, underscores and dashes. International characters are allowed. # International characters are allowed. Label values are optional. Label keys
# Label values are optional. Label keys must start with a letter. # must start with a letter. See https://cloud.google.com/translate/docs/labels
# See https://cloud.google.com/translate/docs/labels for more information. # for more information.
# Corresponds to the JSON property `labels` # Corresponds to the JSON property `labels`
# @return [Hash<String,String>] # @return [Hash<String,String>]
attr_accessor :labels attr_accessor :labels
# Optional. The format of the source text, for example, "text/html", # Optional. The format of the source text, for example, "text/html", "text/plain"
# "text/plain". If left blank, the MIME type defaults to "text/html". # . If left blank, the MIME type defaults to "text/html".
# Corresponds to the JSON property `mimeType` # Corresponds to the JSON property `mimeType`
# @return [String] # @return [String]
attr_accessor :mime_type attr_accessor :mime_type
# Optional. The language detection model to be used. # Optional. The language detection model to be used. Format: `projects/`project-
# Format: # number-or-id`/locations/`location-id`/models/language-detection/`model-id``
# `projects/`project-number-or-id`/locations/`location-id`/models/language- # Only one language detection model is currently supported: `projects/`project-
# detection/`model-id`` # number-or-id`/locations/`location-id`/models/language-detection/default`. If
# Only one language detection model is currently supported: # not specified, the default model is used.
# `projects/`project-number-or-id`/locations/`location-id`/models/language-
# detection/default`.
# If not specified, the default model is used.
# Corresponds to the JSON property `model` # Corresponds to the JSON property `model`
# @return [String] # @return [String]
attr_accessor :model attr_accessor :model
@ -205,13 +199,11 @@ module Google
end end
end end
# A generic empty message that you can re-use to avoid defining duplicated # A generic empty message that you can re-use to avoid defining duplicated empty
# empty messages in your APIs. A typical example is to use it as the request # messages in your APIs. A typical example is to use it as the request or the
# or the response type of an API method. For instance: # response type of an API method. For instance: service Foo ` rpc Bar(google.
# service Foo ` # protobuf.Empty) returns (google.protobuf.Empty); ` The JSON representation for
# rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); # `Empty` is empty JSON object ````.
# `
# The JSON representation for `Empty` is empty JSON object ````.
class Empty class Empty
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
@ -228,9 +220,9 @@ module Google
class GcsDestination class GcsDestination
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
# Required. There must be no files under 'output_uri_prefix'. # Required. There must be no files under 'output_uri_prefix'. 'output_uri_prefix'
# 'output_uri_prefix' must end with "/" and start with "gs://", otherwise an # must end with "/" and start with "gs://", otherwise an INVALID_ARGUMENT (400)
# INVALID_ARGUMENT (400) error is returned. # error is returned.
# Corresponds to the JSON property `outputUriPrefix` # Corresponds to the JSON property `outputUriPrefix`
# @return [String] # @return [String]
attr_accessor :output_uri_prefix attr_accessor :output_uri_prefix
@ -293,8 +285,8 @@ module Google
# @return [Google::Apis::TranslateV3beta1::LanguageCodePair] # @return [Google::Apis::TranslateV3beta1::LanguageCodePair]
attr_accessor :language_pair attr_accessor :language_pair
# Required. The resource name of the glossary. Glossary names have the form # Required. The resource name of the glossary. Glossary names have the form `
# `projects/`project-number-or-id`/locations/`location-id`/glossaries/`glossary- # projects/`project-number-or-id`/locations/`location-id`/glossaries/`glossary-
# id``. # id``.
# Corresponds to the JSON property `name` # Corresponds to the JSON property `name`
# @return [String] # @return [String]
@ -349,9 +341,8 @@ module Google
# @return [Google::Apis::TranslateV3beta1::GcsSource] # @return [Google::Apis::TranslateV3beta1::GcsSource]
attr_accessor :gcs_source attr_accessor :gcs_source
# Optional. Can be "text/plain" or "text/html". # Optional. Can be "text/plain" or "text/html". For `.tsv`, "text/html" is used
# For `.tsv`, "text/html" is used if mime_type is missing. # if mime_type is missing. For `.html`, this field must be "text/html" or empty.
# For `.html`, this field must be "text/html" or empty.
# For `.txt`, this field must be "text/plain" or empty. # For `.txt`, this field must be "text/plain" or empty.
# Corresponds to the JSON property `mimeType` # Corresponds to the JSON property `mimeType`
# @return [String] # @return [String]
@ -372,14 +363,14 @@ module Google
class LanguageCodePair class LanguageCodePair
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
# Required. The BCP-47 language code of the input text, for example, # Required. The BCP-47 language code of the input text, for example, "en-US".
# "en-US". Expected to be an exact match for GlossaryTerm.language_code. # Expected to be an exact match for GlossaryTerm.language_code.
# Corresponds to the JSON property `sourceLanguageCode` # Corresponds to the JSON property `sourceLanguageCode`
# @return [String] # @return [String]
attr_accessor :source_language_code attr_accessor :source_language_code
# Required. The BCP-47 language code for translation output, for example, # Required. The BCP-47 language code for translation output, for example, "zh-CN"
# "zh-CN". Expected to be an exact match for GlossaryTerm.language_code. # . Expected to be an exact match for GlossaryTerm.language_code.
# Corresponds to the JSON property `targetLanguageCode` # Corresponds to the JSON property `targetLanguageCode`
# @return [String] # @return [String]
attr_accessor :target_language_code attr_accessor :target_language_code
@ -399,9 +390,9 @@ module Google
class LanguageCodesSet class LanguageCodesSet
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
# The BCP-47 language code(s) for terms defined in the glossary. # The BCP-47 language code(s) for terms defined in the glossary. All entries are
# All entries are unique. The list contains at least two entries. # unique. The list contains at least two entries. Expected to be an exact match
# Expected to be an exact match for GlossaryTerm.language_code. # for GlossaryTerm.language_code.
# Corresponds to the JSON property `languageCodes` # Corresponds to the JSON property `languageCodes`
# @return [Array<String>] # @return [Array<String>]
attr_accessor :language_codes attr_accessor :language_codes
@ -425,9 +416,9 @@ module Google
# @return [Array<Google::Apis::TranslateV3beta1::Glossary>] # @return [Array<Google::Apis::TranslateV3beta1::Glossary>]
attr_accessor :glossaries attr_accessor :glossaries
# A token to retrieve a page of results. Pass this value in the # A token to retrieve a page of results. Pass this value in the [
# [ListGlossariesRequest.page_token] field in the subsequent call to # ListGlossariesRequest.page_token] field in the subsequent call to `
# `ListGlossaries` method to retrieve the next page of results. # ListGlossaries` method to retrieve the next page of results.
# Corresponds to the JSON property `nextPageToken` # Corresponds to the JSON property `nextPageToken`
# @return [String] # @return [String]
attr_accessor :next_page_token attr_accessor :next_page_token
@ -497,14 +488,14 @@ module Google
class Location class Location
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
# The friendly name for this location, typically a nearby city name. # The friendly name for this location, typically a nearby city name. For example,
# For example, "Tokyo". # "Tokyo".
# Corresponds to the JSON property `displayName` # Corresponds to the JSON property `displayName`
# @return [String] # @return [String]
attr_accessor :display_name attr_accessor :display_name
# Cross-service attributes for the location. For example # Cross-service attributes for the location. For example `"cloud.googleapis.com/
# `"cloud.googleapis.com/region": "us-east1"` # region": "us-east1"`
# Corresponds to the JSON property `labels` # Corresponds to the JSON property `labels`
# @return [Hash<String,String>] # @return [Hash<String,String>]
attr_accessor :labels attr_accessor :labels
@ -520,8 +511,8 @@ module Google
# @return [Hash<String,Object>] # @return [Hash<String,Object>]
attr_accessor :metadata attr_accessor :metadata
# Resource name for the location, which may vary between implementations. # Resource name for the location, which may vary between implementations. For
# For example: `"projects/example-project/locations/us-east1"` # example: `"projects/example-project/locations/us-east1"`
# Corresponds to the JSON property `name` # Corresponds to the JSON property `name`
# @return [String] # @return [String]
attr_accessor :name attr_accessor :name
@ -545,47 +536,45 @@ module Google
class Operation class Operation
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
# If the value is `false`, it means the operation is still in progress. # If the value is `false`, it means the operation is still in progress. If `true`
# If `true`, the operation is completed, and either `error` or `response` is # , the operation is completed, and either `error` or `response` is available.
# available.
# Corresponds to the JSON property `done` # Corresponds to the JSON property `done`
# @return [Boolean] # @return [Boolean]
attr_accessor :done attr_accessor :done
alias_method :done?, :done alias_method :done?, :done
# The `Status` type defines a logical error model that is suitable for # The `Status` type defines a logical error model that is suitable for different
# different programming environments, including REST APIs and RPC APIs. It is # programming environments, including REST APIs and RPC APIs. It is used by [
# used by [gRPC](https://github.com/grpc). Each `Status` message contains # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
# three pieces of data: error code, error message, and error details. # data: error code, error message, and error details. You can find out more
# You can find out more about this error model and how to work with it in the # about this error model and how to work with it in the [API Design Guide](https:
# [API Design Guide](https://cloud.google.com/apis/design/errors). # //cloud.google.com/apis/design/errors).
# Corresponds to the JSON property `error` # Corresponds to the JSON property `error`
# @return [Google::Apis::TranslateV3beta1::Status] # @return [Google::Apis::TranslateV3beta1::Status]
attr_accessor :error attr_accessor :error
# Service-specific metadata associated with the operation. It typically # Service-specific metadata associated with the operation. It typically contains
# contains progress information and common metadata such as create time. # progress information and common metadata such as create time. Some services
# Some services might not provide such metadata. Any method that returns a # might not provide such metadata. Any method that returns a long-running
# long-running operation should document the metadata type, if any. # operation should document the metadata type, if any.
# Corresponds to the JSON property `metadata` # Corresponds to the JSON property `metadata`
# @return [Hash<String,Object>] # @return [Hash<String,Object>]
attr_accessor :metadata attr_accessor :metadata
# The server-assigned name, which is only unique within the same service that # The server-assigned name, which is only unique within the same service that
# originally returns it. If you use the default HTTP mapping, the # originally returns it. If you use the default HTTP mapping, the `name` should
# `name` should be a resource name ending with `operations/`unique_id``. # be a resource name ending with `operations/`unique_id``.
# Corresponds to the JSON property `name` # Corresponds to the JSON property `name`
# @return [String] # @return [String]
attr_accessor :name attr_accessor :name
# The normal response of the operation in case of success. If the original # 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 # method returns no data on success, such as `Delete`, the response is `google.
# `google.protobuf.Empty`. If the original method is standard # protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`,
# `Get`/`Create`/`Update`, the response should be the resource. For other # the response should be the resource. For other methods, the response should
# methods, the response should have the type `XxxResponse`, where `Xxx` # have the type `XxxResponse`, where `Xxx` is the original method name. For
# is the original method name. For example, if the original method name # example, if the original method name is `TakeSnapshot()`, the inferred
# is `TakeSnapshot()`, the inferred response type is # response type is `TakeSnapshotResponse`.
# `TakeSnapshotResponse`.
# Corresponds to the JSON property `response` # Corresponds to the JSON property `response`
# @return [Hash<String,Object>] # @return [Hash<String,Object>]
attr_accessor :response attr_accessor :response
@ -623,12 +612,12 @@ module Google
end end
end end
# The `Status` type defines a logical error model that is suitable for # The `Status` type defines a logical error model that is suitable for different
# different programming environments, including REST APIs and RPC APIs. It is # programming environments, including REST APIs and RPC APIs. It is used by [
# used by [gRPC](https://github.com/grpc). Each `Status` message contains # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
# three pieces of data: error code, error message, and error details. # data: error code, error message, and error details. You can find out more
# You can find out more about this error model and how to work with it in the # about this error model and how to work with it in the [API Design Guide](https:
# [API Design Guide](https://cloud.google.com/apis/design/errors). # //cloud.google.com/apis/design/errors).
class Status class Status
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
@ -643,9 +632,9 @@ module Google
# @return [Array<Hash<String,Object>>] # @return [Array<Hash<String,Object>>]
attr_accessor :details attr_accessor :details
# A developer-facing error message, which should be in English. Any # A developer-facing error message, which should be in English. Any user-facing
# user-facing error message should be localized and sent in the # error message should be localized and sent in the google.rpc.Status.details
# google.rpc.Status.details field, or localized by the client. # field, or localized by the client.
# Corresponds to the JSON property `message` # Corresponds to the JSON property `message`
# @return [String] # @return [String]
attr_accessor :message attr_accessor :message
@ -662,8 +651,8 @@ module Google
end end
end end
# A single supported language response corresponds to information related # A single supported language response corresponds to information related to one
# to one supported language. # supported language.
class SupportedLanguage class SupportedLanguage
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
@ -673,10 +662,9 @@ module Google
# @return [String] # @return [String]
attr_accessor :display_name attr_accessor :display_name
# Supported language code, generally consisting of its ISO 639-1 # Supported language code, generally consisting of its ISO 639-1 identifier, for
# identifier, for example, 'en', 'ja'. In certain cases, BCP-47 codes # example, 'en', 'ja'. In certain cases, BCP-47 codes including language and
# including language and region identifiers are returned (for example, # region identifiers are returned (for example, 'zh-TW' and 'zh-CN')
# 'zh-TW' and 'zh-CN')
# Corresponds to the JSON property `languageCode` # Corresponds to the JSON property `languageCode`
# @return [String] # @return [String]
attr_accessor :language_code attr_accessor :language_code
@ -710,8 +698,8 @@ module Google
class SupportedLanguages class SupportedLanguages
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
# A list of supported language responses. This list contains an entry # A list of supported language responses. This list contains an entry for each
# for each language the Translation API supports. # language the Translation API supports.
# Corresponds to the JSON property `languages` # Corresponds to the JSON property `languages`
# @return [Array<Google::Apis::TranslateV3beta1::SupportedLanguage>] # @return [Array<Google::Apis::TranslateV3beta1::SupportedLanguage>]
attr_accessor :languages attr_accessor :languages
@ -726,19 +714,19 @@ module Google
end end
end end
# Configures which glossary should be used for a specific target language, # Configures which glossary should be used for a specific target language, and
# and defines options for applying that glossary. # defines options for applying that glossary.
class TranslateTextGlossaryConfig class TranslateTextGlossaryConfig
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
# Required. Specifies the glossary used for this translation. Use # Required. Specifies the glossary used for this translation. Use this format:
# this format: projects/*/locations/*/glossaries/* # projects/*/locations/*/glossaries/*
# Corresponds to the JSON property `glossary` # Corresponds to the JSON property `glossary`
# @return [String] # @return [String]
attr_accessor :glossary attr_accessor :glossary
# Optional. Indicates match is case-insensitive. # Optional. Indicates match is case-insensitive. Default value is false if
# Default value is false if missing. # missing.
# Corresponds to the JSON property `ignoreCase` # Corresponds to the JSON property `ignoreCase`
# @return [Boolean] # @return [Boolean]
attr_accessor :ignore_case attr_accessor :ignore_case
@ -759,61 +747,57 @@ module Google
class TranslateTextRequest class TranslateTextRequest
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
# Required. The content of the input in string format. # Required. The content of the input in string format. We recommend the total
# We recommend the total content be less than 30k codepoints. # content be less than 30k codepoints. Use BatchTranslateText for larger text.
# Use BatchTranslateText for larger text.
# Corresponds to the JSON property `contents` # Corresponds to the JSON property `contents`
# @return [Array<String>] # @return [Array<String>]
attr_accessor :contents attr_accessor :contents
# Configures which glossary should be used for a specific target language, # Configures which glossary should be used for a specific target language, and
# and defines options for applying that glossary. # defines options for applying that glossary.
# Corresponds to the JSON property `glossaryConfig` # Corresponds to the JSON property `glossaryConfig`
# @return [Google::Apis::TranslateV3beta1::TranslateTextGlossaryConfig] # @return [Google::Apis::TranslateV3beta1::TranslateTextGlossaryConfig]
attr_accessor :glossary_config attr_accessor :glossary_config
# Optional. The labels with user-defined metadata for the request. # Optional. The labels with user-defined metadata for the request. Label keys
# Label keys and values can be no longer than 63 characters # and values can be no longer than 63 characters (Unicode codepoints), can only
# (Unicode codepoints), can only contain lowercase letters, numeric # contain lowercase letters, numeric characters, underscores and dashes.
# characters, underscores and dashes. International characters are allowed. # International characters are allowed. Label values are optional. Label keys
# Label values are optional. Label keys must start with a letter. # must start with a letter. See https://cloud.google.com/translate/docs/labels
# See https://cloud.google.com/translate/docs/labels for more information. # for more information.
# Corresponds to the JSON property `labels` # Corresponds to the JSON property `labels`
# @return [Hash<String,String>] # @return [Hash<String,String>]
attr_accessor :labels attr_accessor :labels
# Optional. The format of the source text, for example, "text/html", # Optional. The format of the source text, for example, "text/html", "text/plain"
# "text/plain". If left blank, the MIME type defaults to "text/html". # . If left blank, the MIME type defaults to "text/html".
# Corresponds to the JSON property `mimeType` # Corresponds to the JSON property `mimeType`
# @return [String] # @return [String]
attr_accessor :mime_type attr_accessor :mime_type
# Optional. The `model` type requested for this translation. # Optional. The `model` type requested for this translation. The format depends
# The format depends on model type: # on model type: - AutoML Translation models: `projects/`project-number-or-id`/
# - AutoML Translation models: # locations/`location-id`/models/`model-id`` - General (built-in) models: `
# `projects/`project-number-or-id`/locations/`location-id`/models/`model-id`` # projects/`project-number-or-id`/locations/`location-id`/models/general/nmt`, `
# - General (built-in) models: # projects/`project-number-or-id`/locations/`location-id`/models/general/base`
# `projects/`project-number-or-id`/locations/`location-id`/models/general/nmt`, # For global (non-regionalized) requests, use `location-id` `global`. For
# `projects/`project-number-or-id`/locations/`location-id`/models/general/base` # example, `projects/`project-number-or-id`/locations/global/models/general/nmt`.
# For global (non-regionalized) requests, use `location-id` `global`.
# For example,
# `projects/`project-number-or-id`/locations/global/models/general/nmt`.
# If missing, the system decides which google base model to use. # If missing, the system decides which google base model to use.
# Corresponds to the JSON property `model` # Corresponds to the JSON property `model`
# @return [String] # @return [String]
attr_accessor :model attr_accessor :model
# Optional. The BCP-47 language code of the input text if # Optional. The BCP-47 language code of the input text if known, for example, "
# known, for example, "en-US" or "sr-Latn". Supported language codes are # en-US" or "sr-Latn". Supported language codes are listed in Language Support.
# listed in Language Support. If the source language isn't specified, the API # If the source language isn't specified, the API attempts to identify the
# attempts to identify the source language automatically and returns the # source language automatically and returns the source language within the
# source language within the response. # response.
# Corresponds to the JSON property `sourceLanguageCode` # Corresponds to the JSON property `sourceLanguageCode`
# @return [String] # @return [String]
attr_accessor :source_language_code attr_accessor :source_language_code
# Required. The BCP-47 language code to use for translation of the input # Required. The BCP-47 language code to use for translation of the input text,
# text, set to one of the language codes listed in Language Support. # set to one of the language codes listed in Language Support.
# Corresponds to the JSON property `targetLanguageCode` # Corresponds to the JSON property `targetLanguageCode`
# @return [String] # @return [String]
attr_accessor :target_language_code attr_accessor :target_language_code
@ -838,18 +822,15 @@ module Google
class TranslateTextResponse class TranslateTextResponse
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
# Text translation responses if a glossary is provided in the request. # Text translation responses if a glossary is provided in the request. This can
# This can be the same as # be the same as `translations` if no terms apply. This field has the same
# `translations` if no terms apply. # length as `contents`.
# This field has the same length as
# `contents`.
# Corresponds to the JSON property `glossaryTranslations` # Corresponds to the JSON property `glossaryTranslations`
# @return [Array<Google::Apis::TranslateV3beta1::Translation>] # @return [Array<Google::Apis::TranslateV3beta1::Translation>]
attr_accessor :glossary_translations attr_accessor :glossary_translations
# Text translation responses with no glossary applied. # Text translation responses with no glossary applied. This field has the same
# This field has the same length as # length as `contents`.
# `contents`.
# Corresponds to the JSON property `translations` # Corresponds to the JSON property `translations`
# @return [Array<Google::Apis::TranslateV3beta1::Translation>] # @return [Array<Google::Apis::TranslateV3beta1::Translation>]
attr_accessor :translations attr_accessor :translations
@ -870,26 +851,24 @@ module Google
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
# The BCP-47 language code of source text in the initial request, detected # The BCP-47 language code of source text in the initial request, detected
# automatically, if no source language was passed within the initial # automatically, if no source language was passed within the initial request. If
# request. If the source language was passed, auto-detection of the language # the source language was passed, auto-detection of the language does not occur
# does not occur and this field is empty. # and this field is empty.
# Corresponds to the JSON property `detectedLanguageCode` # Corresponds to the JSON property `detectedLanguageCode`
# @return [String] # @return [String]
attr_accessor :detected_language_code attr_accessor :detected_language_code
# Configures which glossary should be used for a specific target language, # Configures which glossary should be used for a specific target language, and
# and defines options for applying that glossary. # defines options for applying that glossary.
# Corresponds to the JSON property `glossaryConfig` # Corresponds to the JSON property `glossaryConfig`
# @return [Google::Apis::TranslateV3beta1::TranslateTextGlossaryConfig] # @return [Google::Apis::TranslateV3beta1::TranslateTextGlossaryConfig]
attr_accessor :glossary_config attr_accessor :glossary_config
# Only present when `model` is present in the request. # Only present when `model` is present in the request. `model` here is
# `model` here is normalized to have project number. # normalized to have project number. For example: If the `model` requested in
# For example: # TranslationTextRequest is `projects/`project-id`/locations/`location-id`/
# If the `model` requested in TranslationTextRequest is # models/general/nmt` then `model` here would be normalized to `projects/`
# `projects/`project-id`/locations/`location-id`/models/general/nmt` then # project-number`/locations/`location-id`/models/general/nmt`.
# `model` here would be normalized to
# `projects/`project-number`/locations/`location-id`/models/general/nmt`.
# Corresponds to the JSON property `model` # Corresponds to the JSON property `model`
# @return [String] # @return [String]
attr_accessor :model attr_accessor :model
@ -916,9 +895,9 @@ module Google
class WaitOperationRequest class WaitOperationRequest
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
# The maximum duration to wait before timing out. If left blank, the wait # The maximum duration to wait before timing out. If left blank, the wait will
# will be at most the time permitted by the underlying HTTP/RPC protocol. # be at most the time permitted by the underlying HTTP/RPC protocol. If RPC
# If RPC context deadline is also specified, the shorter one will be used. # context deadline is also specified, the shorter one will be used.
# Corresponds to the JSON property `timeout` # Corresponds to the JSON property `timeout`
# @return [String] # @return [String]
attr_accessor :timeout attr_accessor :timeout

273
generated/google/apis/translate_v3beta1/service.rb
View File

@ -49,14 +49,12 @@ module Google
# Detects the language of text within a request. # Detects the language of text within a request.
# @param [String] parent # @param [String] parent
# Required. Project or location to make a call. Must refer to a caller's # Required. Project or location to make a call. Must refer to a caller's project.
# project. # Format: `projects/`project-number-or-id`/locations/`location-id`` or `
# Format: `projects/`project-number-or-id`/locations/`location-id`` or # projects/`project-number-or-id``. For global calls, use `projects/`project-
# `projects/`project-number-or-id``. # number-or-id`/locations/global` or `projects/`project-number-or-id``. Only
# For global calls, use `projects/`project-number-or-id`/locations/global` or # models within the same region (has same location-id) can be used. Otherwise an
# `projects/`project-number-or-id``. # INVALID_ARGUMENT (400) error is returned.
# Only models within the same region (has same location-id) can be used.
# Otherwise an INVALID_ARGUMENT (400) error is returned.
# @param [Google::Apis::TranslateV3beta1::DetectLanguageRequest] detect_language_request_object # @param [Google::Apis::TranslateV3beta1::DetectLanguageRequest] detect_language_request_object
# @param [String] fields # @param [String] fields
# Selector specifying which fields to include in a partial response. # Selector specifying which fields to include in a partial response.
@ -89,29 +87,25 @@ module Google
# Returns a list of supported languages for translation. # Returns a list of supported languages for translation.
# @param [String] parent # @param [String] parent
# Required. Project or location to make a call. Must refer to a caller's # Required. Project or location to make a call. Must refer to a caller's project.
# project. # Format: `projects/`project-number-or-id`` or `projects/`project-number-or-id`/
# Format: `projects/`project-number-or-id`` or # locations/`location-id``. For global calls, use `projects/`project-number-or-
# `projects/`project-number-or-id`/locations/`location-id``. # id`/locations/global` or `projects/`project-number-or-id``. Non-global
# For global calls, use `projects/`project-number-or-id`/locations/global` or # location is required for AutoML models. Only models within the same region (
# `projects/`project-number-or-id``. # have same location-id) can be used, otherwise an INVALID_ARGUMENT (400) error
# Non-global location is required for AutoML models. # is returned.
# Only models within the same region (have same location-id) can be used,
# otherwise an INVALID_ARGUMENT (400) error is returned.
# @param [String] display_language_code # @param [String] display_language_code
# Optional. The language to use to return localized, human readable names # Optional. The language to use to return localized, human readable names of
# of supported languages. If missing, then display names are not returned # supported languages. If missing, then display names are not returned in a
# in a response. # response.
# @param [String] model # @param [String] model
# Optional. Get supported languages of this model. # Optional. Get supported languages of this model. The format depends on model
# The format depends on model type: # type: - AutoML Translation models: `projects/`project-number-or-id`/locations/`
# - AutoML Translation models: # location-id`/models/`model-id`` - General (built-in) models: `projects/`
# `projects/`project-number-or-id`/locations/`location-id`/models/`model-id`` # project-number-or-id`/locations/`location-id`/models/general/nmt`, `projects/`
# - General (built-in) models: # project-number-or-id`/locations/`location-id`/models/general/base` Returns
# `projects/`project-number-or-id`/locations/`location-id`/models/general/nmt`, # languages supported by the specified model. If missing, we get supported
# `projects/`project-number-or-id`/locations/`location-id`/models/general/base` # languages of Google general base (PBMT) model.
# Returns languages supported by the specified model.
# If missing, we get supported languages of Google general base (PBMT) model.
# @param [String] fields # @param [String] fields
# Selector specifying which fields to include in a partial response. # Selector specifying which fields to include in a partial response.
# @param [String] quota_user # @param [String] quota_user
@ -143,16 +137,13 @@ module Google
# Translates input text and returns translated text. # Translates input text and returns translated text.
# @param [String] parent # @param [String] parent
# Required. Project or location to make a call. Must refer to a caller's # Required. Project or location to make a call. Must refer to a caller's project.
# project. # Format: `projects/`project-number-or-id`` or `projects/`project-number-or-id`/
# Format: `projects/`project-number-or-id`` or # locations/`location-id``. For global calls, use `projects/`project-number-or-
# `projects/`project-number-or-id`/locations/`location-id``. # id`/locations/global` or `projects/`project-number-or-id``. Non-global
# For global calls, use `projects/`project-number-or-id`/locations/global` or # location is required for requests using AutoML models or custom glossaries.
# `projects/`project-number-or-id``. # Models and glossaries must be within the same region (have same location-id),
# Non-global location is required for requests using AutoML models or # otherwise an INVALID_ARGUMENT (400) error is returned.
# custom glossaries.
# Models and glossaries must be within the same region (have same
# location-id), otherwise an INVALID_ARGUMENT (400) error is returned.
# @param [Google::Apis::TranslateV3beta1::TranslateTextRequest] translate_text_request_object # @param [Google::Apis::TranslateV3beta1::TranslateTextRequest] translate_text_request_object
# @param [String] fields # @param [String] fields
# Selector specifying which fields to include in a partial response. # Selector specifying which fields to include in a partial response.
@ -183,19 +174,18 @@ module Google
execute_or_queue_command(command, &block) execute_or_queue_command(command, &block)
end end
# Translates a large volume of text in asynchronous batch mode. # Translates a large volume of text in asynchronous batch mode. This function
# This function provides real-time output as the inputs are being processed. # provides real-time output as the inputs are being processed. If caller cancels
# If caller cancels a request, the partial results (for an input file, it's # a request, the partial results (for an input file, it's all or nothing) may
# all or nothing) may still be available on the specified output location. # still be available on the specified output location. This call returns
# This call returns immediately and you can # immediately and you can use google.longrunning.Operation.name to poll the
# use google.longrunning.Operation.name to poll the status of the call. # status of the call.
# @param [String] parent # @param [String] parent
# Required. Location to make a call. Must refer to a caller's project. # Required. Location to make a call. Must refer to a caller's project. Format: `
# Format: `projects/`project-number-or-id`/locations/`location-id``. # projects/`project-number-or-id`/locations/`location-id``. The `global`
# The `global` location is not supported for batch translation. # location is not supported for batch translation. Only AutoML Translation
# Only AutoML Translation models or glossaries within the same region (have # models or glossaries within the same region (have the same location-id) can be
# the same location-id) can be used, otherwise an INVALID_ARGUMENT (400) # used, otherwise an INVALID_ARGUMENT (400) error is returned.
# error is returned.
# @param [Google::Apis::TranslateV3beta1::BatchTranslateTextRequest] batch_translate_text_request_object # @param [Google::Apis::TranslateV3beta1::BatchTranslateTextRequest] batch_translate_text_request_object
# @param [String] fields # @param [String] fields
# Selector specifying which fields to include in a partial response. # Selector specifying which fields to include in a partial response.
@ -228,14 +218,12 @@ module Google
# Detects the language of text within a request. # Detects the language of text within a request.
# @param [String] parent # @param [String] parent
# Required. Project or location to make a call. Must refer to a caller's # Required. Project or location to make a call. Must refer to a caller's project.
# project. # Format: `projects/`project-number-or-id`/locations/`location-id`` or `
# Format: `projects/`project-number-or-id`/locations/`location-id`` or # projects/`project-number-or-id``. For global calls, use `projects/`project-
# `projects/`project-number-or-id``. # number-or-id`/locations/global` or `projects/`project-number-or-id``. Only
# For global calls, use `projects/`project-number-or-id`/locations/global` or # models within the same region (has same location-id) can be used. Otherwise an
# `projects/`project-number-or-id``. # INVALID_ARGUMENT (400) error is returned.
# Only models within the same region (has same location-id) can be used.
# Otherwise an INVALID_ARGUMENT (400) error is returned.
# @param [Google::Apis::TranslateV3beta1::DetectLanguageRequest] detect_language_request_object # @param [Google::Apis::TranslateV3beta1::DetectLanguageRequest] detect_language_request_object
# @param [String] fields # @param [String] fields
# Selector specifying which fields to include in a partial response. # Selector specifying which fields to include in a partial response.
@ -298,29 +286,25 @@ module Google
# Returns a list of supported languages for translation. # Returns a list of supported languages for translation.
# @param [String] parent # @param [String] parent
# Required. Project or location to make a call. Must refer to a caller's # Required. Project or location to make a call. Must refer to a caller's project.
# project. # Format: `projects/`project-number-or-id`` or `projects/`project-number-or-id`/
# Format: `projects/`project-number-or-id`` or # locations/`location-id``. For global calls, use `projects/`project-number-or-
# `projects/`project-number-or-id`/locations/`location-id``. # id`/locations/global` or `projects/`project-number-or-id``. Non-global
# For global calls, use `projects/`project-number-or-id`/locations/global` or # location is required for AutoML models. Only models within the same region (
# `projects/`project-number-or-id``. # have same location-id) can be used, otherwise an INVALID_ARGUMENT (400) error
# Non-global location is required for AutoML models. # is returned.
# Only models within the same region (have same location-id) can be used,
# otherwise an INVALID_ARGUMENT (400) error is returned.
# @param [String] display_language_code # @param [String] display_language_code
# Optional. The language to use to return localized, human readable names # Optional. The language to use to return localized, human readable names of
# of supported languages. If missing, then display names are not returned # supported languages. If missing, then display names are not returned in a
# in a response. # response.
# @param [String] model # @param [String] model
# Optional. Get supported languages of this model. # Optional. Get supported languages of this model. The format depends on model
# The format depends on model type: # type: - AutoML Translation models: `projects/`project-number-or-id`/locations/`
# - AutoML Translation models: # location-id`/models/`model-id`` - General (built-in) models: `projects/`
# `projects/`project-number-or-id`/locations/`location-id`/models/`model-id`` # project-number-or-id`/locations/`location-id`/models/general/nmt`, `projects/`
# - General (built-in) models: # project-number-or-id`/locations/`location-id`/models/general/base` Returns
# `projects/`project-number-or-id`/locations/`location-id`/models/general/nmt`, # languages supported by the specified model. If missing, we get supported
# `projects/`project-number-or-id`/locations/`location-id`/models/general/base` # languages of Google general base (PBMT) model.
# Returns languages supported by the specified model.
# If missing, we get supported languages of Google general base (PBMT) model.
# @param [String] fields # @param [String] fields
# Selector specifying which fields to include in a partial response. # Selector specifying which fields to include in a partial response.
# @param [String] quota_user # @param [String] quota_user
@ -391,16 +375,13 @@ module Google
# Translates input text and returns translated text. # Translates input text and returns translated text.
# @param [String] parent # @param [String] parent
# Required. Project or location to make a call. Must refer to a caller's # Required. Project or location to make a call. Must refer to a caller's project.
# project. # Format: `projects/`project-number-or-id`` or `projects/`project-number-or-id`/
# Format: `projects/`project-number-or-id`` or # locations/`location-id``. For global calls, use `projects/`project-number-or-
# `projects/`project-number-or-id`/locations/`location-id``. # id`/locations/global` or `projects/`project-number-or-id``. Non-global
# For global calls, use `projects/`project-number-or-id`/locations/global` or # location is required for requests using AutoML models or custom glossaries.
# `projects/`project-number-or-id``. # Models and glossaries must be within the same region (have same location-id),
# Non-global location is required for requests using AutoML models or # otherwise an INVALID_ARGUMENT (400) error is returned.
# custom glossaries.
# Models and glossaries must be within the same region (have same
# location-id), otherwise an INVALID_ARGUMENT (400) error is returned.
# @param [Google::Apis::TranslateV3beta1::TranslateTextRequest] translate_text_request_object # @param [Google::Apis::TranslateV3beta1::TranslateTextRequest] translate_text_request_object
# @param [String] fields # @param [String] fields
# Selector specifying which fields to include in a partial response. # Selector specifying which fields to include in a partial response.
@ -431,8 +412,8 @@ module Google
execute_or_queue_command(command, &block) execute_or_queue_command(command, &block)
end end
# Creates a glossary and returns the long-running operation. Returns # Creates a glossary and returns the long-running operation. Returns NOT_FOUND,
# NOT_FOUND, if the project doesn't exist. # if the project doesn't exist.
# @param [String] parent # @param [String] parent
# Required. The project name. # Required. The project name.
# @param [Google::Apis::TranslateV3beta1::Glossary] glossary_object # @param [Google::Apis::TranslateV3beta1::Glossary] glossary_object
@ -465,9 +446,8 @@ module Google
execute_or_queue_command(command, &block) execute_or_queue_command(command, &block)
end end
# Deletes a glossary, or cancels glossary construction # Deletes a glossary, or cancels glossary construction if the glossary isn't
# if the glossary isn't created yet. # created yet. Returns NOT_FOUND, if the glossary doesn't exist.
# Returns NOT_FOUND, if the glossary doesn't exist.
# @param [String] name # @param [String] name
# Required. The name of the glossary to delete. # Required. The name of the glossary to delete.
# @param [String] fields # @param [String] fields
@ -497,8 +477,7 @@ module Google
execute_or_queue_command(command, &block) execute_or_queue_command(command, &block)
end end
# Gets a glossary. Returns NOT_FOUND, if the glossary doesn't # Gets a glossary. Returns NOT_FOUND, if the glossary doesn't exist.
# exist.
# @param [String] name # @param [String] name
# Required. The name of the glossary to retrieve. # Required. The name of the glossary to retrieve.
# @param [String] fields # @param [String] fields
@ -528,35 +507,32 @@ module Google
execute_or_queue_command(command, &block) execute_or_queue_command(command, &block)
end end
# Lists glossaries in a project. Returns NOT_FOUND, if the project doesn't # Lists glossaries in a project. Returns NOT_FOUND, if the project doesn't exist.
# exist.
# @param [String] parent # @param [String] parent
# Required. The name of the project from which to list all of the glossaries. # Required. The name of the project from which to list all of the glossaries.
# @param [String] filter # @param [String] filter
# Optional. Filter specifying constraints of a list operation. # Optional. Filter specifying constraints of a list operation. Specify the
# Specify the constraint by the format of "key=value", where key must be # constraint by the format of "key=value", where key must be "src" or "tgt", and
# "src" or "tgt", and the value must be a valid language code. # the value must be a valid language code. For multiple restrictions,
# For multiple restrictions, concatenate them by "AND" (uppercase only), # concatenate them by "AND" (uppercase only), such as: "src=en-US AND tgt=zh-CN".
# such as: "src=en-US AND tgt=zh-CN". Notice that the exact match is used # Notice that the exact match is used here, which means using 'en-US' and 'en'
# here, which means using 'en-US' and 'en' can lead to different results, # can lead to different results, which depends on the language code you used
# which depends on the language code you used when you create the glossary. # when you create the glossary. For the unidirectional glossaries, the "src" and
# For the unidirectional glossaries, the "src" and "tgt" add restrictions # "tgt" add restrictions on the source and target language code separately. For
# on the source and target language code separately. # the equivalent term set glossaries, the "src" and/or "tgt" add restrictions on
# For the equivalent term set glossaries, the "src" and/or "tgt" add # the term set. For example: "src=en-US AND tgt=zh-CN" will only pick the
# restrictions on the term set. # unidirectional glossaries which exactly match the source language code as "en-
# For example: "src=en-US AND tgt=zh-CN" will only pick the unidirectional # US" and the target language code "zh-CN", but all equivalent term set
# glossaries which exactly match the source language code as "en-US" and the # glossaries which contain "en-US" and "zh-CN" in their language set will be
# target language code "zh-CN", but all equivalent term set glossaries which # picked. If missing, no filtering is performed.
# contain "en-US" and "zh-CN" in their language set will be picked.
# If missing, no filtering is performed.
# @param [Fixnum] page_size # @param [Fixnum] page_size
# Optional. Requested page size. The server may return fewer glossaries than # Optional. Requested page size. The server may return fewer glossaries than
# requested. If unspecified, the server picks an appropriate default. # requested. If unspecified, the server picks an appropriate default.
# @param [String] page_token # @param [String] page_token
# Optional. A token identifying a page of results the server should return. # Optional. A token identifying a page of results the server should return.
# Typically, this is the value of [ListGlossariesResponse.next_page_token] # Typically, this is the value of [ListGlossariesResponse.next_page_token]
# returned from the previous call to `ListGlossaries` method. # returned from the previous call to `ListGlossaries` method. The first page is
# The first page is returned if `page_token`is empty or missing. # returned if `page_token`is empty or missing.
# @param [String] fields # @param [String] fields
# Selector specifying which fields to include in a partial response. # Selector specifying which fields to include in a partial response.
# @param [String] quota_user # @param [String] quota_user
@ -587,15 +563,13 @@ module Google
execute_or_queue_command(command, &block) execute_or_queue_command(command, &block)
end end
# Starts asynchronous cancellation on a long-running operation. The server # Starts asynchronous cancellation on a long-running operation. The server makes
# makes a best effort to cancel the operation, but success is not # a best effort to cancel the operation, but success is not guaranteed. If the
# guaranteed. If the server doesn't support this method, it returns # server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
# `google.rpc.Code.UNIMPLEMENTED`. Clients can use # Clients can use Operations.GetOperation or other methods to check whether the
# Operations.GetOperation or # cancellation succeeded or whether the operation completed despite cancellation.
# other methods to check whether the cancellation succeeded or whether the # On successful cancellation, the operation is not deleted; instead, it becomes
# operation completed despite cancellation. On successful cancellation, # an operation with an Operation.error value with a google.rpc.Status.code of 1,
# 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`. # corresponding to `Code.CANCELLED`.
# @param [String] name # @param [String] name
# The name of the operation resource to be cancelled. # The name of the operation resource to be cancelled.
@ -629,10 +603,10 @@ module Google
execute_or_queue_command(command, &block) execute_or_queue_command(command, &block)
end end
# Deletes a long-running operation. This method indicates that the client is # Deletes a long-running operation. This method indicates that the client is no
# no longer interested in the operation result. It does not cancel the # longer interested in the operation result. It does not cancel the operation.
# operation. If the server doesn't support this method, it returns # If the server doesn't support this method, it returns `google.rpc.Code.
# `google.rpc.Code.UNIMPLEMENTED`. # UNIMPLEMENTED`.
# @param [String] name # @param [String] name
# The name of the operation resource to be deleted. # The name of the operation resource to be deleted.
# @param [String] fields # @param [String] fields
@ -662,9 +636,8 @@ module Google
execute_or_queue_command(command, &block) execute_or_queue_command(command, &block)
end end
# Gets the latest state of a long-running operation. Clients can use this # Gets the latest state of a long-running operation. Clients can use this method
# method to poll the operation result at intervals as recommended by the API # to poll the operation result at intervals as recommended by the API service.
# service.
# @param [String] name # @param [String] name
# The name of the operation resource. # The name of the operation resource.
# @param [String] fields # @param [String] fields
@ -694,15 +667,14 @@ module Google
execute_or_queue_command(command, &block) execute_or_queue_command(command, &block)
end end
# Lists operations that match the specified filter in the request. If the # Lists operations that match the specified filter in the request. If the server
# server doesn't support this method, it returns `UNIMPLEMENTED`. # doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name`
# NOTE: the `name` binding allows API services to override the binding # binding allows API services to override the binding to use different resource
# to use different resource name schemes, such as `users/*/operations`. To # name schemes, such as `users/*/operations`. To override the binding, API
# override the binding, API services can add a binding such as # services can add a binding such as `"/v1/`name=users/*`/operations"` to their
# `"/v1/`name=users/*`/operations"` to their service configuration. # service configuration. For backwards compatibility, the default name includes
# For backwards compatibility, the default name includes the operations # the operations collection id, however overriding users must ensure the name
# collection id, however overriding users must ensure the name binding # binding is the parent resource, without the operations collection id.
# is the parent resource, without the operations collection id.
# @param [String] name # @param [String] name
# The name of the operation's parent resource. # The name of the operation's parent resource.
# @param [String] filter # @param [String] filter
@ -741,15 +713,14 @@ module Google
execute_or_queue_command(command, &block) execute_or_queue_command(command, &block)
end end
# Waits for the specified long-running operation until it is done or reaches # Waits for the specified long-running operation until it is done or reaches at
# at most a specified timeout, returning the latest state. If the operation # most a specified timeout, returning the latest state. If the operation is
# is already done, the latest state is immediately returned. If the timeout # already done, the latest state is immediately returned. If the timeout
# specified is greater than the default HTTP/RPC timeout, the HTTP/RPC # specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout
# timeout is used. If the server does not support this method, it returns # is used. If the server does not support this method, it returns `google.rpc.
# `google.rpc.Code.UNIMPLEMENTED`. # Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may
# Note that this method is on a best-effort basis. It may return the latest # return the latest state before the specified timeout (including immediately),
# state before the specified timeout (including immediately), meaning even an # meaning even an immediate response is no guarantee that the operation is done.
# immediate response is no guarantee that the operation is done.
# @param [String] name # @param [String] name
# The name of the operation resource to wait on. # The name of the operation resource to wait on.
# @param [Google::Apis::TranslateV3beta1::WaitOperationRequest] wait_operation_request_object # @param [Google::Apis::TranslateV3beta1::WaitOperationRequest] wait_operation_request_object

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

@ -25,7 +25,7 @@ module Google
# @see https://developers.google.com/maps/contact-sales/ # @see https://developers.google.com/maps/contact-sales/
module VectortileV1 module VectortileV1
VERSION = 'V1' VERSION = 'V1'
REVISION = '20200622' REVISION = '20200808'
end end
end end
end end

452
generated/google/apis/vectortile_v1/classes.rb
View File

@ -26,8 +26,8 @@ module Google
class Area class Area
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
# True if the polygon is not entirely internal to the feature that it belongs # True if the polygon is not entirely internal to the feature that it belongs to:
# to: that is, some of the edges are bordering another feature. # that is, some of the edges are bordering another feature.
# Corresponds to the JSON property `hasExternalEdges` # Corresponds to the JSON property `hasExternalEdges`
# @return [Boolean] # @return [Boolean]
attr_accessor :has_external_edges attr_accessor :has_external_edges
@ -35,29 +35,27 @@ module Google
# When has_external_edges is true, the polygon has some edges that border # When has_external_edges is true, the polygon has some edges that border
# another feature. This field indicates the internal edges that do not border # another feature. This field indicates the internal edges that do not border
# another feature. Each value is an index into the vertices array, and # another feature. Each value is an index into the vertices array, and denotes
# denotes the start vertex of the internal edge (the next vertex in the # the start vertex of the internal edge (the next vertex in the boundary loop is
# boundary loop is the end of the edge). If the selected vertex is the last # the end of the edge). If the selected vertex is the last vertex in the
# vertex in the boundary loop, then the edge between that vertex and the # boundary loop, then the edge between that vertex and the starting vertex of
# starting vertex of the loop is internal. # the loop is internal. This field may be used for styling. For example,
# This field may be used for styling. For example, building parapets could be # building parapets could be placed only on the external edges of a building
# placed only on the external edges of a building polygon, or water could be # polygon, or water could be lighter colored near the external edges of a body
# lighter colored near the external edges of a body of water. # of water. If has_external_edges is false, all edges are internal and this
# If has_external_edges is false, all edges are internal and this field will # field will be empty.
# be empty.
# Corresponds to the JSON property `internalEdges` # Corresponds to the JSON property `internalEdges`
# @return [Array<Fixnum>] # @return [Array<Fixnum>]
attr_accessor :internal_edges attr_accessor :internal_edges
# Identifies the boundary loops of the polygon. Only set for INDEXED_TRIANGLE # Identifies the boundary loops of the polygon. Only set for INDEXED_TRIANGLE
# polygons. Each value is an index into the vertices array indicating the # polygons. Each value is an index into the vertices array indicating the
# beginning of a loop. For instance, values of [2, 5] would indicate # beginning of a loop. For instance, values of [2, 5] would indicate loop_data
# loop_data contained 3 loops with indices 0-1, 2-4, and 5-end. # contained 3 loops with indices 0-1, 2-4, and 5-end. This may be used in
# This may be used in conjunction with the internal_edges field for styling # conjunction with the internal_edges field for styling polygon boundaries. Note
# polygon boundaries. Note that an edge may be on a polygon boundary but # that an edge may be on a polygon boundary but still internal to the feature.
# still internal to the feature. For example, a feature split across multiple # For example, a feature split across multiple tiles will have an internal
# tiles will have an internal polygon boundary edge along the edge of the # polygon boundary edge along the edge of the tile.
# tile.
# Corresponds to the JSON property `loopBreaks` # Corresponds to the JSON property `loopBreaks`
# @return [Array<Fixnum>] # @return [Array<Fixnum>]
attr_accessor :loop_breaks attr_accessor :loop_breaks
@ -75,21 +73,19 @@ module Google
attr_accessor :type attr_accessor :type
# 2D vertex list used for lines and areas. Each entry represents an offset from # 2D vertex list used for lines and areas. Each entry represents an offset from
# the previous one in local tile coordinates. The first entry is offset from # the previous one in local tile coordinates. The first entry is offset from (0,
# (0, 0). # 0). For example, the list of vertices [(1,1), (2, 2), (1, 2)] would be encoded
# For example, the list of vertices [(1,1), (2, 2), (1, 2)] would be encoded
# in vertex offsets as [(1, 1), (1, 1), (-1, 0)]. # in vertex offsets as [(1, 1), (1, 1), (-1, 0)].
# Corresponds to the JSON property `vertexOffsets` # Corresponds to the JSON property `vertexOffsets`
# @return [Google::Apis::VectortileV1::Vertex2DList] # @return [Google::Apis::VectortileV1::Vertex2DList]
attr_accessor :vertex_offsets attr_accessor :vertex_offsets
# The z-ordering of this area. Areas with a lower z-order should be rendered # The z-ordering of this area. Areas with a lower z-order should be rendered
# beneath areas with a higher z-order. This z-ordering does not imply # beneath areas with a higher z-order. This z-ordering does not imply anything
# anything about the altitude of the line relative to the ground, but it # about the altitude of the line relative to the ground, but it can be used to
# can be used to prevent z-fighting during rendering on the client. This # prevent z-fighting during rendering on the client. This z-ordering can only be
# z-ordering can only be used to compare areas, and cannot be compared with # used to compare areas, and cannot be compared with the z_order field in the
# the z_order field in the Line message. # Line message. The z-order may be negative or zero.
# The z-order may be negative or zero.
# Corresponds to the JSON property `zOrder` # Corresponds to the JSON property `zOrder`
# @return [Fixnum] # @return [Fixnum]
attr_accessor :z_order attr_accessor :z_order
@ -112,10 +108,9 @@ module Google
# Represents a height-extruded area: a 3D prism with a constant X-Y plane cross # Represents a height-extruded area: a 3D prism with a constant X-Y plane cross
# section. Used to represent extruded buildings. A single building may consist # section. Used to represent extruded buildings. A single building may consist
# of several extruded areas. # of several extruded areas. The min_z and max_z fields are scaled to the size
# The min_z and max_z fields are scaled to the size of the tile. An extruded # of the tile. An extruded area with a max_z value of 4096 has the same height
# area with a max_z value of 4096 has the same height as the width of the tile # as the width of the tile that it is on.
# that it is on.
class ExtrudedArea class ExtrudedArea
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
@ -129,10 +124,9 @@ module Google
# @return [Fixnum] # @return [Fixnum]
attr_accessor :max_z attr_accessor :max_z
# The z-value in local tile coordinates where the extruded area begins. This # The z-value in local tile coordinates where the extruded area begins. This is
# is non-zero for extruded areas that begin off the ground. For example, a # non-zero for extruded areas that begin off the ground. For example, a building
# building with a skybridge may have an extruded area component with a # with a skybridge may have an extruded area component with a non-zero min_z.
# non-zero min_z.
# Corresponds to the JSON property `minZ` # Corresponds to the JSON property `minZ`
# @return [Fixnum] # @return [Fixnum]
attr_accessor :min_z attr_accessor :min_z
@ -159,19 +153,17 @@ module Google
attr_accessor :display_name attr_accessor :display_name
# Represents the geometry of a feature, that is, the shape that it has on the # Represents the geometry of a feature, that is, the shape that it has on the
# map. The local tile coordinate system has the origin at the north-west # map. The local tile coordinate system has the origin at the north-west (upper-
# (upper-left) corner of the tile, and is scaled to 4096 units across each # left) corner of the tile, and is scaled to 4096 units across each edge. The
# edge. The height (Z) axis has the same scale factor: an extruded area with a # height (Z) axis has the same scale factor: an extruded area with a max_z value
# max_z value of 4096 has the same height as the width of the tile that it is # of 4096 has the same height as the width of the tile that it is on. There is
# on. # no clipping boundary, so it is possible that some coordinates will lie outside
# There is no clipping boundary, so it is possible that some coordinates will # the tile boundaries.
# lie outside the tile boundaries.
# Corresponds to the JSON property `geometry` # Corresponds to the JSON property `geometry`
# @return [Google::Apis::VectortileV1::Geometry] # @return [Google::Apis::VectortileV1::Geometry]
attr_accessor :geometry attr_accessor :geometry
# Place ID of this feature, suitable for use in Places API details # Place ID of this feature, suitable for use in Places API details requests.
# requests.
# Corresponds to the JSON property `placeId` # Corresponds to the JSON property `placeId`
# @return [String] # @return [String]
attr_accessor :place_id attr_accessor :place_id
@ -212,20 +204,18 @@ module Google
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
# Global tile coordinates. Global tile coordinates reference a specific tile on # Global tile coordinates. Global tile coordinates reference a specific tile on
# the map at a specific zoom level. # the map at a specific zoom level. The origin of this coordinate system is
# The origin of this coordinate system is always at the northwest corner of the # always at the northwest corner of the map, with x values increasing from west
# map, with x values increasing from west to east and y values increasing from # to east and y values increasing from north to south. Tiles are indexed using x,
# north to south. Tiles are indexed using x, y coordinates from that origin. # y coordinates from that origin. The zoom level containing the entire world in
# The zoom level containing the entire world in a tile is 0, and it increases # a tile is 0, and it increases as you zoom in. Zoom level n + 1 will contain 4
# as you zoom in. Zoom level n + 1 will contain 4 times as many tiles as zoom # times as many tiles as zoom level n. The zoom level controls the level of
# level n. # detail of the data that is returned. In particular, this affects the set of
# The zoom level controls the level of detail of the data that is returned. In # feature types returned, their density, and geometry simplification. The exact
# particular, this affects the set of feature types returned, their density, # tile contents may change over time, but care will be taken to keep supporting
# and geometry simplification. The exact tile contents may change over time, # the most important use cases. For example, zoom level 15 shows roads for
# but care will be taken to keep supporting the most important use cases. For # orientation and planning in the local neighborhood and zoom level 17 shows
# example, zoom level 15 shows roads for orientation and planning in the local # buildings to give users on foot a sense of situational awareness.
# neighborhood and zoom level 17 shows buildings to give users on foot a sense
# of situational awareness.
# Corresponds to the JSON property `coordinates` # Corresponds to the JSON property `coordinates`
# @return [Google::Apis::VectortileV1::TileCoordinates] # @return [Google::Apis::VectortileV1::TileCoordinates]
attr_accessor :coordinates attr_accessor :coordinates
@ -236,9 +226,9 @@ module Google
attr_accessor :features attr_accessor :features
# Resource name of the tile. The tile resource name is prefixed by its # Resource name of the tile. The tile resource name is prefixed by its
# collection ID `tiles/` followed by the resource ID, which encodes the # collection ID `tiles/` followed by the resource ID, which encodes the tile's
# tile's global x and y coordinates and zoom level as `@<x>,<y>,<zoom>z`. For # global x and y coordinates and zoom level as `@,,z`. For example, `tiles/@1,2,
# example, `tiles/@1,2,3z`. # 3z`.
# Corresponds to the JSON property `name` # Corresponds to the JSON property `name`
# @return [String] # @return [String]
attr_accessor :name attr_accessor :name
@ -253,13 +243,12 @@ module Google
# @return [String] # @return [String]
attr_accessor :status attr_accessor :status
# An opaque value, usually less than 30 characters, that contains version # An opaque value, usually less than 30 characters, that contains version info
# info about this tile and the data that was used to generate it. # about this tile and the data that was used to generate it. The client should
# The client should store this value in its tile cache and pass it back to # store this value in its tile cache and pass it back to the API in the
# the API in the client_tile_version_id field of subsequent tile requests in # client_tile_version_id field of subsequent tile requests in order to enable
# order to enable the API to detect when the new tile would be the same as # the API to detect when the new tile would be the same as the one the client
# the one the client already has in its cache. # already has in its cache. Also see STATUS_OK_DATA_UNCHANGED.
# Also see STATUS_OK_DATA_UNCHANGED.
# Corresponds to the JSON property `versionId` # Corresponds to the JSON property `versionId`
# @return [String] # @return [String]
attr_accessor :version_id attr_accessor :version_id
@ -280,29 +269,17 @@ module Google
end end
# A packed representation of a 2D grid of uniformly spaced points containing # A packed representation of a 2D grid of uniformly spaced points containing
# elevation data. Each point within the grid represents the altitude in # elevation data. Each point within the grid represents the altitude in meters
# meters above average sea level at that location within the tile. # above average sea level at that location within the tile. Elevations provided
# Elevations provided are (generally) relative to the EGM96 geoid, however # are (generally) relative to the EGM96 geoid, however some areas will be
# some areas will be relative to NAVD88. EGM96 and NAVD88 are off by no more # relative to NAVD88. EGM96 and NAVD88 are off by no more than 2 meters. The
# than 2 meters. # grid is oriented north-west to south-east, as illustrated: rows[0].a[0] rows[0]
# The grid is oriented north-west to south-east, as illustrated: # .a[m] +-----------------+ | | | N | | ^ | | | | | W <-----> E | | | | | v | |
# rows[0].a[0] rows[0].a[m] # S | | | +-----------------+ rows[n].a[0] rows[n].a[m] Rather than storing the
# +-----------------+ # altitudes directly, we store the diffs between them as integers at some
# | | # requested level of precision to take advantage of integer packing. The actual
# | N | # altitude values a[] can be reconstructed using the scale and each row's
# | ^ | # first_altitude and altitude_diff fields.
# | | |
# | W <-----> E |
# | | |
# | v |
# | S |
# | |
# +-----------------+
# rows[n].a[0] rows[n].a[m]
# Rather than storing the altitudes directly, we store the diffs between them
# as integers at some requested level of precision to take advantage of
# integer packing. The actual altitude values a[] can be reconstructed using
# the scale and each row's first_altitude and altitude_diff fields.
class FirstDerivativeElevationGrid class FirstDerivativeElevationGrid
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
@ -312,9 +289,9 @@ module Google
# @return [Float] # @return [Float]
attr_accessor :altitude_multiplier attr_accessor :altitude_multiplier
# Rows of points containing altitude data making up the elevation grid. # Rows of points containing altitude data making up the elevation grid. Each row
# Each row is the same length. Rows are ordered from north to south. E.g: # is the same length. Rows are ordered from north to south. E.g: rows[0] is the
# rows[0] is the north-most row, and rows[n] is the south-most row. # north-most row, and rows[n] is the south-most row.
# Corresponds to the JSON property `rows` # Corresponds to the JSON property `rows`
# @return [Array<Google::Apis::VectortileV1::Row>] # @return [Array<Google::Apis::VectortileV1::Row>]
attr_accessor :rows attr_accessor :rows
@ -331,13 +308,12 @@ module Google
end end
# Represents the geometry of a feature, that is, the shape that it has on the # Represents the geometry of a feature, that is, the shape that it has on the
# map. The local tile coordinate system has the origin at the north-west # map. The local tile coordinate system has the origin at the north-west (upper-
# (upper-left) corner of the tile, and is scaled to 4096 units across each # left) corner of the tile, and is scaled to 4096 units across each edge. The
# edge. The height (Z) axis has the same scale factor: an extruded area with a # height (Z) axis has the same scale factor: an extruded area with a max_z value
# max_z value of 4096 has the same height as the width of the tile that it is # of 4096 has the same height as the width of the tile that it is on. There is
# on. # no clipping boundary, so it is possible that some coordinates will lie outside
# There is no clipping boundary, so it is possible that some coordinates will # the tile boundaries.
# lie outside the tile boundaries.
class Geometry class Geometry
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
@ -380,22 +356,20 @@ module Google
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
# 2D vertex list used for lines and areas. Each entry represents an offset from # 2D vertex list used for lines and areas. Each entry represents an offset from
# the previous one in local tile coordinates. The first entry is offset from # the previous one in local tile coordinates. The first entry is offset from (0,
# (0, 0). # 0). For example, the list of vertices [(1,1), (2, 2), (1, 2)] would be encoded
# For example, the list of vertices [(1,1), (2, 2), (1, 2)] would be encoded
# in vertex offsets as [(1, 1), (1, 1), (-1, 0)]. # in vertex offsets as [(1, 1), (1, 1), (-1, 0)].
# Corresponds to the JSON property `vertexOffsets` # Corresponds to the JSON property `vertexOffsets`
# @return [Google::Apis::VectortileV1::Vertex2DList] # @return [Google::Apis::VectortileV1::Vertex2DList]
attr_accessor :vertex_offsets attr_accessor :vertex_offsets
# The z-order of the line. Lines with a lower z-order should be rendered # The z-order of the line. Lines with a lower z-order should be rendered beneath
# beneath lines with a higher z-order. This z-ordering does not imply # lines with a higher z-order. This z-ordering does not imply anything about the
# anything about the altitude of the area relative to the ground, but it # altitude of the area relative to the ground, but it can be used to prevent z-
# can be used to prevent z-fighting during rendering on the client. In # fighting during rendering on the client. In general, larger and more important
# general, larger and more important road features will have a higher z-order # road features will have a higher z-order line associated with them. This z-
# line associated with them. This z-ordering can only be used to compare # ordering can only be used to compare lines, and cannot be compared with the
# lines, and cannot be compared with the z_order field in the Area message. # z_order field in the Area message. The z-order may be negative or zero.
# The z-order may be negative or zero.
# Corresponds to the JSON property `zOrder` # Corresponds to the JSON property `zOrder`
# @return [Fixnum] # @return [Fixnum]
attr_accessor :z_order attr_accessor :z_order
@ -464,8 +438,8 @@ module Google
class Relation class Relation
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
# Zero-based index to look up the related feature from the list of features # Zero-based index to look up the related feature from the list of features in
# in the tile. # the tile.
# Corresponds to the JSON property `relatedFeatureIndex` # Corresponds to the JSON property `relatedFeatureIndex`
# @return [Fixnum] # @return [Fixnum]
attr_accessor :related_feature_index attr_accessor :related_feature_index
@ -490,8 +464,8 @@ module Google
class RoadInfo class RoadInfo
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
# Road has signage discouraging or prohibiting use by the general public. # Road has signage discouraging or prohibiting use by the general public. E.g.,
# E.g., roads with signs that say "Private", or "No trespassing." # roads with signs that say "Private", or "No trespassing."
# Corresponds to the JSON property `isPrivate` # Corresponds to the JSON property `isPrivate`
# @return [Boolean] # @return [Boolean]
attr_accessor :is_private attr_accessor :is_private
@ -507,18 +481,17 @@ module Google
end end
end end
# A row of altitude points in the elevation grid, ordered from west to # A row of altitude points in the elevation grid, ordered from west to east.
# east.
class Row class Row
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
# The difference between each successive pair of altitudes, from west to # The difference between each successive pair of altitudes, from west to east.
# east. The first, westmost point, is just the altitude rather than a # The first, westmost point, is just the altitude rather than a diff. The units
# diff. The units are specified by the altitude_multiplier parameter # are specified by the altitude_multiplier parameter above; the value in meters
# above; the value in meters is given by altitude_multiplier * # is given by altitude_multiplier * altitude_diffs[n]. The altitude row (in
# altitude_diffs[n]. The altitude row (in metres above sea level) can be # metres above sea level) can be reconstructed with: a[0] = altitude_diffs[0] *
# reconstructed with: a[0] = altitude_diffs[0] * altitude_multiplier when # altitude_multiplier when n > 0, a[n] = a[n-1] + altitude_diffs[n-1] *
# n > 0, a[n] = a[n-1] + altitude_diffs[n-1] * altitude_multiplier. # altitude_multiplier.
# Corresponds to the JSON property `altitudeDiffs` # Corresponds to the JSON property `altitudeDiffs`
# @return [Array<Fixnum>] # @return [Array<Fixnum>]
attr_accessor :altitude_diffs attr_accessor :altitude_diffs
@ -534,35 +507,22 @@ module Google
end end
# A packed representation of a 2D grid of uniformly spaced points containing # A packed representation of a 2D grid of uniformly spaced points containing
# elevation data. Each point within the grid represents the altitude in # elevation data. Each point within the grid represents the altitude in meters
# meters above average sea level at that location within the tile. # above average sea level at that location within the tile. Elevations provided
# Elevations provided are (generally) relative to the EGM96 geoid, however # are (generally) relative to the EGM96 geoid, however some areas will be
# some areas will be relative to NAVD88. EGM96 and NAVD88 are off by no more # relative to NAVD88. EGM96 and NAVD88 are off by no more than 2 meters. The
# than 2 meters. # grid is oriented north-west to south-east, as illustrated: rows[0].a[0] rows[0]
# The grid is oriented north-west to south-east, as illustrated: # .a[m] +-----------------+ | | | N | | ^ | | | | | W <-----> E | | | | | v | |
# rows[0].a[0] rows[0].a[m] # S | | | +-----------------+ rows[n].a[0] rows[n].a[m] Rather than storing the
# +-----------------+ # altitudes directly, we store the diffs of the diffs between them as integers
# | | # at some requested level of precision to take advantage of integer packing.
# | N | # Note that the data is packed in such a way that is fast to decode in Unity and
# | ^ | # that further optimizes wire size.
# | | |
# | W <-----> E |
# | | |
# | v |
# | S |
# | |
# +-----------------+
# rows[n].a[0] rows[n].a[m]
# Rather than storing the altitudes directly, we store the diffs of the diffs
# between them as integers at some requested level of precision to take
# advantage of integer packing.
# Note that the data is packed in such a way that is fast to decode in
# Unity and that further optimizes wire size.
class SecondDerivativeElevationGrid class SecondDerivativeElevationGrid
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
# A multiplier applied to the elements in the encoded data to extract the # A multiplier applied to the elements in the encoded data to extract the actual
# actual altitudes in meters. # altitudes in meters.
# Corresponds to the JSON property `altitudeMultiplier` # Corresponds to the JSON property `altitudeMultiplier`
# @return [Float] # @return [Float]
attr_accessor :altitude_multiplier attr_accessor :altitude_multiplier
@ -573,37 +533,29 @@ module Google
# @return [Fixnum] # @return [Fixnum]
attr_accessor :column_count attr_accessor :column_count
# A stream of elements each representing a point on the tile running across # A stream of elements each representing a point on the tile running across each
# each row from left to right, top to bottom. # row from left to right, top to bottom. There will be precisely
# There will be precisely horizontal_resolution * vertical_resolution # horizontal_resolution * vertical_resolution elements in the stream. The
# elements in the stream. # elements are not the heights, rather the second order derivative of the values
# The elements are not the heights, rather the second order derivative of # one would expect in a stream of height data. Each element is a varint with the
# the values one would expect in a stream of height data. # following encoding: -----------------------------------------------------------
# Each element is a varint with the following encoding: # -------------| | Head Nibble | ------------------------------------------------
# ------------------------------------------------------------------------| # ------------------------| | Bit 0 | Bit 1 | Bits 2-3 | | Terminator| Sign (1=
# | Head Nibble | # neg) | Least significant 2 bits of absolute error | ---------------------------
# ------------------------------------------------------------------------| # ---------------------------------------------| | Tail Nibble #1 | -------------
# | Bit 0 | Bit 1 | Bits 2-3 | # -----------------------------------------------------------| | Bit 0 | Bit 1-3
# | Terminator| Sign (1=neg) | Least significant 2 bits of absolute error | # | | Terminator| Least significant 3 bits of absolute error | ------------------
# ------------------------------------------------------------------------| # ------------------------------------------------------| | ... | Tail Nibble #n
# | Tail Nibble #1 | # | ------------------------------------------------------------------------| |
# ------------------------------------------------------------------------| # Bit 0 | Bit 1-3 | | Terminator| Least significant 3 bits of absolute error | --
# | Bit 0 | Bit 1-3 | # ----------------------------------------------------------------------|
# | Terminator| Least significant 3 bits of absolute error |
# ------------------------------------------------------------------------|
# | ...
# | Tail Nibble #n |
# ------------------------------------------------------------------------|
# | Bit 0 | Bit 1-3 |
# | Terminator| Least significant 3 bits of absolute error |
# ------------------------------------------------------------------------|
# Corresponds to the JSON property `encodedData` # Corresponds to the JSON property `encodedData`
# NOTE: Values are automatically base64 encoded/decoded in the client library. # NOTE: Values are automatically base64 encoded/decoded in the client library.
# @return [String] # @return [String]
attr_accessor :encoded_data attr_accessor :encoded_data
# The number of rows included in the encoded elevation data (i.e. the # The number of rows included in the encoded elevation data (i.e. the vertical
# vertical resolution of the grid). # resolution of the grid).
# Corresponds to the JSON property `rowCount` # Corresponds to the JSON property `rowCount`
# @return [Fixnum] # @return [Fixnum]
attr_accessor :row_count attr_accessor :row_count
@ -646,85 +598,58 @@ module Google
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
# Global tile coordinates. Global tile coordinates reference a specific tile on # Global tile coordinates. Global tile coordinates reference a specific tile on
# the map at a specific zoom level. # the map at a specific zoom level. The origin of this coordinate system is
# The origin of this coordinate system is always at the northwest corner of the # always at the northwest corner of the map, with x values increasing from west
# map, with x values increasing from west to east and y values increasing from # to east and y values increasing from north to south. Tiles are indexed using x,
# north to south. Tiles are indexed using x, y coordinates from that origin. # y coordinates from that origin. The zoom level containing the entire world in
# The zoom level containing the entire world in a tile is 0, and it increases # a tile is 0, and it increases as you zoom in. Zoom level n + 1 will contain 4
# as you zoom in. Zoom level n + 1 will contain 4 times as many tiles as zoom # times as many tiles as zoom level n. The zoom level controls the level of
# level n. # detail of the data that is returned. In particular, this affects the set of
# The zoom level controls the level of detail of the data that is returned. In # feature types returned, their density, and geometry simplification. The exact
# particular, this affects the set of feature types returned, their density, # tile contents may change over time, but care will be taken to keep supporting
# and geometry simplification. The exact tile contents may change over time, # the most important use cases. For example, zoom level 15 shows roads for
# but care will be taken to keep supporting the most important use cases. For # orientation and planning in the local neighborhood and zoom level 17 shows
# example, zoom level 15 shows roads for orientation and planning in the local # buildings to give users on foot a sense of situational awareness.
# neighborhood and zoom level 17 shows buildings to give users on foot a sense
# of situational awareness.
# Corresponds to the JSON property `coordinates` # Corresponds to the JSON property `coordinates`
# @return [Google::Apis::VectortileV1::TileCoordinates] # @return [Google::Apis::VectortileV1::TileCoordinates]
attr_accessor :coordinates attr_accessor :coordinates
# A packed representation of a 2D grid of uniformly spaced points containing # A packed representation of a 2D grid of uniformly spaced points containing
# elevation data. Each point within the grid represents the altitude in # elevation data. Each point within the grid represents the altitude in meters
# meters above average sea level at that location within the tile. # above average sea level at that location within the tile. Elevations provided
# Elevations provided are (generally) relative to the EGM96 geoid, however # are (generally) relative to the EGM96 geoid, however some areas will be
# some areas will be relative to NAVD88. EGM96 and NAVD88 are off by no more # relative to NAVD88. EGM96 and NAVD88 are off by no more than 2 meters. The
# than 2 meters. # grid is oriented north-west to south-east, as illustrated: rows[0].a[0] rows[0]
# The grid is oriented north-west to south-east, as illustrated: # .a[m] +-----------------+ | | | N | | ^ | | | | | W <-----> E | | | | | v | |
# rows[0].a[0] rows[0].a[m] # S | | | +-----------------+ rows[n].a[0] rows[n].a[m] Rather than storing the
# +-----------------+ # altitudes directly, we store the diffs between them as integers at some
# | | # requested level of precision to take advantage of integer packing. The actual
# | N | # altitude values a[] can be reconstructed using the scale and each row's
# | ^ | # first_altitude and altitude_diff fields.
# | | |
# | W <-----> E |
# | | |
# | v |
# | S |
# | |
# +-----------------+
# rows[n].a[0] rows[n].a[m]
# Rather than storing the altitudes directly, we store the diffs between them
# as integers at some requested level of precision to take advantage of
# integer packing. The actual altitude values a[] can be reconstructed using
# the scale and each row's first_altitude and altitude_diff fields.
# Corresponds to the JSON property `firstDerivative` # Corresponds to the JSON property `firstDerivative`
# @return [Google::Apis::VectortileV1::FirstDerivativeElevationGrid] # @return [Google::Apis::VectortileV1::FirstDerivativeElevationGrid]
attr_accessor :first_derivative attr_accessor :first_derivative
# Resource name of the tile. The tile resource name is prefixed by its # Resource name of the tile. The tile resource name is prefixed by its
# collection ID `terrain/` followed by the resource ID, which encodes the # collection ID `terrain/` followed by the resource ID, which encodes the tile's
# tile's global x and y coordinates and zoom level as `@<x>,<y>,<zoom>z`. # global x and y coordinates and zoom level as `@,,z`. For example, `terrain/@1,
# For example, `terrain/@1,2,3z`. # 2,3z`.
# Corresponds to the JSON property `name` # Corresponds to the JSON property `name`
# @return [String] # @return [String]
attr_accessor :name attr_accessor :name
# A packed representation of a 2D grid of uniformly spaced points containing # A packed representation of a 2D grid of uniformly spaced points containing
# elevation data. Each point within the grid represents the altitude in # elevation data. Each point within the grid represents the altitude in meters
# meters above average sea level at that location within the tile. # above average sea level at that location within the tile. Elevations provided
# Elevations provided are (generally) relative to the EGM96 geoid, however # are (generally) relative to the EGM96 geoid, however some areas will be
# some areas will be relative to NAVD88. EGM96 and NAVD88 are off by no more # relative to NAVD88. EGM96 and NAVD88 are off by no more than 2 meters. The
# than 2 meters. # grid is oriented north-west to south-east, as illustrated: rows[0].a[0] rows[0]
# The grid is oriented north-west to south-east, as illustrated: # .a[m] +-----------------+ | | | N | | ^ | | | | | W <-----> E | | | | | v | |
# rows[0].a[0] rows[0].a[m] # S | | | +-----------------+ rows[n].a[0] rows[n].a[m] Rather than storing the
# +-----------------+ # altitudes directly, we store the diffs of the diffs between them as integers
# | | # at some requested level of precision to take advantage of integer packing.
# | N | # Note that the data is packed in such a way that is fast to decode in Unity and
# | ^ | # that further optimizes wire size.
# | | |
# | W <-----> E |
# | | |
# | v |
# | S |
# | |
# +-----------------+
# rows[n].a[0] rows[n].a[m]
# Rather than storing the altitudes directly, we store the diffs of the diffs
# between them as integers at some requested level of precision to take
# advantage of integer packing.
# Note that the data is packed in such a way that is fast to decode in
# Unity and that further optimizes wire size.
# Corresponds to the JSON property `secondDerivative` # Corresponds to the JSON property `secondDerivative`
# @return [Google::Apis::VectortileV1::SecondDerivativeElevationGrid] # @return [Google::Apis::VectortileV1::SecondDerivativeElevationGrid]
attr_accessor :second_derivative attr_accessor :second_derivative
@ -743,20 +668,18 @@ module Google
end end
# Global tile coordinates. Global tile coordinates reference a specific tile on # Global tile coordinates. Global tile coordinates reference a specific tile on
# the map at a specific zoom level. # the map at a specific zoom level. The origin of this coordinate system is
# The origin of this coordinate system is always at the northwest corner of the # always at the northwest corner of the map, with x values increasing from west
# map, with x values increasing from west to east and y values increasing from # to east and y values increasing from north to south. Tiles are indexed using x,
# north to south. Tiles are indexed using x, y coordinates from that origin. # y coordinates from that origin. The zoom level containing the entire world in
# The zoom level containing the entire world in a tile is 0, and it increases # a tile is 0, and it increases as you zoom in. Zoom level n + 1 will contain 4
# as you zoom in. Zoom level n + 1 will contain 4 times as many tiles as zoom # times as many tiles as zoom level n. The zoom level controls the level of
# level n. # detail of the data that is returned. In particular, this affects the set of
# The zoom level controls the level of detail of the data that is returned. In # feature types returned, their density, and geometry simplification. The exact
# particular, this affects the set of feature types returned, their density, # tile contents may change over time, but care will be taken to keep supporting
# and geometry simplification. The exact tile contents may change over time, # the most important use cases. For example, zoom level 15 shows roads for
# but care will be taken to keep supporting the most important use cases. For # orientation and planning in the local neighborhood and zoom level 17 shows
# example, zoom level 15 shows roads for orientation and planning in the local # buildings to give users on foot a sense of situational awareness.
# neighborhood and zoom level 17 shows buildings to give users on foot a sense
# of situational awareness.
class TileCoordinates class TileCoordinates
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
@ -788,14 +711,10 @@ module Google
end end
# Represents a strip of triangles. Each triangle uses the last edge of the # Represents a strip of triangles. Each triangle uses the last edge of the
# previous one. The following diagram shows an example of a triangle strip, # previous one. The following diagram shows an example of a triangle strip, with
# with each vertex labeled with its index in the vertex_index array. # each vertex labeled with its index in the vertex_index array. (1)-----(3) / \ /
# (1)-----(3) # \ / \ / \ / \ / \ (0)-----(2)-----(4) Vertices may be in either clockwise or
# / \ / \ # counter-clockwise order.
# / \ / \
# / \ / \
# (0)-----(2)-----(4)
# Vertices may be in either clockwise or counter-clockwise order.
class TriangleStrip class TriangleStrip
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
@ -816,9 +735,8 @@ module Google
end end
# 2D vertex list used for lines and areas. Each entry represents an offset from # 2D vertex list used for lines and areas. Each entry represents an offset from
# the previous one in local tile coordinates. The first entry is offset from # the previous one in local tile coordinates. The first entry is offset from (0,
# (0, 0). # 0). For example, the list of vertices [(1,1), (2, 2), (1, 2)] would be encoded
# For example, the list of vertices [(1,1), (2, 2), (1, 2)] would be encoded
# in vertex offsets as [(1, 1), (1, 1), (-1, 0)]. # in vertex offsets as [(1, 1), (1, 1), (-1, 0)].
class Vertex2DList class Vertex2DList
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable

163
generated/google/apis/vectortile_v1/service.rb
View File

@ -49,73 +49,69 @@ module Google
# Gets a feature tile by its tile resource name. # Gets a feature tile by its tile resource name.
# @param [String] name # @param [String] name
# Required. Resource name of the tile. The tile resource name is prefixed by # Required. Resource name of the tile. The tile resource name is prefixed by its
# its collection ID `tiles/` followed by the resource ID, which encodes the # collection ID `tiles/` followed by the resource ID, which encodes the tile's
# tile's global x and y coordinates and zoom level as `@<x>,<y>,<zoom>z`. # global x and y coordinates and zoom level as `@,,z`. For example, `tiles/@1,2,
# For example, `tiles/@1,2,3z`. # 3z`.
# @param [String] client_info_api_client # @param [String] client_info_api_client
# API client name and version. For example, the SDK calling the API. The # API client name and version. For example, the SDK calling the API. The exact
# exact format is up to the client. # format is up to the client.
# @param [String] client_info_application_id # @param [String] client_info_application_id
# Application ID, such as the package name on Android and the bundle # Application ID, such as the package name on Android and the bundle identifier
# identifier on iOS platforms. # on iOS platforms.
# @param [String] client_info_application_version # @param [String] client_info_application_version
# Application version number, such as "1.2.3". The exact format is # Application version number, such as "1.2.3". The exact format is application-
# application-dependent. # dependent.
# @param [String] client_info_device_model # @param [String] client_info_device_model
# Device model as reported by the device. The exact format is # Device model as reported by the device. The exact format is platform-dependent.
# platform-dependent.
# @param [String] client_info_operating_system # @param [String] client_info_operating_system
# Operating system name and version as reported by the OS. For example, # Operating system name and version as reported by the OS. For example, "Mac OS
# "Mac OS X 10.10.4". The exact format is platform-dependent. # X 10.10.4". The exact format is platform-dependent.
# @param [String] client_info_platform # @param [String] client_info_platform
# Platform where the application is running. # Platform where the application is running.
# @param [String] client_info_user_id # @param [String] client_info_user_id
# A client-generated user ID. The ID should be generated and persisted during # Required. A client-generated user ID. The ID should be generated and persisted
# the first user session or whenever a pre-existing ID is not found. The # during the first user session or whenever a pre-existing ID is not found. The
# exact format is up to the client. This must be non-empty in a # exact format is up to the client. This must be non-empty in a
# GetFeatureTileRequest (whether via the header or # GetFeatureTileRequest (whether via the header or GetFeatureTileRequest.
# GetFeatureTileRequest.client_info). # client_info).
# @param [String] client_tile_version_id # @param [String] client_tile_version_id
# Optional version id identifying the tile that is already in the client's # Optional version id identifying the tile that is already in the client's cache.
# cache. This field should be populated with the most recent version_id value # This field should be populated with the most recent version_id value returned
# returned by the API for the requested tile. # by the API for the requested tile. If the version id is empty the server
# If the version id is empty the server always returns a newly rendered tile. # always returns a newly rendered tile. If it is provided the server checks if
# If it is provided the server checks if the tile contents would be identical # the tile contents would be identical to one that's already on the client, and
# to one that's already on the client, and if so, returns a stripped-down # if so, returns a stripped-down response tile with STATUS_OK_DATA_UNCHANGED
# response tile with STATUS_OK_DATA_UNCHANGED instead. # instead.
# @param [Boolean] enable_detailed_highway_types # @param [Boolean] enable_detailed_highway_types
# Flag indicating whether detailed highway types should be returned. If this # Flag indicating whether detailed highway types should be returned. If this is
# is set, the CONTROLLED_ACCESS_HIGHWAY type may be returned. If not, then # set, the CONTROLLED_ACCESS_HIGHWAY type may be returned. If not, then these
# these highways will have the generic HIGHWAY type. # highways will have the generic HIGHWAY type. This exists for backwards
# This exists for backwards compatibility reasons. # compatibility reasons.
# @param [Boolean] enable_feature_names # @param [Boolean] enable_feature_names
# Flag indicating whether human-readable names should be returned for # Flag indicating whether human-readable names should be returned for features.
# features. If this is set, the display_name field on the feature will be # If this is set, the display_name field on the feature will be filled out.
# filled out.
# @param [Boolean] enable_modeled_volumes # @param [Boolean] enable_modeled_volumes
# Flag indicating whether 3D building models should be enabled. If this is # Flag indicating whether 3D building models should be enabled. If this is set
# set structures will be returned as 3D modeled volumes rather than 2.5D # structures will be returned as 3D modeled volumes rather than 2.5D extruded
# extruded areas where possible. # areas where possible.
# @param [Boolean] enable_political_features # @param [Boolean] enable_political_features
# Flag indicating whether political features should be returned. # Flag indicating whether political features should be returned.
# @param [Boolean] enable_private_roads # @param [Boolean] enable_private_roads
# Flag indicating whether the returned tile will contain road features that # Flag indicating whether the returned tile will contain road features that are
# are marked private. Private roads are indicated by the # marked private. Private roads are indicated by the Feature.segment_info.
# Feature.segment_info.road_info.is_private field. # road_info.is_private field.
# @param [Boolean] enable_unclipped_buildings # @param [Boolean] enable_unclipped_buildings
# Flag indicating whether unclipped buildings should be returned. If this is # Flag indicating whether unclipped buildings should be returned. If this is set,
# set, building render ops will extend beyond the tile boundary. Buildings # building render ops will extend beyond the tile boundary. Buildings will only
# will only be returned on the tile that contains their centroid. # be returned on the tile that contains their centroid.
# @param [String] language_code # @param [String] language_code
# Required. The BCP-47 language code corresponding to the language in which # Required. The BCP-47 language code corresponding to the language in which the
# the name was requested, such as "en-US" or "sr-Latn". # name was requested, such as "en-US" or "sr-Latn". For more information, see
# For more information, see
# http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. # http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
# @param [String] region_code # @param [String] region_code
# Required. The Unicode country/region code (CLDR) of the location from which # Required. The Unicode country/region code (CLDR) of the location from which
# the request is coming from, such as "US" and "419". # the request is coming from, such as "US" and "419". For more information, see
# For more information, see
# http://www.unicode.org/reports/tr35/#unicode_region_subtag. # http://www.unicode.org/reports/tr35/#unicode_region_subtag.
# @param [String] fields # @param [String] fields
# Selector specifying which fields to include in a partial response. # Selector specifying which fields to include in a partial response.
@ -162,60 +158,51 @@ module Google
# Gets a terrain tile by its tile resource name. # Gets a terrain tile by its tile resource name.
# @param [String] name # @param [String] name
# Required. Resource name of the tile. The tile resource name is prefixed by # Required. Resource name of the tile. The tile resource name is prefixed by its
# its collection ID `terraintiles/` followed by the resource ID, which # collection ID `terraintiles/` followed by the resource ID, which encodes the
# encodes the tile's global x and y coordinates and zoom level as # tile's global x and y coordinates and zoom level as `@,,z`. For example, `
# `@<x>,<y>,<zoom>z`. For example, `terraintiles/@1,2,3z`. # terraintiles/@1,2,3z`.
# @param [Fixnum] altitude_precision_centimeters # @param [Fixnum] altitude_precision_centimeters
# The precision of terrain altitudes in centimeters. # The precision of terrain altitudes in centimeters. Possible values: between 1 (
# Possible values: between 1 (cm level precision) and 1,000,000 (10-kilometer # cm level precision) and 1,000,000 (10-kilometer level precision).
# level precision).
# @param [String] client_info_api_client # @param [String] client_info_api_client
# API client name and version. For example, the SDK calling the API. The # API client name and version. For example, the SDK calling the API. The exact
# exact format is up to the client. # format is up to the client.
# @param [String] client_info_application_id # @param [String] client_info_application_id
# Application ID, such as the package name on Android and the bundle # Application ID, such as the package name on Android and the bundle identifier
# identifier on iOS platforms. # on iOS platforms.
# @param [String] client_info_application_version # @param [String] client_info_application_version
# Application version number, such as "1.2.3". The exact format is # Application version number, such as "1.2.3". The exact format is application-
# application-dependent. # dependent.
# @param [String] client_info_device_model # @param [String] client_info_device_model
# Device model as reported by the device. The exact format is # Device model as reported by the device. The exact format is platform-dependent.
# platform-dependent.
# @param [String] client_info_operating_system # @param [String] client_info_operating_system
# Operating system name and version as reported by the OS. For example, # Operating system name and version as reported by the OS. For example, "Mac OS
# "Mac OS X 10.10.4". The exact format is platform-dependent. # X 10.10.4". The exact format is platform-dependent.
# @param [String] client_info_platform # @param [String] client_info_platform
# Platform where the application is running. # Platform where the application is running.
# @param [String] client_info_user_id # @param [String] client_info_user_id
# A client-generated user ID. The ID should be generated and persisted during # Required. A client-generated user ID. The ID should be generated and persisted
# the first user session or whenever a pre-existing ID is not found. The # during the first user session or whenever a pre-existing ID is not found. The
# exact format is up to the client. This must be non-empty in a # exact format is up to the client. This must be non-empty in a
# GetFeatureTileRequest (whether via the header or # GetFeatureTileRequest (whether via the header or GetFeatureTileRequest.
# GetFeatureTileRequest.client_info). # client_info).
# @param [Fixnum] max_elevation_resolution_cells # @param [Fixnum] max_elevation_resolution_cells
# The maximum allowed resolution for the returned elevation heightmap. # The maximum allowed resolution for the returned elevation heightmap. Possible
# Possible values: between 1 and 1024 (and not less than # values: between 1 and 1024 (and not less than min_elevation_resolution_cells).
# min_elevation_resolution_cells). # Over-sized heightmaps will be non-uniformly down-sampled such that each edge
# Over-sized heightmaps will be non-uniformly down-sampled such that each # is no longer than this value. Non-uniformity is chosen to maximise the amount
# edge is no longer than this value. Non-uniformity is chosen to maximise the # of preserved data. For example: Original resolution: 100px (width) * 30px (
# amount of preserved data. # height) max_elevation_resolution: 30 New resolution: 30px (width) * 30px (
# For example: # height)
# Original resolution: 100px (width) * 30px (height)
# max_elevation_resolution: 30
# New resolution: 30px (width) * 30px (height)
# @param [Fixnum] min_elevation_resolution_cells # @param [Fixnum] min_elevation_resolution_cells
# The minimum allowed resolution for the returned elevation heightmap. # The minimum allowed resolution for the returned elevation heightmap. Possible
# Possible values: between 0 and 1024 (and not more than # values: between 0 and 1024 (and not more than max_elevation_resolution_cells).
# max_elevation_resolution_cells). Zero is supported for backward # Zero is supported for backward compatibility. Under-sized heightmaps will be
# compatibility. # non-uniformly up-sampled such that each edge is no shorter than this value.
# Under-sized heightmaps will be non-uniformly up-sampled # Non-uniformity is chosen to maximise the amount of preserved data. For example:
# such that each edge is no shorter than this value. Non-uniformity is chosen # Original resolution: 30px (width) * 10px (height) min_elevation_resolution:
# to maximise the amount of preserved data. # 30 New resolution: 30px (width) * 30px (height)
# For example:
# Original resolution: 30px (width) * 10px (height)
# min_elevation_resolution: 30
# New resolution: 30px (width) * 30px (height)
# @param [Array<String>, String] terrain_formats # @param [Array<String>, String] terrain_formats
# Terrain formats that the client understands. # Terrain formats that the client understands.
# @param [String] fields # @param [String] fields

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

@ -26,7 +26,7 @@ module Google
# @see https://devsite.googleplex.com/youtube/partner/docs/v1/ # @see https://devsite.googleplex.com/youtube/partner/docs/v1/
module YoutubePartnerV1 module YoutubePartnerV1
VERSION = 'V1' VERSION = 'V1'
REVISION = '20200803' REVISION = '20200807'
# View and manage your assets and associated content on YouTube # View and manage your assets and associated content on YouTube
AUTH_YOUTUBEPARTNER = 'https://www.googleapis.com/auth/youtubepartner' AUTH_YOUTUBEPARTNER = 'https://www.googleapis.com/auth/youtubepartner'