diff --git a/api_names_out.yaml b/api_names_out.yaml index 55d76317f..85a7dfd76 100644 --- a/api_names_out.yaml +++ b/api_names_out.yaml @@ -7687,6 +7687,7 @@ "/androidmanagement:v1/ApplicationPolicy": application_policy "/androidmanagement:v1/ApplicationPolicy/accessibleTrackIds": accessible_track_ids "/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/delegatedScopes": delegated_scopes "/androidmanagement:v1/ApplicationPolicy/delegatedScopes/delegated_scope": delegated_scope @@ -121150,6 +121151,7 @@ "/securitycenter:v1/GoogleCloudSecuritycenterV1p1beta1Finding/parent": parent "/securitycenter:v1/GoogleCloudSecuritycenterV1p1beta1Finding/resourceName": resource_name "/securitycenter:v1/GoogleCloudSecuritycenterV1p1beta1Finding/securityMarks": security_marks +"/securitycenter:v1/GoogleCloudSecuritycenterV1p1beta1Finding/severity": severity "/securitycenter:v1/GoogleCloudSecuritycenterV1p1beta1Finding/sourceProperties": source_properties "/securitycenter:v1/GoogleCloudSecuritycenterV1p1beta1Finding/sourceProperties/source_property": source_property "/securitycenter:v1/GoogleCloudSecuritycenterV1p1beta1Finding/state": state @@ -121507,6 +121509,7 @@ "/securitycenter:v1beta1/GoogleCloudSecuritycenterV1p1beta1Finding/parent": parent "/securitycenter:v1beta1/GoogleCloudSecuritycenterV1p1beta1Finding/resourceName": resource_name "/securitycenter:v1beta1/GoogleCloudSecuritycenterV1p1beta1Finding/securityMarks": security_marks +"/securitycenter:v1beta1/GoogleCloudSecuritycenterV1p1beta1Finding/severity": severity "/securitycenter:v1beta1/GoogleCloudSecuritycenterV1p1beta1Finding/sourceProperties": source_properties "/securitycenter:v1beta1/GoogleCloudSecuritycenterV1p1beta1Finding/sourceProperties/source_property": source_property "/securitycenter:v1beta1/GoogleCloudSecuritycenterV1p1beta1Finding/state": state @@ -121768,6 +121771,7 @@ "/securitycenter:v1p1alpha1/GoogleCloudSecuritycenterV1p1beta1Finding/parent": parent "/securitycenter:v1p1alpha1/GoogleCloudSecuritycenterV1p1beta1Finding/resourceName": resource_name "/securitycenter:v1p1alpha1/GoogleCloudSecuritycenterV1p1beta1Finding/securityMarks": security_marks +"/securitycenter:v1p1alpha1/GoogleCloudSecuritycenterV1p1beta1Finding/severity": severity "/securitycenter:v1p1alpha1/GoogleCloudSecuritycenterV1p1beta1Finding/sourceProperties": source_properties "/securitycenter:v1p1alpha1/GoogleCloudSecuritycenterV1p1beta1Finding/sourceProperties/source_property": source_property "/securitycenter:v1p1alpha1/GoogleCloudSecuritycenterV1p1beta1Finding/state": state @@ -121913,6 +121917,7 @@ "/securitycenter:v1p1beta1/GoogleCloudSecuritycenterV1p1beta1Finding/parent": parent "/securitycenter:v1p1beta1/GoogleCloudSecuritycenterV1p1beta1Finding/resourceName": resource_name "/securitycenter:v1p1beta1/GoogleCloudSecuritycenterV1p1beta1Finding/securityMarks": security_marks +"/securitycenter:v1p1beta1/GoogleCloudSecuritycenterV1p1beta1Finding/severity": severity "/securitycenter:v1p1beta1/GoogleCloudSecuritycenterV1p1beta1Finding/sourceProperties": source_properties "/securitycenter:v1p1beta1/GoogleCloudSecuritycenterV1p1beta1Finding/sourceProperties/source_property": source_property "/securitycenter:v1p1beta1/GoogleCloudSecuritycenterV1p1beta1Finding/state": state diff --git a/generated/google/apis/admin_directory_v1.rb b/generated/google/apis/admin_directory_v1.rb index 38038a6cd..3cdee34c0 100644 --- a/generated/google/apis/admin_directory_v1.rb +++ b/generated/google/apis/admin_directory_v1.rb @@ -18,15 +18,16 @@ require 'google/apis/admin_directory_v1/representations.rb' module Google module Apis - # Admin Directory API + # Admin SDK # - # Manages enterprise resources such as users and groups, administrative - # notifications, security features, and more. + # Admin SDK lets administrators of enterprise domains to view and manage + # 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 VERSION = 'DirectoryV1' - REVISION = '20200605' + REVISION = '20200810' # View and manage customer related information AUTH_ADMIN_DIRECTORY_CUSTOMER = 'https://www.googleapis.com/auth/admin.directory.customer' @@ -67,9 +68,6 @@ module Google # View groups on your domain 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 AUTH_ADMIN_DIRECTORY_ORGUNIT = 'https://www.googleapis.com/auth/admin.directory.orgunit' diff --git a/generated/google/apis/admin_directory_v1/classes.rb b/generated/google/apis/admin_directory_v1/classes.rb index 75deb6570..14aaf252d 100644 --- a/generated/google/apis/admin_directory_v1/classes.rb +++ b/generated/google/apis/admin_directory_v1/classes.rb @@ -26,27 +26,27 @@ module Google class Alias include Google::Apis::Core::Hashable - # A alias email + # # Corresponds to the JSON property `alias` # @return [String] attr_accessor :alias - # ETag of the resource. + # # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag - # Unique id of the group (Read-only) Unique id of the user (Read-only) + # # Corresponds to the JSON property `id` # @return [String] attr_accessor :id - # Kind of resource this is. + # # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # Group's primary email (Read-only) User's primary email (Read-only) + # # Corresponds to the JSON property `primaryEmail` # @return [String] attr_accessor :primary_email @@ -69,17 +69,17 @@ module Google class Aliases include Google::Apis::Core::Hashable - # List of alias objects. + # # Corresponds to the JSON property `aliases` # @return [Array] attr_accessor :aliases - # ETag of the resource. + # # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag - # Kind of resource this is. + # # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -96,7 +96,10 @@ module Google end end - # The template that returns individual ASP (Access Code) data. + # The template that returns individual ASP (Access Code) data. STEPLADDER: + # Generated unstable field number for field 'kind'. (See http://go/stepladder- + # help#fieldNumber) STEPLADDER: Generated unstable field number for field 'etag'. + # (See http://go/stepladder-help#fieldNumber) class Asp include Google::Apis::Core::Hashable @@ -152,7 +155,9 @@ module Google end end - # + # STEPLADDER: Generated unstable field number for field 'kind'. (See http://go/ + # stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for + # field 'etag'. (See http://go/stepladder-help#fieldNumber) class Asps include Google::Apis::Core::Hashable @@ -183,11 +188,11 @@ module Google end end - # JSON template for Building object in Directory API. + # Public API: Resources.buildings class Building include Google::Apis::Core::Hashable - # JSON template for the postal address of a building in Directory API. + # Public API: Resources.buildings # Corresponds to the JSON property `address` # @return [Google::Apis::AdminDirectoryV1::BuildingAddress] attr_accessor :address @@ -203,7 +208,7 @@ module Google # @return [String] attr_accessor :building_name - # JSON template for coordinates of a building in Directory API. + # Public API: Resources.buildings # Corresponds to the JSON property `coordinates` # @return [Google::Apis::AdminDirectoryV1::BuildingCoordinates] attr_accessor :coordinates @@ -247,7 +252,7 @@ module Google end end - # JSON template for the postal address of a building in Directory API. + # Public API: Resources.buildings class BuildingAddress include Google::Apis::Core::Hashable @@ -306,7 +311,7 @@ module Google end end - # JSON template for coordinates of a building in Directory API. + # Public API: Resources.buildings class BuildingCoordinates include Google::Apis::Core::Hashable @@ -331,7 +336,7 @@ module Google end end - # JSON template for Building List Response object in Directory API. + # Public API: Resources.buildings class Buildings include Google::Apis::Core::Hashable @@ -369,7 +374,7 @@ module Google end end - # JSON template for Calendar Resource object in Directory API. + # Public API: Resources.calendars class CalendarResource include Google::Apis::Core::Hashable @@ -388,7 +393,7 @@ module Google # @return [String] attr_accessor :etags - # + # Instances of features for the calendar resource. # Corresponds to the JSON property `featureInstances` # @return [Object] attr_accessor :feature_instances @@ -477,7 +482,7 @@ module Google end end - # JSON template for Calendar Resource List Response object in Directory API. + # Public API: Resources.calendars class CalendarResources include Google::Apis::Core::Hashable @@ -594,7 +599,9 @@ module Google end end - # JSON template for Chrome Os Device resource in Directory API. + # STEPLADDER: Generated unstable field number for field 'kind'. (See http://go/ + # stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for + # field 'etag'. (See http://go/stepladder-help#fieldNumber) class ChromeOsDevice include Google::Apis::Core::Hashable @@ -651,11 +658,9 @@ module Google # (Read-only) Built-in MAC address for the docking station that the device # connected to. Factory sets Media access control address (MAC address) assigned - # for use by a dock. Currently this is only supported on the Dell Arcada / - # Sarien devices and the Dell WD19 / WD19TB Docking Station. It is reserved - # specifically for MAC pass through device policy. The format is twelve (12) - # hexadecimal digits without any delimiter (uppercase letters). This is only - # relevant for Dell devices. + # for use by a dock. It is reserved specifically for MAC pass through device + # policy. The format is twelve (12) hexadecimal digits without any delimiter ( + # uppercase letters). This is only relevant for some devices. # Corresponds to the JSON property `dockMacAddress` # @return [String] attr_accessor :dock_mac_address @@ -693,7 +698,7 @@ module Google # @return [DateTime] attr_accessor :last_enrollment_time - # Contains last used network (Read-only) + # Contains last known network (Read-only) # Corresponds to the JSON property `lastKnownNetwork` # @return [Array] attr_accessor :last_known_network @@ -1004,16 +1009,16 @@ module Google end end - # + # Information for an ip address. class LastKnownNetwork include Google::Apis::Core::Hashable - # The IP address + # The IP address. # Corresponds to the JSON property `ipAddress` # @return [String] attr_accessor :ip_address - # The WAN IP address + # The WAN IP address. # Corresponds to the JSON property `wanIpAddress` # @return [String] attr_accessor :wan_ip_address @@ -1129,8 +1134,7 @@ module Google end end - # JSON request template for firing actions on ChromeOs Device in Directory - # Devices API. + # class ChromeOsDeviceAction include Google::Apis::Core::Hashable @@ -1155,7 +1159,9 @@ module Google end end - # JSON response template for List Chrome OS Devices operation in Directory API. + # STEPLADDER: Generated unstable field number for field 'kind'. (See http://go/ + # stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for + # field 'etag'. (See http://go/stepladder-help#fieldNumber) class ChromeOsDevices include Google::Apis::Core::Hashable @@ -1192,8 +1198,7 @@ module Google end end - # JSON request template for moving ChromeOs Device to given OU in Directory - # Devices API. + # class ChromeOsMoveDevicesToOu include Google::Apis::Core::Hashable @@ -1212,7 +1217,9 @@ module Google end end - # JSON template for Customer Resource object in Directory API. + # STEPLADDER: Generated unstable field number for field 'kind'. (See http://go/ + # stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for + # field 'etag'. (See http://go/stepladder-help#fieldNumber) class Customer include Google::Apis::Core::Hashable @@ -1258,7 +1265,10 @@ module Google # @return [String] attr_accessor :phone_number - # JSON template for postal address of a customer. + # STEPLADDER: Generated unstable field number for field 'address_line2' to avoid + # collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated + # unstable field number for field 'address_line3' to avoid collision. (See http:/ + # /go/stepladder-help#fieldNumber) # Corresponds to the JSON property `postalAddress` # @return [Google::Apis::AdminDirectoryV1::CustomerPostalAddress] attr_accessor :postal_address @@ -1281,7 +1291,10 @@ module Google end end - # JSON template for postal address of a customer. + # STEPLADDER: Generated unstable field number for field 'address_line2' to avoid + # collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated + # unstable field number for field 'address_line3' to avoid collision. (See http:/ + # /go/stepladder-help#fieldNumber) class CustomerPostalAddress include Google::Apis::Core::Hashable @@ -1324,7 +1337,7 @@ module Google attr_accessor :organization_name # The postal code. A postalCode example is a postal zip code such as 10009. This - # is in accordance with - http://portablecontacts.net/draft-spec.html# + # is in accordance with - http: //portablecontacts.net/draft-spec.html# # address_element. # Corresponds to the JSON property `postalCode` # @return [String] @@ -1354,7 +1367,7 @@ module Google end end - # JSON template for Domain Alias object in Directory API. + # class DomainAlias include Google::Apis::Core::Hashable @@ -1405,7 +1418,7 @@ module Google end end - # JSON response template to list domain aliases in Directory API. + # class DomainAliases include Google::Apis::Core::Hashable @@ -1436,7 +1449,7 @@ module Google end end - # JSON template for Domain object in Directory API. + # class Domains include Google::Apis::Core::Hashable @@ -1493,7 +1506,7 @@ module Google end end - # JSON response template to list Domains in Directory API. + # class Domains2 include Google::Apis::Core::Hashable @@ -1555,7 +1568,7 @@ module Google end end - # JSON template for a "feature instance". + # JSON template for a feature instance. class FeatureInstance include Google::Apis::Core::Hashable @@ -1574,7 +1587,7 @@ module Google end end - # JSON request template for renaming a feature. + # class FeatureRename include Google::Apis::Core::Hashable @@ -1593,7 +1606,7 @@ module Google end end - # JSON template for Feature List Response object in Directory API. + # Public API: Resources.features class Features include Google::Apis::Core::Hashable @@ -1631,7 +1644,9 @@ module Google end end - # JSON template for Group resource in Directory API. + # STEPLADDER: Generated unstable field number for field 'kind'. (See http://go/ + # stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for + # field 'etag'. (See http://go/stepladder-help#fieldNumber) class Group include Google::Apis::Core::Hashable @@ -1705,7 +1720,9 @@ module Google end end - # JSON response template for List Groups operation in Directory API. + # STEPLADDER: Generated unstable field number for field 'kind'. (See http://go/ + # stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for + # field 'etag'. (See http://go/stepladder-help#fieldNumber) class Groups include Google::Apis::Core::Hashable @@ -1742,7 +1759,7 @@ module Google end end - # JSON template for Member resource in Directory API. + # class Member include Google::Apis::Core::Hashable @@ -1761,9 +1778,9 @@ module Google # @return [String] attr_accessor :etag + # Unique identifier of group (Read-only) Unique identifier of member (Read-only) # The unique ID of the group member. A member id can be used as a member request - # URI's memberKey. Unique identifier of group (Read-only) Unique identifier of - # member (Read-only) + # URI's memberKey. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id @@ -1805,7 +1822,7 @@ module Google end end - # JSON response template for List Members operation in Directory API. + # class Members include Google::Apis::Core::Hashable @@ -1846,8 +1863,8 @@ module Google class MembersHasMember include Google::Apis::Core::Hashable - # Identifies whether the given user is a member of the group. Membership can be - # direct or nested. + # Output only. Identifies whether the given user is a member of the group. + # Membership can be direct or nested. # Corresponds to the JSON property `isMember` # @return [Boolean] attr_accessor :is_member @@ -1863,7 +1880,7 @@ module Google end end - # JSON template for Mobile Device resource in Directory API. + # class MobileDevice include Google::Apis::Core::Hashable @@ -2167,8 +2184,7 @@ module Google end end - # JSON request template for firing commands on Mobile Device in Directory - # Devices API. + # class MobileDeviceAction include Google::Apis::Core::Hashable @@ -2187,7 +2203,7 @@ module Google end end - # JSON response template for List Mobile Devices operation in Directory API. + # class MobileDevices include Google::Apis::Core::Hashable @@ -2224,112 +2240,10 @@ module Google end end - # Template for a notification resource. - class Notification - include Google::Apis::Core::Hashable - - # Body of the notification (Read-only) - # Corresponds to the JSON property `body` - # @return [String] - attr_accessor :body - - # ETag of the resource. - # Corresponds to the JSON property `etag` - # @return [String] - attr_accessor :etag - - # Address from which the notification is received (Read-only) - # Corresponds to the JSON property `fromAddress` - # @return [String] - attr_accessor :from_address - - # Boolean indicating whether the notification is unread or not. - # Corresponds to the JSON property `isUnread` - # @return [Boolean] - attr_accessor :is_unread - alias_method :is_unread?, :is_unread - - # The type of the resource. - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - # - # Corresponds to the JSON property `notificationId` - # @return [String] - attr_accessor :notification_id - - # Time at which notification was sent (Read-only) - # Corresponds to the JSON property `sendTime` - # @return [DateTime] - attr_accessor :send_time - - # Subject of the notification (Read-only) - # Corresponds to the JSON property `subject` - # @return [String] - attr_accessor :subject - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @body = args[:body] if args.key?(:body) - @etag = args[:etag] if args.key?(:etag) - @from_address = args[:from_address] if args.key?(:from_address) - @is_unread = args[:is_unread] if args.key?(:is_unread) - @kind = args[:kind] if args.key?(:kind) - @notification_id = args[:notification_id] if args.key?(:notification_id) - @send_time = args[:send_time] if args.key?(:send_time) - @subject = args[:subject] if args.key?(:subject) - end - end - - # Template for notifications list response. - class Notifications - include Google::Apis::Core::Hashable - - # ETag of the resource. - # Corresponds to the JSON property `etag` - # @return [String] - attr_accessor :etag - - # List of notifications in this page. - # Corresponds to the JSON property `items` - # @return [Array] - attr_accessor :items - - # The type of the resource. - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - # Token for fetching the next page of notifications. - # Corresponds to the JSON property `nextPageToken` - # @return [String] - attr_accessor :next_page_token - - # Number of unread notification for the domain. - # Corresponds to the JSON property `unreadNotificationsCount` - # @return [Fixnum] - attr_accessor :unread_notifications_count - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @etag = args[:etag] if args.key?(:etag) - @items = args[:items] if args.key?(:items) - @kind = args[:kind] if args.key?(:kind) - @next_page_token = args[:next_page_token] if args.key?(:next_page_token) - @unread_notifications_count = args[:unread_notifications_count] if args.key?(:unread_notifications_count) - end - end - - # JSON template for Org Unit resource in Directory API. + # JSON template for Org Unit resource in Directory API. STEPLADDER: Generated + # unstable field number for field 'kind'. (See http://go/stepladder-help# + # fieldNumber) STEPLADDER: Generated unstable field number for field 'etag'. ( + # See http://go/stepladder-help#fieldNumber) class OrgUnit include Google::Apis::Core::Hashable @@ -2398,6 +2312,9 @@ module Google end # JSON response template for List Organization Units operation in Directory API. + # STEPLADDER: Generated unstable field number for field 'kind'. (See http://go/ + # stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for + # field 'etag'. (See http://go/stepladder-help#fieldNumber) class OrgUnits include Google::Apis::Core::Hashable @@ -2428,7 +2345,7 @@ module Google end end - # JSON template for privilege resource in Directory API. + # class Privilege include Google::Apis::Core::Hashable @@ -2487,7 +2404,7 @@ module Google end end - # JSON response template for List privileges operation in Directory API. + # class Privileges include Google::Apis::Core::Hashable @@ -2518,7 +2435,7 @@ module Google end end - # JSON template for role resource in Directory API. + # class Role include Google::Apis::Core::Hashable @@ -2607,7 +2524,7 @@ module Google end end - # JSON template for roleAssignment resource in Directory API. + # class RoleAssignment include Google::Apis::Core::Hashable @@ -2642,9 +2559,8 @@ module Google # @return [Fixnum] attr_accessor :role_id - # The scope in which this role is assigned. Possible values are: - # - CUSTOMER - # - ORG_UNIT + # The scope in which this role is assigned. Possible values are: - CUSTOMER - + # ORG_UNIT # Corresponds to the JSON property `scopeType` # @return [String] attr_accessor :scope_type @@ -2665,7 +2581,7 @@ module Google end end - # JSON response template for List roleAssignments operation in Directory API. + # class RoleAssignments include Google::Apis::Core::Hashable @@ -2679,7 +2595,7 @@ module Google # @return [Array] attr_accessor :items - # The type of the API resource. This is always admin#directory#roleAssignments. + # The type of the API resource. This is always admin#directory#roleAssignments . # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -2702,7 +2618,7 @@ module Google end end - # JSON response template for List roles operation in Directory API. + # class Roles include Google::Apis::Core::Hashable @@ -2739,7 +2655,10 @@ module Google end end - # JSON template for Schema resource in Directory API. + # JSON template for Schema resource in Directory API. STEPLADDER: Generated + # unstable field number for field 'kind'. (See http://go/stepladder-help# + # fieldNumber) STEPLADDER: Generated unstable field number for field 'etag'. ( + # See http://go/stepladder-help#fieldNumber) class Schema include Google::Apis::Core::Hashable @@ -2788,7 +2707,10 @@ module Google end end - # JSON template for FieldSpec resource for Schemas in Directory API. + # JSON template for FieldSpec resource for Schemas in Directory API. STEPLADDER: + # Generated unstable field number for field 'kind'. (See http://go/stepladder- + # help#fieldNumber) STEPLADDER: Generated unstable field number for field 'etag'. + # (See http://go/stepladder-help#fieldNumber) class SchemaFieldSpec include Google::Apis::Core::Hashable @@ -2897,7 +2819,10 @@ module Google end end - # JSON response template for List Schema operation in Directory API. + # JSON response template for List Schema operation in Directory API. STEPLADDER: + # Generated unstable field number for field 'kind'. (See http://go/stepladder- + # help#fieldNumber) STEPLADDER: Generated unstable field number for field 'etag'. + # (See http://go/stepladder-help#fieldNumber) class Schemas include Google::Apis::Core::Hashable @@ -2928,7 +2853,10 @@ module Google end end - # JSON template for token resource in Directory API. + # JSON template for token resource in Directory API. STEPLADDER: Generated + # unstable field number for field 'kind'. (See http://go/stepladder-help# + # fieldNumber) STEPLADDER: Generated unstable field number for field 'etag'. ( + # See http://go/stepladder-help#fieldNumber) class Token include Google::Apis::Core::Hashable @@ -2993,7 +2921,10 @@ module Google end end - # JSON response template for List tokens operation in Directory API. + # JSON response template for List tokens operation in Directory API. STEPLADDER: + # Generated unstable field number for field 'kind'. (See http://go/stepladder- + # help#fieldNumber) STEPLADDER: Generated unstable field number for field 'etag'. + # (See http://go/stepladder-help#fieldNumber) class Tokens include Google::Apis::Core::Hashable @@ -3024,22 +2955,49 @@ module Google end end - # JSON template for User object in Directory API. + # STEPLADDER: Generated unstable field number for field 'kind'. (See http://go/ + # stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for + # field 'etag'. (See http://go/stepladder-help#fieldNumber) STEPLADDER: + # Generated unstable field number for field 'external_ids' to avoid collision. ( + # See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable + # field number for field 'relations' to avoid collision. (See http://go/ + # stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for + # field 'addresses' to avoid collision. (See http://go/stepladder-help# + # fieldNumber) STEPLADDER: Generated unstable field number for field ' + # organizations' to avoid collision. (See http://go/stepladder-help#fieldNumber) + # STEPLADDER: Generated unstable field number for field 'phones' to avoid + # collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated + # unstable field number for field 'languages' to avoid collision. (See http://go/ + # stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for + # field 'posix_accounts' to avoid collision. (See http://go/stepladder-help# + # fieldNumber) STEPLADDER: Generated unstable field number for field ' + # ssh_public_keys' to avoid collision. (See http://go/stepladder-help# + # fieldNumber) STEPLADDER: Generated unstable field number for field 'notes' to + # avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: + # Generated unstable field number for field 'websites' to avoid collision. (See + # http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field + # number for field 'locations' to avoid collision. (See http://go/stepladder- + # help#fieldNumber) STEPLADDER: Generated unstable field number for field ' + # keywords' to avoid collision. (See http://go/stepladder-help#fieldNumber) + # STEPLADDER: Generated unstable field number for field 'gender' to avoid + # collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated + # unstable field number for field 'thumbnail_photo_etag' to avoid collision. ( + # See http://go/stepladder-help#fieldNumber) class User include Google::Apis::Core::Hashable - # + # Addresses of User # Corresponds to the JSON property `addresses` # @return [Object] attr_accessor :addresses - # Indicates if user has agreed to terms (Read-only) + # Output only. Indicates if user has agreed to terms (Read-only) # Corresponds to the JSON property `agreedToTerms` # @return [Boolean] attr_accessor :agreed_to_terms alias_method :agreed_to_terms?, :agreed_to_terms - # List of aliases (Read-only) + # Output only. List of aliases (Read-only) # Corresponds to the JSON property `aliases` # @return [Array] attr_accessor :aliases @@ -3063,10 +3021,10 @@ module Google # Custom fields of the user. # Corresponds to the JSON property `customSchemas` - # @return [Hash>] + # @return [Hash] attr_accessor :custom_schemas - # CustomerId of User (Read-only) + # Output only. CustomerId of User (Read-only) # Corresponds to the JSON property `customerId` # @return [String] attr_accessor :customer_id @@ -3076,22 +3034,22 @@ module Google # @return [DateTime] attr_accessor :deletion_time - # + # Emails of User # Corresponds to the JSON property `emails` # @return [Object] attr_accessor :emails - # ETag of the resource. + # Output only. ETag of the resource. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag - # + # The external Ids of User * # Corresponds to the JSON property `externalIds` # @return [Object] attr_accessor :external_ids - # + # Gender of User # Corresponds to the JSON property `gender` # @return [Object] attr_accessor :gender @@ -3106,7 +3064,7 @@ module Google # @return [String] attr_accessor :id - # + # User's Instant Messenger # Corresponds to the JSON property `ims` # @return [Object] attr_accessor :ims @@ -3123,47 +3081,47 @@ module Google attr_accessor :ip_whitelisted alias_method :ip_whitelisted?, :ip_whitelisted - # Boolean indicating if the user is admin (Read-only) + # Output only. Boolean indicating if the user is admin (Read-only) # Corresponds to the JSON property `isAdmin` # @return [Boolean] attr_accessor :is_admin alias_method :is_admin?, :is_admin - # Boolean indicating if the user is delegated admin (Read-only) + # Output only. Boolean indicating if the user is delegated admin (Read-only) # Corresponds to the JSON property `isDelegatedAdmin` # @return [Boolean] attr_accessor :is_delegated_admin alias_method :is_delegated_admin?, :is_delegated_admin - # Is 2-step verification enforced (Read-only) + # Output only. Is 2-step verification enforced (Read-only) # Corresponds to the JSON property `isEnforcedIn2Sv` # @return [Boolean] attr_accessor :is_enforced_in2_sv alias_method :is_enforced_in2_sv?, :is_enforced_in2_sv - # Is enrolled in 2-step verification (Read-only) + # Output only. Is enrolled in 2-step verification (Read-only) # Corresponds to the JSON property `isEnrolledIn2Sv` # @return [Boolean] attr_accessor :is_enrolled_in2_sv alias_method :is_enrolled_in2_sv?, :is_enrolled_in2_sv - # Is mailbox setup (Read-only) + # Output only. Is mailbox setup (Read-only) # Corresponds to the JSON property `isMailboxSetup` # @return [Boolean] attr_accessor :is_mailbox_setup alias_method :is_mailbox_setup?, :is_mailbox_setup - # + # Keywords of User # Corresponds to the JSON property `keywords` # @return [Object] attr_accessor :keywords - # Kind of resource this is. + # Output only. Kind of resource this is. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # + # Languages of User # Corresponds to the JSON property `languages` # @return [Object] attr_accessor :languages @@ -3173,22 +3131,22 @@ module Google # @return [DateTime] attr_accessor :last_login_time - # + # Locations of User # Corresponds to the JSON property `locations` # @return [Object] attr_accessor :locations - # JSON template for name of a user in Directory API. + # User's name # Corresponds to the JSON property `name` # @return [Google::Apis::AdminDirectoryV1::UserName] attr_accessor :name - # List of non editable aliases (Read-only) + # Output only. List of non editable aliases (Read-only) # Corresponds to the JSON property `nonEditableAliases` # @return [Array] attr_accessor :non_editable_aliases - # + # Notes of User # Corresponds to the JSON property `notes` # @return [Object] attr_accessor :notes @@ -3198,7 +3156,7 @@ module Google # @return [String] attr_accessor :org_unit_path - # + # Organizations of User # Corresponds to the JSON property `organizations` # @return [Object] attr_accessor :organizations @@ -3208,12 +3166,12 @@ module Google # @return [String] attr_accessor :password - # + # Phone numbers of User # Corresponds to the JSON property `phones` # @return [Object] attr_accessor :phones - # + # The POSIX accounts of User # Corresponds to the JSON property `posixAccounts` # @return [Object] attr_accessor :posix_accounts @@ -3229,17 +3187,17 @@ module Google attr_accessor :recovery_email # Recovery phone of the user. The phone number must be in the E.164 format, - # starting with the plus sign (+). Example: +16506661212. + # starting with the plus sign (+). Example: *+16506661212*. # Corresponds to the JSON property `recoveryPhone` # @return [String] attr_accessor :recovery_phone - # + # The Relations of User * # Corresponds to the JSON property `relations` # @return [Object] attr_accessor :relations - # + # The SSH public keys of User # Corresponds to the JSON property `sshPublicKeys` # @return [Object] attr_accessor :ssh_public_keys @@ -3250,22 +3208,22 @@ module Google attr_accessor :suspended alias_method :suspended?, :suspended - # Suspension reason if user is suspended (Read-only) + # Output only. Suspension reason if user is suspended (Read-only) # Corresponds to the JSON property `suspensionReason` # @return [String] attr_accessor :suspension_reason - # ETag of the user's photo (Read-only) + # Output only. ETag of the user's photo (Read-only) # Corresponds to the JSON property `thumbnailPhotoEtag` # @return [String] attr_accessor :thumbnail_photo_etag - # Photo Url of the user (Read-only) + # Output only. Photo Url of the user (Read-only) # Corresponds to the JSON property `thumbnailPhotoUrl` # @return [String] attr_accessor :thumbnail_photo_url - # + # Websites of User # Corresponds to the JSON property `websites` # @return [Object] attr_accessor :websites @@ -3407,7 +3365,7 @@ module Google attr_accessor :region # User supplied address was structured. Structured addresses are NOT supported - # at this time. You might be able to write structured addresses, but any values + # at this time. You might be able to write structured addresses but any values # will eventually be clobbered. # Corresponds to the JSON property `sourceIsStructured` # @return [Boolean] @@ -3420,9 +3378,9 @@ module Google attr_accessor :street_address # Each entry can have a type which indicates standard values of that entry. For - # example address could be of home, work etc. In addition to the standard type, - # an entry can have a custom type and can take any value. Such type should have - # the CUSTOM value as type and also have a customType value. + # example address could be of home work etc. In addition to the standard type an + # entry can have a custom type and can take any value. Such type should have the + # CUSTOM value as type and also have a customType value. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type @@ -3449,6 +3407,20 @@ module Google end end + # JSON template for a set of custom properties (i.e. all fields in a particular + # schema) + class UserCustomProperties + include Google::Apis::Core::Hashable + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + end + end + # JSON template for an email. class UserEmail include Google::Apis::Core::Hashable @@ -3526,7 +3498,7 @@ module Google include Google::Apis::Core::Hashable # AddressMeAs. A human-readable string containing the proper way to refer to the - # profile owner by humans, for example "he/him/his" or "they/them/their". + # profile owner by humans for example he/him/his or they/them/their. # Corresponds to the JSON property `addressMeAs` # @return [String] attr_accessor :address_me_as @@ -3579,15 +3551,15 @@ module Google alias_method :primary?, :primary # Protocol used in the instant messenger. It should be one of the values from - # ImProtocolTypes map. Similar to type, it can take a CUSTOM value and specify + # ImProtocolTypes map. Similar to type it can take a CUSTOM value and specify # the custom name in customProtocol field. # Corresponds to the JSON property `protocol` # @return [String] attr_accessor :protocol # Each entry can have a type which indicates standard types of that entry. For - # example instant messengers could be of home, work etc. In addition to the - # standard type, an entry can have a custom type and can take any value. Such + # example instant messengers could be of home work etc. In addition to the + # standard type an entry can have a custom type and can take any value. Such # types should have the CUSTOM value as type and also have a customType value. # Corresponds to the JSON property `type` # @return [String] @@ -3618,8 +3590,8 @@ module Google attr_accessor :custom_type # Each entry can have a type which indicates standard type of that entry. For - # example, keyword could be of type occupation or outlook. In addition to the - # standard type, an entry can have a custom type and can give it any name. Such + # example keyword could be of type occupation or outlook. In addition to the + # standard type an entry can have a custom type and can give it any name. Such # types should have the CUSTOM value as type and also have a customType value. # Corresponds to the JSON property `type` # @return [String] @@ -3675,8 +3647,8 @@ module Google include Google::Apis::Core::Hashable # Textual location. This is most useful for display purposes to concisely - # describe the location. For example, "Mountain View, CA", "Near Seattle", "US- - # NYC-9TH 9A209A". + # describe the location. For example 'Mountain View, CA', 'Near Seattle', 'US- + # NYC-9TH 9A209A.'' # Corresponds to the JSON property `area` # @return [String] attr_accessor :area @@ -3701,17 +3673,17 @@ module Google # @return [String] attr_accessor :floor_name - # Floor section. More specific location within the floor. For example, if a - # floor is divided into sections "A", "B", and "C", this field would identify - # one of those values. + # Floor section. More specific location within the floor. For example if a floor + # is divided into sections 'A', 'B' and 'C' this field would identify one of + # those values. # Corresponds to the JSON property `floorSection` # @return [String] attr_accessor :floor_section # Each entry can have a type which indicates standard types of that entry. For # example location could be of types default and desk. In addition to standard - # type, an entry can have a custom type and can give it any name. Such types - # should have "custom" as type and also have a customType value. + # type an entry can have a custom type and can give it any name. Such types + # should have 'custom' as type and also have a customType value. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type @@ -3732,8 +3704,7 @@ module Google end end - # JSON request template for setting/revoking admin status of a user in Directory - # API. + # class UserMakeAdmin include Google::Apis::Core::Hashable @@ -3753,7 +3724,7 @@ module Google end end - # JSON template for name of a user in Directory API. + # class UserName include Google::Apis::Core::Hashable @@ -3845,8 +3816,8 @@ module Google attr_accessor :title # Each entry can have a type which indicates standard types of that entry. For - # example organization could be of school, work etc. In addition to the standard - # type, an entry can have a custom type and can give it any name. Such types + # example organization could be of school work etc. In addition to the standard + # type an entry can have a custom type and can give it any name. Such types # should have the CUSTOM value as type and also have a CustomType value. # Corresponds to the JSON property `type` # @return [String] @@ -3889,8 +3860,8 @@ module Google alias_method :primary?, :primary # Each entry can have a type which indicates standard types of that entry. For - # example phone could be of home_fax, work, mobile etc. In addition to the - # standard type, an entry can have a custom type and can give it any name. Such + # example phone could be of home_fax work mobile etc. In addition to the + # standard type an entry can have a custom type and can give it any name. Such # types should have the CUSTOM value as type and also have a customType value. # Corresponds to the JSON property `type` # @return [String] @@ -3914,7 +3885,9 @@ module Google end end - # JSON template for Photo object in Directory API. + # STEPLADDER: Generated unstable field number for field 'kind'. (See http://go/ + # stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for + # field 'etag'. (See http://go/stepladder-help#fieldNumber) class UserPhoto include Google::Apis::Core::Hashable @@ -4060,8 +4033,8 @@ module Google # @return [String] attr_accessor :custom_type - # The relation of the user. Some of the possible values are mother, father, - # sister, brother, manager, assistant, partner. + # The relation of the user. Some of the possible values are mother father sister + # brother manager assistant partner. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type @@ -4114,7 +4087,7 @@ module Google end end - # JSON request template to undelete a user in Directory API. + # class UserUndelete include Google::Apis::Core::Hashable @@ -4149,8 +4122,8 @@ module Google alias_method :primary?, :primary # Each entry can have a type which indicates standard types of that entry. For - # example website could be of home, work, blog etc. In addition to the standard - # type, an entry can have a custom type and can give it any name. Such types + # example website could be of home work blog etc. In addition to the standard + # type an entry can have a custom type and can give it any name. Such types # should have the CUSTOM value as type and also have a customType value. # Corresponds to the JSON property `type` # @return [String] @@ -4174,7 +4147,9 @@ module Google end end - # JSON response template for List Users operation in Apps Directory API. + # STEPLADDER: Generated unstable field number for field 'kind'. (See http://go/ + # stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for + # field 'etag'. (See http://go/stepladder-help#fieldNumber) class Users include Google::Apis::Core::Hashable @@ -4217,7 +4192,10 @@ module Google end end - # JSON template for verification codes in Directory API. + # JSON template for verification codes in Directory API. STEPLADDER: Generated + # unstable field number for field 'kind'. (See http://go/stepladder-help# + # fieldNumber) STEPLADDER: Generated unstable field number for field 'etag'. ( + # See http://go/stepladder-help#fieldNumber) class VerificationCode include Google::Apis::Core::Hashable @@ -4256,6 +4234,9 @@ module Google end # JSON response template for List verification codes operation in Directory API. + # STEPLADDER: Generated unstable field number for field 'kind'. (See http://go/ + # stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for + # field 'etag'. (See http://go/stepladder-help#fieldNumber) class VerificationCodes include Google::Apis::Core::Hashable diff --git a/generated/google/apis/admin_directory_v1/representations.rb b/generated/google/apis/admin_directory_v1/representations.rb index 88e8bc196..7633af91f 100644 --- a/generated/google/apis/admin_directory_v1/representations.rb +++ b/generated/google/apis/admin_directory_v1/representations.rb @@ -286,18 +286,6 @@ module Google include Google::Apis::Core::JsonObjectSupport end - class Notification - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class Notifications - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - class OrgUnit class Representation < Google::Apis::Core::JsonRepresentation; end @@ -406,6 +394,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class UserCustomProperties + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class UserEmail class Representation < Google::Apis::Core::JsonRepresentation; end @@ -1087,33 +1081,6 @@ module Google 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 # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -1303,7 +1270,8 @@ module Google property :change_password_at_next_login, as: 'changePasswordAtNextLogin' 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 :deletion_time, as: 'deletionTime', type: DateTime @@ -1376,6 +1344,12 @@ module Google end end + class UserCustomProperties + # @private + class Representation < Google::Apis::Core::JsonRepresentation + end + end + class UserEmail # @private class Representation < Google::Apis::Core::JsonRepresentation diff --git a/generated/google/apis/admin_directory_v1/service.rb b/generated/google/apis/admin_directory_v1/service.rb index 788778d88..2fabc82e0 100644 --- a/generated/google/apis/admin_directory_v1/service.rb +++ b/generated/google/apis/admin_directory_v1/service.rb @@ -20,10 +20,11 @@ require 'google/apis/errors' module Google module Apis module AdminDirectoryV1 - # Admin Directory API + # Admin SDK # - # Manages enterprise resources such as users and groups, administrative - # notifications, security features, and more. + # Admin SDK lets administrators of enterprise domains to view and manage + # resources like user, groups etc. It also provides audit and usage reports of + # domain. # # @example # require 'google/apis/admin_directory_v1' @@ -31,7 +32,7 @@ module Google # Admin = Google::Apis::AdminDirectoryV1 # Alias the module # service = Admin::DirectoryService.new # - # @see https://developers.google.com/admin-sdk/directory/ + # @see http://developers.google.com/admin-sdk/ class DirectoryService < Google::Apis::Core::BaseService # @return [String] # API key. Your API key identifies your project and provides you with API access, @@ -39,16 +40,12 @@ module Google attr_accessor :key # @return [String] - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. attr_accessor :quota_user - # @return [String] - # Deprecated. Please use quotaUser instead. - attr_accessor :user_ip - def initialize - super('https://www.googleapis.com/', 'admin/directory/v1/') + super('https://www.googleapis.com/', '') @batch_path = 'batch/admin/directory_v1' end @@ -61,10 +58,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -77,13 +72,12 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def delete_asp(user_key, code_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:delete, 'users/{userKey}/asps/{codeId}', options) + def delete_asp(user_key, code_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'admin/directory/v1/users/{userKey}/asps/{codeId}', options) command.params['userKey'] = user_key unless user_key.nil? command.params['codeId'] = code_id unless code_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -96,10 +90,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -112,15 +104,14 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_asp(user_key, code_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'users/{userKey}/asps/{codeId}', options) + def get_asp(user_key, code_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'admin/directory/v1/users/{userKey}/asps/{codeId}', options) command.response_representation = Google::Apis::AdminDirectoryV1::Asp::Representation command.response_class = Google::Apis::AdminDirectoryV1::Asp command.params['userKey'] = user_key unless user_key.nil? command.params['codeId'] = code_id unless code_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -131,10 +122,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -147,26 +136,23 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_asps(user_key, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'users/{userKey}/asps', options) + def list_asps(user_key, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'admin/directory/v1/users/{userKey}/asps', options) command.response_representation = Google::Apis::AdminDirectoryV1::Asps::Representation command.response_class = Google::Apis::AdminDirectoryV1::Asps command.params['userKey'] = user_key unless user_key.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Stop watching resources through this channel + # Stop watching resources through this channel. # @param [Google::Apis::AdminDirectoryV1::Channel] channel_object # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -179,13 +165,12 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def stop_channel(channel_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, '/admin/directory_v1/channels/stop', options) + def stop_channel(channel_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'admin/directory_v1/channels/stop', options) command.request_representation = Google::Apis::AdminDirectoryV1::Channel::Representation command.request_object = channel_object command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -198,10 +183,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -214,15 +197,14 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def action_chromeosdevice(customer_id, resource_id, chrome_os_device_action_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'customer/{customerId}/devices/chromeos/{resourceId}/action', options) + def action_chromeosdevice(customer_id, resource_id, chrome_os_device_action_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'admin/directory/v1/customer/{customerId}/devices/chromeos/{resourceId}/action', options) command.request_representation = Google::Apis::AdminDirectoryV1::ChromeOsDeviceAction::Representation command.request_object = chrome_os_device_action_object command.params['customerId'] = customer_id unless customer_id.nil? command.params['resourceId'] = resource_id unless resource_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -236,10 +218,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -252,8 +232,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_chrome_os_device(customer_id, device_id, projection: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'customer/{customerId}/devices/chromeos/{deviceId}', options) + def get_chrome_os_device(customer_id, device_id, projection: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'admin/directory/v1/customer/{customerId}/devices/chromeos/{deviceId}', options) command.response_representation = Google::Apis::AdminDirectoryV1::ChromeOsDevice::Representation command.response_class = Google::Apis::AdminDirectoryV1::ChromeOsDevice command.params['customerId'] = customer_id unless customer_id.nil? @@ -261,7 +241,6 @@ module Google command.query['projection'] = projection unless projection.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -269,7 +248,7 @@ module Google # @param [String] customer_id # Immutable ID of the G Suite account # @param [Fixnum] max_results - # Maximum number of results to return. Max allowed value is 200. + # Maximum number of results to return. # @param [String] order_by # Column to use for sorting results # @param [String] org_unit_path @@ -279,17 +258,16 @@ module Google # @param [String] projection # Restrict information returned to a set of selected fields. # @param [String] query - # Search string in the format provided by this Help Center article. + # Search string in the format given at http://support.google.com/chromeos/a/bin/ + # answer.py?answer=1698333 # @param [String] sort_order # Whether to return results in ascending or descending order. Only of use when # orderBy is also used # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -302,8 +280,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_chrome_os_devices(customer_id, max_results: nil, order_by: nil, org_unit_path: nil, page_token: nil, projection: nil, query: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'customer/{customerId}/devices/chromeos', options) + def list_chrome_os_devices(customer_id, max_results: nil, order_by: nil, org_unit_path: nil, page_token: nil, projection: nil, query: nil, sort_order: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'admin/directory/v1/customer/{customerId}/devices/chromeos', options) command.response_representation = Google::Apis::AdminDirectoryV1::ChromeOsDevices::Representation command.response_class = Google::Apis::AdminDirectoryV1::ChromeOsDevices command.params['customerId'] = customer_id unless customer_id.nil? @@ -316,7 +294,6 @@ module Google command.query['sortOrder'] = sort_order unless sort_order.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -329,10 +306,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -345,19 +320,18 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def move_chromeosdevice_devices_to_ou(customer_id, org_unit_path, chrome_os_move_devices_to_ou_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'customer/{customerId}/devices/chromeos/moveDevicesToOu', options) + def move_chromeosdevice_devices_to_ou(customer_id, org_unit_path, chrome_os_move_devices_to_ou_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'admin/directory/v1/customer/{customerId}/devices/chromeos/moveDevicesToOu', options) command.request_representation = Google::Apis::AdminDirectoryV1::ChromeOsMoveDevicesToOu::Representation command.request_object = chrome_os_move_devices_to_ou_object command.params['customerId'] = customer_id unless customer_id.nil? command.query['orgUnitPath'] = org_unit_path unless org_unit_path.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Update Chrome OS Device. This method supports patch semantics. + # Patch Chrome OS Device # @param [String] customer_id # Immutable ID of the G Suite account # @param [String] device_id @@ -368,10 +342,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -384,8 +356,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def patch_chrome_os_device(customer_id, device_id, chrome_os_device_object = nil, projection: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:patch, 'customer/{customerId}/devices/chromeos/{deviceId}', options) + def patch_chrome_os_device(customer_id, device_id, chrome_os_device_object = nil, projection: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:patch, 'admin/directory/v1/customer/{customerId}/devices/chromeos/{deviceId}', options) command.request_representation = Google::Apis::AdminDirectoryV1::ChromeOsDevice::Representation command.request_object = chrome_os_device_object command.response_representation = Google::Apis::AdminDirectoryV1::ChromeOsDevice::Representation @@ -395,7 +367,6 @@ module Google command.query['projection'] = projection unless projection.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -410,10 +381,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -426,8 +395,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def update_chrome_os_device(customer_id, device_id, chrome_os_device_object = nil, projection: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:put, 'customer/{customerId}/devices/chromeos/{deviceId}', options) + def update_chrome_os_device(customer_id, device_id, chrome_os_device_object = nil, projection: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:put, 'admin/directory/v1/customer/{customerId}/devices/chromeos/{deviceId}', options) command.request_representation = Google::Apis::AdminDirectoryV1::ChromeOsDevice::Representation command.request_object = chrome_os_device_object command.response_representation = Google::Apis::AdminDirectoryV1::ChromeOsDevice::Representation @@ -437,7 +406,6 @@ module Google command.query['projection'] = projection unless projection.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -447,10 +415,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -463,28 +429,25 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_customer(customer_key, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'customers/{customerKey}', options) + def get_customer(customer_key, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'admin/directory/v1/customers/{customerKey}', options) command.response_representation = Google::Apis::AdminDirectoryV1::Customer::Representation command.response_class = Google::Apis::AdminDirectoryV1::Customer command.params['customerKey'] = customer_key unless customer_key.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Updates a customer. This method supports patch semantics. + # Patch Customers via Apiary Patch Orchestration # @param [String] customer_key # Id of the customer to be updated # @param [Google::Apis::AdminDirectoryV1::Customer] customer_object # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -497,8 +460,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def patch_customer(customer_key, customer_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:patch, 'customers/{customerKey}', options) + def patch_customer(customer_key, customer_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:patch, 'admin/directory/v1/customers/{customerKey}', options) command.request_representation = Google::Apis::AdminDirectoryV1::Customer::Representation command.request_object = customer_object command.response_representation = Google::Apis::AdminDirectoryV1::Customer::Representation @@ -506,7 +469,6 @@ module Google command.params['customerKey'] = customer_key unless customer_key.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -517,10 +479,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -533,8 +493,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def update_customer(customer_key, customer_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:put, 'customers/{customerKey}', options) + def update_customer(customer_key, customer_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:put, 'admin/directory/v1/customers/{customerKey}', options) command.request_representation = Google::Apis::AdminDirectoryV1::Customer::Representation command.request_object = customer_object command.response_representation = Google::Apis::AdminDirectoryV1::Customer::Representation @@ -542,11 +502,10 @@ module Google command.params['customerKey'] = customer_key unless customer_key.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Deletes a Domain Alias of the customer. + # Deletes a domain Alias of the customer. # @param [String] customer # Immutable ID of the G Suite account. # @param [String] domain_alias_name @@ -554,10 +513,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -570,13 +527,12 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def delete_domain_alias(customer, domain_alias_name, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:delete, 'customer/{customer}/domainaliases/{domainAliasName}', options) + def delete_domain_alias(customer, domain_alias_name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'admin/directory/v1/customer/{customer}/domainaliases/{domainAliasName}', options) command.params['customer'] = customer unless customer.nil? command.params['domainAliasName'] = domain_alias_name unless domain_alias_name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -588,10 +544,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -604,29 +558,26 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_domain_alias(customer, domain_alias_name, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'customer/{customer}/domainaliases/{domainAliasName}', options) + def get_domain_alias(customer, domain_alias_name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'admin/directory/v1/customer/{customer}/domainaliases/{domainAliasName}', options) command.response_representation = Google::Apis::AdminDirectoryV1::DomainAlias::Representation command.response_class = Google::Apis::AdminDirectoryV1::DomainAlias command.params['customer'] = customer unless customer.nil? command.params['domainAliasName'] = domain_alias_name unless domain_alias_name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Inserts a Domain alias of the customer. + # Inserts a domain alias of the customer. # @param [String] customer # Immutable ID of the G Suite account. # @param [Google::Apis::AdminDirectoryV1::DomainAlias] domain_alias_object # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -639,8 +590,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def insert_domain_alias(customer, domain_alias_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'customer/{customer}/domainaliases', options) + def insert_domain_alias(customer, domain_alias_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'admin/directory/v1/customer/{customer}/domainaliases', options) command.request_representation = Google::Apis::AdminDirectoryV1::DomainAlias::Representation command.request_object = domain_alias_object command.response_representation = Google::Apis::AdminDirectoryV1::DomainAlias::Representation @@ -648,7 +599,6 @@ module Google command.params['customer'] = customer unless customer.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -660,10 +610,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -676,15 +624,14 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_domain_aliases(customer, parent_domain_name: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'customer/{customer}/domainaliases', options) + def list_domain_aliases(customer, parent_domain_name: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'admin/directory/v1/customer/{customer}/domainaliases', options) command.response_representation = Google::Apis::AdminDirectoryV1::DomainAliases::Representation command.response_class = Google::Apis::AdminDirectoryV1::DomainAliases command.params['customer'] = customer unless customer.nil? command.query['parentDomainName'] = parent_domain_name unless parent_domain_name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -696,10 +643,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -712,13 +657,12 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def delete_domain(customer, domain_name, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:delete, 'customer/{customer}/domains/{domainName}', options) + def delete_domain(customer, domain_name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'admin/directory/v1/customer/{customer}/domains/{domainName}', options) command.params['customer'] = customer unless customer.nil? command.params['domainName'] = domain_name unless domain_name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -730,10 +674,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -746,15 +688,14 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_domain(customer, domain_name, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'customer/{customer}/domains/{domainName}', options) + def get_domain(customer, domain_name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'admin/directory/v1/customer/{customer}/domains/{domainName}', options) command.response_representation = Google::Apis::AdminDirectoryV1::Domains::Representation command.response_class = Google::Apis::AdminDirectoryV1::Domains command.params['customer'] = customer unless customer.nil? command.params['domainName'] = domain_name unless domain_name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -765,10 +706,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -781,8 +720,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def insert_domain(customer, domains_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'customer/{customer}/domains', options) + def insert_domain(customer, domains_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'admin/directory/v1/customer/{customer}/domains', options) command.request_representation = Google::Apis::AdminDirectoryV1::Domains::Representation command.request_object = domains_object command.response_representation = Google::Apis::AdminDirectoryV1::Domains::Representation @@ -790,7 +729,6 @@ module Google command.params['customer'] = customer unless customer.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -800,10 +738,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -816,14 +752,13 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_domains(customer, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'customer/{customer}/domains', options) + def list_domains(customer, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'admin/directory/v1/customer/{customer}/domains', options) command.response_representation = Google::Apis::AdminDirectoryV1::Domains2::Representation command.response_class = Google::Apis::AdminDirectoryV1::Domains2 command.params['customer'] = customer unless customer.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -833,10 +768,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -849,12 +782,11 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def delete_group(group_key, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:delete, 'groups/{groupKey}', options) + def delete_group(group_key, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'admin/directory/v1/groups/{groupKey}', options) command.params['groupKey'] = group_key unless group_key.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -864,10 +796,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -880,14 +810,13 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_group(group_key, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'groups/{groupKey}', options) + def get_group(group_key, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'admin/directory/v1/groups/{groupKey}', options) command.response_representation = Google::Apis::AdminDirectoryV1::Group::Representation command.response_class = Google::Apis::AdminDirectoryV1::Group command.params['groupKey'] = group_key unless group_key.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -896,10 +825,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -912,15 +839,14 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def insert_group(group_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'groups', options) + def insert_group(group_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'admin/directory/v1/groups', options) command.request_representation = Google::Apis::AdminDirectoryV1::Group::Representation command.request_object = group_object command.response_representation = Google::Apis::AdminDirectoryV1::Group::Representation command.response_class = Google::Apis::AdminDirectoryV1::Group command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -939,7 +865,7 @@ module Google # Token to specify next page in the list # @param [String] query # Query string search. Should be of the form "". Complete documentation is at - # https://developers.google.com/admin-sdk/directory/v1/guides/search-groups + # https: //developers.google.com/admin-sdk/directory/v1/guides/search-groups # @param [String] sort_order # Whether to return results in ascending or descending order. Only of use when # orderBy is also used @@ -950,10 +876,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -966,8 +890,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_groups(customer: nil, domain: nil, max_results: nil, order_by: nil, page_token: nil, query: nil, sort_order: nil, user_key: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'groups', options) + def list_groups(customer: nil, domain: nil, max_results: nil, order_by: nil, page_token: nil, query: nil, sort_order: nil, user_key: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'admin/directory/v1/groups', options) command.response_representation = Google::Apis::AdminDirectoryV1::Groups::Representation command.response_class = Google::Apis::AdminDirectoryV1::Groups command.query['customer'] = customer unless customer.nil? @@ -980,11 +904,10 @@ module Google command.query['userKey'] = user_key unless user_key.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Update Group. This method supports patch semantics. + # Patch Groups via Apiary Patch Orchestration # @param [String] group_key # Email or immutable ID of the group. If ID, it should match with id of group # object @@ -992,10 +915,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -1008,8 +929,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def patch_group(group_key, group_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:patch, 'groups/{groupKey}', options) + def patch_group(group_key, group_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:patch, 'admin/directory/v1/groups/{groupKey}', options) command.request_representation = Google::Apis::AdminDirectoryV1::Group::Representation command.request_object = group_object command.response_representation = Google::Apis::AdminDirectoryV1::Group::Representation @@ -1017,7 +938,6 @@ module Google command.params['groupKey'] = group_key unless group_key.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -1029,10 +949,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -1045,8 +963,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def update_group(group_key, group_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:put, 'groups/{groupKey}', options) + def update_group(group_key, group_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:put, 'admin/directory/v1/groups/{groupKey}', options) command.request_representation = Google::Apis::AdminDirectoryV1::Group::Representation command.request_object = group_object command.response_representation = Google::Apis::AdminDirectoryV1::Group::Representation @@ -1054,7 +972,6 @@ module Google command.params['groupKey'] = group_key unless group_key.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -1066,10 +983,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -1082,13 +997,12 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def delete_group_alias(group_key, group_alias, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:delete, 'groups/{groupKey}/aliases/{alias}', options) + def delete_group_alias(group_key, group_alias, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'admin/directory/v1/groups/{groupKey}/aliases/{alias}', options) command.params['groupKey'] = group_key unless group_key.nil? command.params['alias'] = group_alias unless group_alias.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -1099,10 +1013,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -1115,8 +1027,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def insert_group_alias(group_key, alias_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'groups/{groupKey}/aliases', options) + def insert_group_alias(group_key, alias_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'admin/directory/v1/groups/{groupKey}/aliases', options) command.request_representation = Google::Apis::AdminDirectoryV1::Alias::Representation command.request_object = alias_object command.response_representation = Google::Apis::AdminDirectoryV1::Alias::Representation @@ -1124,7 +1036,6 @@ module Google command.params['groupKey'] = group_key unless group_key.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -1134,10 +1045,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -1150,14 +1059,13 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_group_aliases(group_key, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'groups/{groupKey}/aliases', options) + def list_group_aliases(group_key, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'admin/directory/v1/groups/{groupKey}/aliases', options) command.response_representation = Google::Apis::AdminDirectoryV1::Aliases::Representation command.response_class = Google::Apis::AdminDirectoryV1::Aliases command.params['groupKey'] = group_key unless group_key.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -1169,10 +1077,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -1185,13 +1091,12 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def delete_member(group_key, member_key, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:delete, 'groups/{groupKey}/members/{memberKey}', options) + def delete_member(group_key, member_key, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'admin/directory/v1/groups/{groupKey}/members/{memberKey}', options) command.params['groupKey'] = group_key unless group_key.nil? command.params['memberKey'] = member_key unless member_key.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -1203,10 +1108,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -1219,15 +1122,14 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_member(group_key, member_key, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'groups/{groupKey}/members/{memberKey}', options) + def get_member(group_key, member_key, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'admin/directory/v1/groups/{groupKey}/members/{memberKey}', options) command.response_representation = Google::Apis::AdminDirectoryV1::Member::Representation command.response_class = Google::Apis::AdminDirectoryV1::Member command.params['groupKey'] = group_key unless group_key.nil? command.params['memberKey'] = member_key unless member_key.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -1242,10 +1144,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -1258,15 +1158,14 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def has_member_member(group_key, member_key, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'groups/{groupKey}/hasMember/{memberKey}', options) + def has_member_member(group_key, member_key, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'admin/directory/v1/groups/{groupKey}/hasMember/{memberKey}', options) command.response_representation = Google::Apis::AdminDirectoryV1::MembersHasMember::Representation command.response_class = Google::Apis::AdminDirectoryV1::MembersHasMember command.params['groupKey'] = group_key unless group_key.nil? command.params['memberKey'] = member_key unless member_key.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -1277,10 +1176,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -1293,8 +1190,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def insert_member(group_key, member_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'groups/{groupKey}/members', options) + def insert_member(group_key, member_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'admin/directory/v1/groups/{groupKey}/members', options) command.request_representation = Google::Apis::AdminDirectoryV1::Member::Representation command.request_object = member_object command.response_representation = Google::Apis::AdminDirectoryV1::Member::Representation @@ -1302,7 +1199,6 @@ module Google command.params['groupKey'] = group_key unless group_key.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -1320,10 +1216,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -1336,8 +1230,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_members(group_key, include_derived_membership: nil, max_results: nil, page_token: nil, roles: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'groups/{groupKey}/members', options) + def list_members(group_key, include_derived_membership: nil, max_results: nil, page_token: nil, roles: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'admin/directory/v1/groups/{groupKey}/members', options) command.response_representation = Google::Apis::AdminDirectoryV1::Members::Representation command.response_class = Google::Apis::AdminDirectoryV1::Members command.params['groupKey'] = group_key unless group_key.nil? @@ -1347,12 +1241,10 @@ module Google command.query['roles'] = roles unless roles.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Update membership of a user in the specified group. This method supports patch - # semantics. + # Patch Member via Apiary Patch Orchestration # @param [String] group_key # Email or immutable ID of the group. If ID, it should match with id of group # object @@ -1363,10 +1255,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -1379,8 +1269,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def patch_member(group_key, member_key, member_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:patch, 'groups/{groupKey}/members/{memberKey}', options) + def patch_member(group_key, member_key, member_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:patch, 'admin/directory/v1/groups/{groupKey}/members/{memberKey}', options) command.request_representation = Google::Apis::AdminDirectoryV1::Member::Representation command.request_object = member_object command.response_representation = Google::Apis::AdminDirectoryV1::Member::Representation @@ -1389,7 +1279,6 @@ module Google command.params['memberKey'] = member_key unless member_key.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -1404,10 +1293,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -1420,8 +1307,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def update_member(group_key, member_key, member_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:put, 'groups/{groupKey}/members/{memberKey}', options) + def update_member(group_key, member_key, member_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:put, 'admin/directory/v1/groups/{groupKey}/members/{memberKey}', options) command.request_representation = Google::Apis::AdminDirectoryV1::Member::Representation command.request_object = member_object command.response_representation = Google::Apis::AdminDirectoryV1::Member::Representation @@ -1430,7 +1317,6 @@ module Google command.params['memberKey'] = member_key unless member_key.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -1443,10 +1329,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -1459,15 +1343,14 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def action_mobile_device(customer_id, resource_id, mobile_device_action_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'customer/{customerId}/devices/mobile/{resourceId}/action', options) + def action_mobile_device(customer_id, resource_id, mobile_device_action_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'admin/directory/v1/customer/{customerId}/devices/mobile/{resourceId}/action', options) command.request_representation = Google::Apis::AdminDirectoryV1::MobileDeviceAction::Representation command.request_object = mobile_device_action_object command.params['customerId'] = customer_id unless customer_id.nil? command.params['resourceId'] = resource_id unless resource_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -1479,10 +1362,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -1495,13 +1376,12 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def delete_mobile_device(customer_id, resource_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:delete, 'customer/{customerId}/devices/mobile/{resourceId}', options) + def delete_mobile_device(customer_id, resource_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'admin/directory/v1/customer/{customerId}/devices/mobile/{resourceId}', options) command.params['customerId'] = customer_id unless customer_id.nil? command.params['resourceId'] = resource_id unless resource_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -1515,10 +1395,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -1531,8 +1409,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_mobile_device(customer_id, resource_id, projection: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'customer/{customerId}/devices/mobile/{resourceId}', options) + def get_mobile_device(customer_id, resource_id, projection: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'admin/directory/v1/customer/{customerId}/devices/mobile/{resourceId}', options) command.response_representation = Google::Apis::AdminDirectoryV1::MobileDevice::Representation command.response_class = Google::Apis::AdminDirectoryV1::MobileDevice command.params['customerId'] = customer_id unless customer_id.nil? @@ -1540,7 +1418,6 @@ module Google command.query['projection'] = projection unless projection.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -1548,7 +1425,7 @@ module Google # @param [String] customer_id # Immutable ID of the G Suite account # @param [Fixnum] max_results - # Maximum number of results to return. + # Maximum number of results to return. Max allowed value is 100. # @param [String] order_by # Column to use for sorting results # @param [String] page_token @@ -1556,17 +1433,16 @@ module Google # @param [String] projection # Restrict information returned to a set of selected fields. # @param [String] query - # Search string in the format provided by this Help Center article. + # Search string in the format given at http://support.google.com/a/bin/answer.py? + # answer=1408863#search # @param [String] sort_order # Whether to return results in ascending or descending order. Only of use when # orderBy is also used # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -1579,8 +1455,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_mobile_devices(customer_id, max_results: nil, order_by: nil, page_token: nil, projection: nil, query: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'customer/{customerId}/devices/mobile', options) + def list_mobile_devices(customer_id, max_results: nil, order_by: nil, page_token: nil, projection: nil, query: nil, sort_order: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'admin/directory/v1/customer/{customerId}/devices/mobile', options) command.response_representation = Google::Apis::AdminDirectoryV1::MobileDevices::Representation command.response_class = Google::Apis::AdminDirectoryV1::MobileDevices command.params['customerId'] = customer_id unless customer_id.nil? @@ -1592,215 +1468,19 @@ module Google command.query['sortOrder'] = sort_order unless sort_order.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Deletes a notification - # @param [String] customer - # The unique ID for the customer's G Suite account. The customerId is also - # returned as part of the Users resource. - # @param [String] notification_id - # The unique ID of the notification. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [NilClass] No result returned for this method - # @yieldparam err [StandardError] error object if request failed - # - # @return [void] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def delete_notification(customer, notification_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:delete, 'customer/{customer}/notifications/{notificationId}', options) - command.params['customer'] = customer unless customer.nil? - command.params['notificationId'] = notification_id unless notification_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Retrieves a notification. - # @param [String] customer - # The unique ID for the customer's G Suite account. The customerId is also - # returned as part of the Users resource. - # @param [String] notification_id - # The unique ID of the notification. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::AdminDirectoryV1::Notification] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::AdminDirectoryV1::Notification] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_notification(customer, notification_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'customer/{customer}/notifications/{notificationId}', options) - command.response_representation = Google::Apis::AdminDirectoryV1::Notification::Representation - command.response_class = Google::Apis::AdminDirectoryV1::Notification - command.params['customer'] = customer unless customer.nil? - command.params['notificationId'] = notification_id unless notification_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Retrieves a list of notifications. - # @param [String] customer - # The unique ID for the customer's G Suite account. - # @param [String] language - # The ISO 639-1 code of the language notifications are returned in. The default - # is English (en). - # @param [Fixnum] max_results - # Maximum number of notifications to return per page. The default is 100. - # @param [String] page_token - # The token to specify the page of results to retrieve. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::AdminDirectoryV1::Notifications] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::AdminDirectoryV1::Notifications] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_notifications(customer, language: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'customer/{customer}/notifications', options) - command.response_representation = Google::Apis::AdminDirectoryV1::Notifications::Representation - command.response_class = Google::Apis::AdminDirectoryV1::Notifications - command.params['customer'] = customer unless customer.nil? - command.query['language'] = language unless language.nil? - command.query['maxResults'] = max_results unless max_results.nil? - command.query['pageToken'] = page_token unless page_token.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Updates a notification. This method supports patch semantics. - # @param [String] customer - # The unique ID for the customer's G Suite account. - # @param [String] notification_id - # The unique ID of the notification. - # @param [Google::Apis::AdminDirectoryV1::Notification] notification_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::AdminDirectoryV1::Notification] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::AdminDirectoryV1::Notification] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def patch_notification(customer, notification_id, notification_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:patch, 'customer/{customer}/notifications/{notificationId}', options) - command.request_representation = Google::Apis::AdminDirectoryV1::Notification::Representation - command.request_object = notification_object - command.response_representation = Google::Apis::AdminDirectoryV1::Notification::Representation - command.response_class = Google::Apis::AdminDirectoryV1::Notification - command.params['customer'] = customer unless customer.nil? - command.params['notificationId'] = notification_id unless notification_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Updates a notification. - # @param [String] customer - # The unique ID for the customer's G Suite account. - # @param [String] notification_id - # The unique ID of the notification. - # @param [Google::Apis::AdminDirectoryV1::Notification] notification_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::AdminDirectoryV1::Notification] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::AdminDirectoryV1::Notification] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def update_notification(customer, notification_id, notification_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:put, 'customer/{customer}/notifications/{notificationId}', options) - command.request_representation = Google::Apis::AdminDirectoryV1::Notification::Representation - command.request_object = notification_object - command.response_representation = Google::Apis::AdminDirectoryV1::Notification::Representation - command.response_class = Google::Apis::AdminDirectoryV1::Notification - command.params['customer'] = customer unless customer.nil? - command.params['notificationId'] = notification_id unless notification_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Remove organizational unit # @param [String] customer_id # Immutable ID of the G Suite account - # @param [Array, String] org_unit_path + # @param [String] org_unit_path # Full path of the organizational unit or its ID # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -1813,28 +1493,25 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def delete_org_unit(customer_id, org_unit_path, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:delete, 'customer/{customerId}/orgunits{/orgUnitPath*}', options) + def delete_org_unit(customer_id, org_unit_path, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'admin/directory/v1/customer/{customerId}/orgunits/{+orgUnitPath}', options) command.params['customerId'] = customer_id unless customer_id.nil? command.params['orgUnitPath'] = org_unit_path unless org_unit_path.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Retrieve organizational unit # @param [String] customer_id # Immutable ID of the G Suite account - # @param [Array, String] org_unit_path + # @param [String] org_unit_path # Full path of the organizational unit or its ID # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -1847,15 +1524,14 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_org_unit(customer_id, org_unit_path, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'customer/{customerId}/orgunits{/orgUnitPath*}', options) + def get_org_unit(customer_id, org_unit_path, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'admin/directory/v1/customer/{customerId}/orgunits/{+orgUnitPath}', options) command.response_representation = Google::Apis::AdminDirectoryV1::OrgUnit::Representation command.response_class = Google::Apis::AdminDirectoryV1::OrgUnit command.params['customerId'] = customer_id unless customer_id.nil? command.params['orgUnitPath'] = org_unit_path unless org_unit_path.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -1866,10 +1542,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -1882,8 +1556,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def insert_org_unit(customer_id, org_unit_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'customer/{customerId}/orgunits', options) + def insert_org_unit(customer_id, org_unit_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'admin/directory/v1/customer/{customerId}/orgunits', options) command.request_representation = Google::Apis::AdminDirectoryV1::OrgUnit::Representation command.request_object = org_unit_object command.response_representation = Google::Apis::AdminDirectoryV1::OrgUnit::Representation @@ -1891,7 +1565,6 @@ module Google command.params['customerId'] = customer_id unless customer_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -1905,10 +1578,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -1921,8 +1592,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_org_units(customer_id, org_unit_path: nil, type: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'customer/{customerId}/orgunits', options) + def list_org_units(customer_id, org_unit_path: nil, type: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'admin/directory/v1/customer/{customerId}/orgunits', options) command.response_representation = Google::Apis::AdminDirectoryV1::OrgUnits::Representation command.response_class = Google::Apis::AdminDirectoryV1::OrgUnits command.params['customerId'] = customer_id unless customer_id.nil? @@ -1930,23 +1601,20 @@ module Google command.query['type'] = type unless type.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Update organizational unit. This method supports patch semantics. + # Patch organization unit via Apiary Patch Orchestration # @param [String] customer_id # Immutable ID of the G Suite account - # @param [Array, String] org_unit_path + # @param [String] org_unit_path # Full path of the organizational unit or its ID # @param [Google::Apis::AdminDirectoryV1::OrgUnit] org_unit_object # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -1959,8 +1627,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def patch_org_unit(customer_id, org_unit_path, org_unit_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:patch, 'customer/{customerId}/orgunits{/orgUnitPath*}', options) + def patch_org_unit(customer_id, org_unit_path, org_unit_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:patch, 'admin/directory/v1/customer/{customerId}/orgunits/{+orgUnitPath}', options) command.request_representation = Google::Apis::AdminDirectoryV1::OrgUnit::Representation command.request_object = org_unit_object command.response_representation = Google::Apis::AdminDirectoryV1::OrgUnit::Representation @@ -1969,23 +1637,20 @@ module Google command.params['orgUnitPath'] = org_unit_path unless org_unit_path.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Update organizational unit # @param [String] customer_id # Immutable ID of the G Suite account - # @param [Array, String] org_unit_path + # @param [String] org_unit_path # Full path of the organizational unit or its ID # @param [Google::Apis::AdminDirectoryV1::OrgUnit] org_unit_object # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -1998,8 +1663,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def update_org_unit(customer_id, org_unit_path, org_unit_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:put, 'customer/{customerId}/orgunits{/orgUnitPath*}', options) + def update_org_unit(customer_id, org_unit_path, org_unit_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:put, 'admin/directory/v1/customer/{customerId}/orgunits/{+orgUnitPath}', options) command.request_representation = Google::Apis::AdminDirectoryV1::OrgUnit::Representation command.request_object = org_unit_object command.response_representation = Google::Apis::AdminDirectoryV1::OrgUnit::Representation @@ -2008,7 +1673,6 @@ module Google command.params['orgUnitPath'] = org_unit_path unless org_unit_path.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -2018,10 +1682,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -2034,14 +1696,13 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_privileges(customer, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'customer/{customer}/roles/ALL/privileges', options) + def list_privileges(customer, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'admin/directory/v1/customer/{customer}/roles/ALL/privileges', options) command.response_representation = Google::Apis::AdminDirectoryV1::Privileges::Representation command.response_class = Google::Apis::AdminDirectoryV1::Privileges command.params['customer'] = customer unless customer.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -2050,14 +1711,12 @@ module Google # The unique ID for the customer's G Suite account. As an account administrator, # you can also use the my_customer alias to represent your account's customer ID. # @param [String] building_id - # The ID of the building to delete. + # The id of the building to delete. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -2070,13 +1729,12 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def delete_resource_building(customer, building_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:delete, 'customer/{customer}/resources/buildings/{buildingId}', options) + def delete_resource_building(customer, building_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'admin/directory/v1/customer/{customer}/resources/buildings/{buildingId}', options) command.params['customer'] = customer unless customer.nil? command.params['buildingId'] = building_id unless building_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -2089,10 +1747,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -2105,15 +1761,14 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_resource_building(customer, building_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'customer/{customer}/resources/buildings/{buildingId}', options) + def get_resource_building(customer, building_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'admin/directory/v1/customer/{customer}/resources/buildings/{buildingId}', options) command.response_representation = Google::Apis::AdminDirectoryV1::Building::Representation command.response_class = Google::Apis::AdminDirectoryV1::Building command.params['customer'] = customer unless customer.nil? command.params['buildingId'] = building_id unless building_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -2127,10 +1782,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -2143,8 +1796,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def insert_resource_building(customer, building_object = nil, coordinates_source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'customer/{customer}/resources/buildings', options) + def insert_resource_building(customer, building_object = nil, coordinates_source: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'admin/directory/v1/customer/{customer}/resources/buildings', options) command.request_representation = Google::Apis::AdminDirectoryV1::Building::Representation command.request_object = building_object command.response_representation = Google::Apis::AdminDirectoryV1::Building::Representation @@ -2153,7 +1806,6 @@ module Google command.query['coordinatesSource'] = coordinates_source unless coordinates_source.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -2168,10 +1820,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -2184,8 +1834,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_resource_buildings(customer, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'customer/{customer}/resources/buildings', options) + def list_resource_buildings(customer, max_results: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'admin/directory/v1/customer/{customer}/resources/buildings', options) command.response_representation = Google::Apis::AdminDirectoryV1::Buildings::Representation command.response_class = Google::Apis::AdminDirectoryV1::Buildings command.params['customer'] = customer unless customer.nil? @@ -2193,26 +1843,23 @@ module Google command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Updates a building. This method supports patch semantics. + # Patches a building via Apiary Patch Orchestration. # @param [String] customer # The unique ID for the customer's G Suite account. As an account administrator, # you can also use the my_customer alias to represent your account's customer ID. # @param [String] building_id - # The ID of the building to update. + # The id of the building to update. # @param [Google::Apis::AdminDirectoryV1::Building] building_object # @param [String] coordinates_source # Source from which Building.coordinates are derived. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -2225,8 +1872,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def patch_resource_building(customer, building_id, building_object = nil, coordinates_source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:patch, 'customer/{customer}/resources/buildings/{buildingId}', options) + def patch_resource_building(customer, building_id, building_object = nil, coordinates_source: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:patch, 'admin/directory/v1/customer/{customer}/resources/buildings/{buildingId}', options) command.request_representation = Google::Apis::AdminDirectoryV1::Building::Representation command.request_object = building_object command.response_representation = Google::Apis::AdminDirectoryV1::Building::Representation @@ -2236,7 +1883,6 @@ module Google command.query['coordinatesSource'] = coordinates_source unless coordinates_source.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -2245,17 +1891,15 @@ module Google # The unique ID for the customer's G Suite account. As an account administrator, # you can also use the my_customer alias to represent your account's customer ID. # @param [String] building_id - # The ID of the building to update. + # The id of the building to update. # @param [Google::Apis::AdminDirectoryV1::Building] building_object # @param [String] coordinates_source # Source from which Building.coordinates are derived. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -2268,8 +1912,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def update_resource_building(customer, building_id, building_object = nil, coordinates_source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:put, 'customer/{customer}/resources/buildings/{buildingId}', options) + def update_resource_building(customer, building_id, building_object = nil, coordinates_source: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:put, 'admin/directory/v1/customer/{customer}/resources/buildings/{buildingId}', options) command.request_representation = Google::Apis::AdminDirectoryV1::Building::Representation command.request_object = building_object command.response_representation = Google::Apis::AdminDirectoryV1::Building::Representation @@ -2279,7 +1923,6 @@ module Google command.query['coordinatesSource'] = coordinates_source unless coordinates_source.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -2292,10 +1935,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -2308,13 +1949,12 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def delete_calendar_resource(customer, calendar_resource_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:delete, 'customer/{customer}/resources/calendars/{calendarResourceId}', options) + def delete_calendar_resource(customer, calendar_resource_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'admin/directory/v1/customer/{customer}/resources/calendars/{calendarResourceId}', options) command.params['customer'] = customer unless customer.nil? command.params['calendarResourceId'] = calendar_resource_id unless calendar_resource_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -2327,10 +1967,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -2343,15 +1981,14 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_calendar_resource(customer, calendar_resource_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'customer/{customer}/resources/calendars/{calendarResourceId}', options) + def get_calendar_resource(customer, calendar_resource_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'admin/directory/v1/customer/{customer}/resources/calendars/{calendarResourceId}', options) command.response_representation = Google::Apis::AdminDirectoryV1::CalendarResource::Representation command.response_class = Google::Apis::AdminDirectoryV1::CalendarResource command.params['customer'] = customer unless customer.nil? command.params['calendarResourceId'] = calendar_resource_id unless calendar_resource_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -2363,10 +2000,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -2379,8 +2014,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def calendar_resource(customer, calendar_resource_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'customer/{customer}/resources/calendars', options) + def calendar_resource(customer, calendar_resource_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'admin/directory/v1/customer/{customer}/resources/calendars', options) command.request_representation = Google::Apis::AdminDirectoryV1::CalendarResource::Representation command.request_object = calendar_resource_object command.response_representation = Google::Apis::AdminDirectoryV1::CalendarResource::Representation @@ -2388,7 +2023,6 @@ module Google command.params['customer'] = customer unless customer.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -2410,18 +2044,18 @@ module Google # @param [String] query # String query used to filter results. Should be of the form "field operator # value" where field can be any of supported fields and operators can be any of - # supported operations. Operators include '=' for exact match and ':' for prefix - # match or HAS match where applicable. For prefix match, the value should always - # be followed by a *. Supported fields include generatedResourceName, name, - # buildingId, featureInstances.feature.name. For example buildingId=US-NYC-9TH - # AND featureInstances.feature.name:Phone. + # supported operations. Operators include '=' for exact match, '!=' for mismatch + # and ':' for prefix match or HAS match where applicable. For prefix match, the + # value should always be followed by a *. Logical operators NOT and AND are + # supported (in this order of precedence). Supported fields include + # generatedResourceName, name, buildingId, floor_name, capacity, + # featureInstances.feature.name. For example buildingId=US-NYC-9TH AND + # featureInstances.feature.name:Phone. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -2434,8 +2068,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_calendar_resources(customer, max_results: nil, order_by: nil, page_token: nil, query: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'customer/{customer}/resources/calendars', options) + def list_calendar_resources(customer, max_results: nil, order_by: nil, page_token: nil, query: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'admin/directory/v1/customer/{customer}/resources/calendars', options) command.response_representation = Google::Apis::AdminDirectoryV1::CalendarResources::Representation command.response_class = Google::Apis::AdminDirectoryV1::CalendarResources command.params['customer'] = customer unless customer.nil? @@ -2445,14 +2079,10 @@ module Google command.query['query'] = query unless query.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Updates a calendar resource. - # This method supports patch semantics, meaning you only need to include the - # fields you wish to update. Fields that are not present in the request will be - # preserved. This method supports patch semantics. + # Patches a calendar resource via Apiary Patch Orchestration. # @param [String] customer # The unique ID for the customer's G Suite account. As an account administrator, # you can also use the my_customer alias to represent your account's customer ID. @@ -2462,10 +2092,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -2478,8 +2106,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def patch_calendar_resource(customer, calendar_resource_id, calendar_resource_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:patch, 'customer/{customer}/resources/calendars/{calendarResourceId}', options) + def patch_calendar_resource(customer, calendar_resource_id, calendar_resource_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:patch, 'admin/directory/v1/customer/{customer}/resources/calendars/{calendarResourceId}', options) command.request_representation = Google::Apis::AdminDirectoryV1::CalendarResource::Representation command.request_object = calendar_resource_object command.response_representation = Google::Apis::AdminDirectoryV1::CalendarResource::Representation @@ -2488,14 +2116,12 @@ module Google command.params['calendarResourceId'] = calendar_resource_id unless calendar_resource_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Updates a calendar resource. - # This method supports patch semantics, meaning you only need to include the - # fields you wish to update. Fields that are not present in the request will be - # preserved. + # Updates a calendar resource. This method supports patch semantics, meaning you + # only need to include the fields you wish to update. Fields that are not + # present in the request will be preserved. # @param [String] customer # The unique ID for the customer's G Suite account. As an account administrator, # you can also use the my_customer alias to represent your account's customer ID. @@ -2505,10 +2131,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -2521,8 +2145,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def update_calendar_resource(customer, calendar_resource_id, calendar_resource_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:put, 'customer/{customer}/resources/calendars/{calendarResourceId}', options) + def update_calendar_resource(customer, calendar_resource_id, calendar_resource_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:put, 'admin/directory/v1/customer/{customer}/resources/calendars/{calendarResourceId}', options) command.request_representation = Google::Apis::AdminDirectoryV1::CalendarResource::Representation command.request_object = calendar_resource_object command.response_representation = Google::Apis::AdminDirectoryV1::CalendarResource::Representation @@ -2531,7 +2155,6 @@ module Google command.params['calendarResourceId'] = calendar_resource_id unless calendar_resource_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -2544,10 +2167,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -2560,13 +2181,12 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def delete_resource_feature(customer, feature_key, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:delete, 'customer/{customer}/resources/features/{featureKey}', options) + def delete_resource_feature(customer, feature_key, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'admin/directory/v1/customer/{customer}/resources/features/{featureKey}', options) command.params['customer'] = customer unless customer.nil? command.params['featureKey'] = feature_key unless feature_key.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -2579,10 +2199,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -2595,15 +2213,14 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_resource_feature(customer, feature_key, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'customer/{customer}/resources/features/{featureKey}', options) + def get_resource_feature(customer, feature_key, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'admin/directory/v1/customer/{customer}/resources/features/{featureKey}', options) command.response_representation = Google::Apis::AdminDirectoryV1::Feature::Representation command.response_class = Google::Apis::AdminDirectoryV1::Feature command.params['customer'] = customer unless customer.nil? command.params['featureKey'] = feature_key unless feature_key.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -2615,10 +2232,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -2631,8 +2246,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def insert_resource_feature(customer, feature_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'customer/{customer}/resources/features', options) + def insert_resource_feature(customer, feature_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'admin/directory/v1/customer/{customer}/resources/features', options) command.request_representation = Google::Apis::AdminDirectoryV1::Feature::Representation command.request_object = feature_object command.response_representation = Google::Apis::AdminDirectoryV1::Feature::Representation @@ -2640,7 +2255,6 @@ module Google command.params['customer'] = customer unless customer.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -2655,10 +2269,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -2671,8 +2283,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_resource_features(customer, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'customer/{customer}/resources/features', options) + def list_resource_features(customer, max_results: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'admin/directory/v1/customer/{customer}/resources/features', options) command.response_representation = Google::Apis::AdminDirectoryV1::Features::Representation command.response_class = Google::Apis::AdminDirectoryV1::Features command.params['customer'] = customer unless customer.nil? @@ -2680,11 +2292,10 @@ module Google command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Updates a feature. This method supports patch semantics. + # Patches a feature via Apiary Patch Orchestration. # @param [String] customer # The unique ID for the customer's G Suite account. As an account administrator, # you can also use the my_customer alias to represent your account's customer ID. @@ -2694,10 +2305,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -2710,8 +2319,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def patch_resource_feature(customer, feature_key, feature_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:patch, 'customer/{customer}/resources/features/{featureKey}', options) + def patch_resource_feature(customer, feature_key, feature_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:patch, 'admin/directory/v1/customer/{customer}/resources/features/{featureKey}', options) command.request_representation = Google::Apis::AdminDirectoryV1::Feature::Representation command.request_object = feature_object command.response_representation = Google::Apis::AdminDirectoryV1::Feature::Representation @@ -2720,7 +2329,6 @@ module Google command.params['featureKey'] = feature_key unless feature_key.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -2734,10 +2342,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -2750,15 +2356,14 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def rename_resource_feature(customer, old_name, feature_rename_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'customer/{customer}/resources/features/{oldName}/rename', options) + def rename_resource_feature(customer, old_name, feature_rename_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'admin/directory/v1/customer/{customer}/resources/features/{oldName}/rename', options) command.request_representation = Google::Apis::AdminDirectoryV1::FeatureRename::Representation command.request_object = feature_rename_object command.params['customer'] = customer unless customer.nil? command.params['oldName'] = old_name unless old_name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -2772,10 +2377,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -2788,8 +2391,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def update_resource_feature(customer, feature_key, feature_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:put, 'customer/{customer}/resources/features/{featureKey}', options) + def update_resource_feature(customer, feature_key, feature_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:put, 'admin/directory/v1/customer/{customer}/resources/features/{featureKey}', options) command.request_representation = Google::Apis::AdminDirectoryV1::Feature::Representation command.request_object = feature_object command.response_representation = Google::Apis::AdminDirectoryV1::Feature::Representation @@ -2798,7 +2401,6 @@ module Google command.params['featureKey'] = feature_key unless feature_key.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -2810,10 +2412,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -2826,13 +2426,12 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def delete_role_assignment(customer, role_assignment_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:delete, 'customer/{customer}/roleassignments/{roleAssignmentId}', options) + def delete_role_assignment(customer, role_assignment_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'admin/directory/v1/customer/{customer}/roleassignments/{roleAssignmentId}', options) command.params['customer'] = customer unless customer.nil? command.params['roleAssignmentId'] = role_assignment_id unless role_assignment_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -2844,10 +2443,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -2860,15 +2457,14 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_role_assignment(customer, role_assignment_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'customer/{customer}/roleassignments/{roleAssignmentId}', options) + def get_role_assignment(customer, role_assignment_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'admin/directory/v1/customer/{customer}/roleassignments/{roleAssignmentId}', options) command.response_representation = Google::Apis::AdminDirectoryV1::RoleAssignment::Representation command.response_class = Google::Apis::AdminDirectoryV1::RoleAssignment command.params['customer'] = customer unless customer.nil? command.params['roleAssignmentId'] = role_assignment_id unless role_assignment_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -2879,10 +2475,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -2895,8 +2489,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def insert_role_assignment(customer, role_assignment_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'customer/{customer}/roleassignments', options) + def insert_role_assignment(customer, role_assignment_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'admin/directory/v1/customer/{customer}/roleassignments', options) command.request_representation = Google::Apis::AdminDirectoryV1::RoleAssignment::Representation command.request_object = role_assignment_object command.response_representation = Google::Apis::AdminDirectoryV1::RoleAssignment::Representation @@ -2904,7 +2498,6 @@ module Google command.params['customer'] = customer unless customer.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -2924,10 +2517,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -2940,8 +2531,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_role_assignments(customer, max_results: nil, page_token: nil, role_id: nil, user_key: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'customer/{customer}/roleassignments', options) + def list_role_assignments(customer, max_results: nil, page_token: nil, role_id: nil, user_key: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'admin/directory/v1/customer/{customer}/roleassignments', options) command.response_representation = Google::Apis::AdminDirectoryV1::RoleAssignments::Representation command.response_class = Google::Apis::AdminDirectoryV1::RoleAssignments command.params['customer'] = customer unless customer.nil? @@ -2951,7 +2542,6 @@ module Google command.query['userKey'] = user_key unless user_key.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -2963,10 +2553,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -2979,13 +2567,12 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def delete_role(customer, role_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:delete, 'customer/{customer}/roles/{roleId}', options) + def delete_role(customer, role_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'admin/directory/v1/customer/{customer}/roles/{roleId}', options) command.params['customer'] = customer unless customer.nil? command.params['roleId'] = role_id unless role_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -2997,10 +2584,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -3013,15 +2598,14 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_role(customer, role_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'customer/{customer}/roles/{roleId}', options) + def get_role(customer, role_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'admin/directory/v1/customer/{customer}/roles/{roleId}', options) command.response_representation = Google::Apis::AdminDirectoryV1::Role::Representation command.response_class = Google::Apis::AdminDirectoryV1::Role command.params['customer'] = customer unless customer.nil? command.params['roleId'] = role_id unless role_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -3032,10 +2616,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -3048,8 +2630,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def insert_role(customer, role_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'customer/{customer}/roles', options) + def insert_role(customer, role_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'admin/directory/v1/customer/{customer}/roles', options) command.request_representation = Google::Apis::AdminDirectoryV1::Role::Representation command.request_object = role_object command.response_representation = Google::Apis::AdminDirectoryV1::Role::Representation @@ -3057,7 +2639,6 @@ module Google command.params['customer'] = customer unless customer.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -3071,10 +2652,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -3087,8 +2666,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_roles(customer, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'customer/{customer}/roles', options) + def list_roles(customer, max_results: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'admin/directory/v1/customer/{customer}/roles', options) command.response_representation = Google::Apis::AdminDirectoryV1::Roles::Representation command.response_class = Google::Apis::AdminDirectoryV1::Roles command.params['customer'] = customer unless customer.nil? @@ -3096,11 +2675,10 @@ module Google command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Updates a role. This method supports patch semantics. + # Patch role via Apiary Patch Orchestration # @param [String] customer # Immutable ID of the G Suite account. # @param [String] role_id @@ -3109,10 +2687,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -3125,8 +2701,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def patch_role(customer, role_id, role_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:patch, 'customer/{customer}/roles/{roleId}', options) + def patch_role(customer, role_id, role_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:patch, 'admin/directory/v1/customer/{customer}/roles/{roleId}', options) command.request_representation = Google::Apis::AdminDirectoryV1::Role::Representation command.request_object = role_object command.response_representation = Google::Apis::AdminDirectoryV1::Role::Representation @@ -3135,7 +2711,6 @@ module Google command.params['roleId'] = role_id unless role_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -3148,10 +2723,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -3164,8 +2737,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def update_role(customer, role_id, role_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:put, 'customer/{customer}/roles/{roleId}', options) + def update_role(customer, role_id, role_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:put, 'admin/directory/v1/customer/{customer}/roles/{roleId}', options) command.request_representation = Google::Apis::AdminDirectoryV1::Role::Representation command.request_object = role_object command.response_representation = Google::Apis::AdminDirectoryV1::Role::Representation @@ -3174,7 +2747,6 @@ module Google command.params['roleId'] = role_id unless role_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -3186,10 +2758,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -3202,13 +2772,12 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def delete_schema(customer_id, schema_key, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:delete, 'customer/{customerId}/schemas/{schemaKey}', options) + def delete_schema(customer_id, schema_key, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'admin/directory/v1/customer/{customerId}/schemas/{schemaKey}', options) command.params['customerId'] = customer_id unless customer_id.nil? command.params['schemaKey'] = schema_key unless schema_key.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -3220,10 +2789,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -3236,15 +2803,14 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_schema(customer_id, schema_key, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'customer/{customerId}/schemas/{schemaKey}', options) + def get_schema(customer_id, schema_key, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'admin/directory/v1/customer/{customerId}/schemas/{schemaKey}', options) command.response_representation = Google::Apis::AdminDirectoryV1::Schema::Representation command.response_class = Google::Apis::AdminDirectoryV1::Schema command.params['customerId'] = customer_id unless customer_id.nil? command.params['schemaKey'] = schema_key unless schema_key.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -3255,10 +2821,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -3271,8 +2835,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def insert_schema(customer_id, schema_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'customer/{customerId}/schemas', options) + def insert_schema(customer_id, schema_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'admin/directory/v1/customer/{customerId}/schemas', options) command.request_representation = Google::Apis::AdminDirectoryV1::Schema::Representation command.request_object = schema_object command.response_representation = Google::Apis::AdminDirectoryV1::Schema::Representation @@ -3280,7 +2844,6 @@ module Google command.params['customerId'] = customer_id unless customer_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -3290,10 +2853,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -3306,18 +2867,17 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_schemas(customer_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'customer/{customerId}/schemas', options) + def list_schemas(customer_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'admin/directory/v1/customer/{customerId}/schemas', options) command.response_representation = Google::Apis::AdminDirectoryV1::Schemas::Representation command.response_class = Google::Apis::AdminDirectoryV1::Schemas command.params['customerId'] = customer_id unless customer_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Update schema. This method supports patch semantics. + # Patch Schema via Apiary Patch Orchestration # @param [String] customer_id # Immutable ID of the G Suite account # @param [String] schema_key @@ -3326,10 +2886,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -3342,8 +2900,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def patch_schema(customer_id, schema_key, schema_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:patch, 'customer/{customerId}/schemas/{schemaKey}', options) + def patch_schema(customer_id, schema_key, schema_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:patch, 'admin/directory/v1/customer/{customerId}/schemas/{schemaKey}', options) command.request_representation = Google::Apis::AdminDirectoryV1::Schema::Representation command.request_object = schema_object command.response_representation = Google::Apis::AdminDirectoryV1::Schema::Representation @@ -3352,7 +2910,6 @@ module Google command.params['schemaKey'] = schema_key unless schema_key.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -3365,10 +2922,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -3381,8 +2936,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def update_schema(customer_id, schema_key, schema_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:put, 'customer/{customerId}/schemas/{schemaKey}', options) + def update_schema(customer_id, schema_key, schema_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:put, 'admin/directory/v1/customer/{customerId}/schemas/{schemaKey}', options) command.request_representation = Google::Apis::AdminDirectoryV1::Schema::Representation command.request_object = schema_object command.response_representation = Google::Apis::AdminDirectoryV1::Schema::Representation @@ -3391,7 +2946,6 @@ module Google command.params['schemaKey'] = schema_key unless schema_key.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -3404,10 +2958,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -3420,13 +2972,12 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def delete_token(user_key, client_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:delete, 'users/{userKey}/tokens/{clientId}', options) + def delete_token(user_key, client_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'admin/directory/v1/users/{userKey}/tokens/{clientId}', options) command.params['userKey'] = user_key unless user_key.nil? command.params['clientId'] = client_id unless client_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -3439,10 +2990,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -3455,15 +3004,14 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_token(user_key, client_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'users/{userKey}/tokens/{clientId}', options) + def get_token(user_key, client_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'admin/directory/v1/users/{userKey}/tokens/{clientId}', options) command.response_representation = Google::Apis::AdminDirectoryV1::Token::Representation command.response_class = Google::Apis::AdminDirectoryV1::Token command.params['userKey'] = user_key unless user_key.nil? command.params['clientId'] = client_id unless client_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -3474,10 +3022,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -3490,14 +3036,13 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_tokens(user_key, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'users/{userKey}/tokens', options) + def list_tokens(user_key, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'admin/directory/v1/users/{userKey}/tokens', options) command.response_representation = Google::Apis::AdminDirectoryV1::Tokens::Representation command.response_class = Google::Apis::AdminDirectoryV1::Tokens command.params['userKey'] = user_key unless user_key.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -3507,10 +3052,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -3523,12 +3066,11 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def delete_user(user_key, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:delete, 'users/{userKey}', options) + def delete_user(user_key, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'admin/directory/v1/users/{userKey}', options) command.params['userKey'] = user_key unless user_key.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -3545,10 +3087,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -3561,8 +3101,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_user(user_key, custom_field_mask: nil, projection: nil, view_type: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'users/{userKey}', options) + def get_user(user_key, custom_field_mask: nil, projection: nil, view_type: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'admin/directory/v1/users/{userKey}', options) command.response_representation = Google::Apis::AdminDirectoryV1::User::Representation command.response_class = Google::Apis::AdminDirectoryV1::User command.params['userKey'] = user_key unless user_key.nil? @@ -3571,7 +3111,6 @@ module Google command.query['viewType'] = view_type unless view_type.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -3580,10 +3119,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -3596,15 +3133,14 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def insert_user(user_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'users', options) + def insert_user(user_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'admin/directory/v1/users', options) command.request_representation = Google::Apis::AdminDirectoryV1::User::Representation command.request_object = user_object command.response_representation = Google::Apis::AdminDirectoryV1::User::Representation command.response_class = Google::Apis::AdminDirectoryV1::User command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -3618,8 +3154,6 @@ module Google # @param [String] domain # Name of the domain. Fill this field to get users from only this domain. To # return all users in a multi-domain fill customer field instead. - # @param [String] event - # Event on which subscription is intended (if subscribing) # @param [Fixnum] max_results # Maximum number of results to return. # @param [String] order_by @@ -3630,7 +3164,7 @@ module Google # What subset of fields to fetch for this user. # @param [String] query # Query string search. Should be of the form "". Complete documentation is at - # https://developers.google.com/admin-sdk/directory/v1/guides/search-users + # https: //developers.google.com/admin-sdk/directory/v1/guides/search-users # @param [String] show_deleted # If set to true, retrieves the list of deleted users. (Default: false) # @param [String] sort_order @@ -3640,10 +3174,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -3656,14 +3188,13 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_users(custom_field_mask: nil, customer: nil, domain: nil, event: nil, max_results: nil, order_by: nil, page_token: nil, projection: nil, query: nil, show_deleted: nil, sort_order: nil, view_type: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'users', options) + def list_users(custom_field_mask: nil, customer: nil, domain: nil, max_results: nil, order_by: nil, page_token: nil, projection: nil, query: nil, show_deleted: nil, sort_order: nil, view_type: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'admin/directory/v1/users', options) command.response_representation = Google::Apis::AdminDirectoryV1::Users::Representation command.response_class = Google::Apis::AdminDirectoryV1::Users command.query['customFieldMask'] = custom_field_mask unless custom_field_mask.nil? command.query['customer'] = customer unless customer.nil? command.query['domain'] = domain unless domain.nil? - command.query['event'] = event unless event.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? @@ -3674,7 +3205,6 @@ module Google command.query['viewType'] = view_type unless view_type.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -3685,10 +3215,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -3701,18 +3229,17 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def make_user_admin(user_key, user_make_admin_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'users/{userKey}/makeAdmin', options) + def make_user_admin(user_key, user_make_admin_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'admin/directory/v1/users/{userKey}/makeAdmin', options) command.request_representation = Google::Apis::AdminDirectoryV1::UserMakeAdmin::Representation command.request_object = user_make_admin_object command.params['userKey'] = user_key unless user_key.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # update user. This method supports patch semantics. + # Patch Users via Apiary Patch Orchestration # @param [String] user_key # Email or immutable ID of the user. If ID, it should match with id of user # object @@ -3720,10 +3247,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -3736,8 +3261,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def patch_user(user_key, user_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:patch, 'users/{userKey}', options) + def patch_user(user_key, user_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:patch, 'admin/directory/v1/users/{userKey}', options) command.request_representation = Google::Apis::AdminDirectoryV1::User::Representation command.request_object = user_object command.response_representation = Google::Apis::AdminDirectoryV1::User::Representation @@ -3745,7 +3270,6 @@ module Google command.params['userKey'] = user_key unless user_key.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -3756,10 +3280,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -3772,14 +3294,13 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def undelete_user(user_key, user_undelete_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'users/{userKey}/undelete', options) + def undelete_user(user_key, user_undelete_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'admin/directory/v1/users/{userKey}/undelete', options) command.request_representation = Google::Apis::AdminDirectoryV1::UserUndelete::Representation command.request_object = user_undelete_object command.params['userKey'] = user_key unless user_key.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -3791,10 +3312,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -3807,8 +3326,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def update_user(user_key, user_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:put, 'users/{userKey}', options) + def update_user(user_key, user_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:put, 'admin/directory/v1/users/{userKey}', options) command.request_representation = Google::Apis::AdminDirectoryV1::User::Representation command.request_object = user_object command.response_representation = Google::Apis::AdminDirectoryV1::User::Representation @@ -3816,47 +3335,24 @@ module Google command.params['userKey'] = user_key unless user_key.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Watch for changes in users list # @param [Google::Apis::AdminDirectoryV1::Channel] channel_object - # @param [String] custom_field_mask - # Comma-separated list of schema names. All fields from these schemas are - # fetched. This should only be set when projection=custom. # @param [String] customer # Immutable ID of the G Suite account. In case of multi-domain, to fetch all # users for a customer, fill this field instead of domain. # @param [String] domain # Name of the domain. Fill this field to get users from only this domain. To - # return all users in a multi-domain fill customer field instead. + # return all users in a multi-domain fill customer field instead." # @param [String] event - # Event on which subscription is intended (if subscribing) - # @param [Fixnum] max_results - # Maximum number of results to return. - # @param [String] order_by - # Column to use for sorting results - # @param [String] page_token - # Token to specify next page in the list - # @param [String] projection - # What subset of fields to fetch for this user. - # @param [String] query - # Query string search. Should be of the form "". Complete documentation is at - # https://developers.google.com/admin-sdk/directory/v1/guides/search-users - # @param [String] show_deleted - # If set to true, retrieves the list of deleted users. (Default: false) - # @param [String] sort_order - # Whether to return results in ascending or descending order. - # @param [String] view_type - # Whether to fetch the ADMIN_VIEW or DOMAIN_PUBLIC view of the user. + # Event on which subscription is intended # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -3869,27 +3365,17 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def watch_user(channel_object = nil, custom_field_mask: nil, customer: nil, domain: nil, event: nil, max_results: nil, order_by: nil, page_token: nil, projection: nil, query: nil, show_deleted: nil, sort_order: nil, view_type: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'users/watch', options) + def watch_user(channel_object = nil, customer: nil, domain: nil, event: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'admin/directory/v1/users/watch', options) command.request_representation = Google::Apis::AdminDirectoryV1::Channel::Representation command.request_object = channel_object command.response_representation = Google::Apis::AdminDirectoryV1::Channel::Representation command.response_class = Google::Apis::AdminDirectoryV1::Channel - command.query['customFieldMask'] = custom_field_mask unless custom_field_mask.nil? command.query['customer'] = customer unless customer.nil? command.query['domain'] = domain unless domain.nil? command.query['event'] = event unless event.nil? - command.query['maxResults'] = max_results unless max_results.nil? - command.query['orderBy'] = order_by unless order_by.nil? - command.query['pageToken'] = page_token unless page_token.nil? - command.query['projection'] = projection unless projection.nil? - command.query['query'] = query unless query.nil? - command.query['showDeleted'] = show_deleted unless show_deleted.nil? - command.query['sortOrder'] = sort_order unless sort_order.nil? - command.query['viewType'] = view_type unless view_type.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -3901,10 +3387,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -3917,13 +3401,12 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def delete_user_alias(user_key, user_alias, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:delete, 'users/{userKey}/aliases/{alias}', options) + def delete_user_alias(user_key, user_alias, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'admin/directory/v1/users/{userKey}/aliases/{alias}', options) command.params['userKey'] = user_key unless user_key.nil? command.params['alias'] = user_alias unless user_alias.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -3934,10 +3417,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -3950,8 +3431,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def insert_user_alias(user_key, alias_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'users/{userKey}/aliases', options) + def insert_user_alias(user_key, alias_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'admin/directory/v1/users/{userKey}/aliases', options) command.request_representation = Google::Apis::AdminDirectoryV1::Alias::Representation command.request_object = alias_object command.response_representation = Google::Apis::AdminDirectoryV1::Alias::Representation @@ -3959,22 +3440,17 @@ module Google command.params['userKey'] = user_key unless user_key.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # List all aliases for a user # @param [String] user_key # Email or immutable ID of the user - # @param [String] event - # Event on which subscription is intended (if subscribing) # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -3987,19 +3463,17 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_user_aliases(user_key, event: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'users/{userKey}/aliases', options) + def list_user_aliases(user_key, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'admin/directory/v1/users/{userKey}/aliases', options) command.response_representation = Google::Apis::AdminDirectoryV1::Aliases::Representation command.response_class = Google::Apis::AdminDirectoryV1::Aliases command.params['userKey'] = user_key unless user_key.nil? - command.query['event'] = event unless event.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Watch for changes in user aliases list + # Watch for changes in users list # @param [String] user_key # Email or immutable ID of the user # @param [Google::Apis::AdminDirectoryV1::Channel] channel_object @@ -4008,10 +3482,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -4024,8 +3496,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def watch_user_alias(user_key, channel_object = nil, event: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'users/{userKey}/aliases/watch', options) + def watch_user_alias(user_key, channel_object = nil, event: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'admin/directory/v1/users/{userKey}/aliases/watch', options) command.request_representation = Google::Apis::AdminDirectoryV1::Channel::Representation command.request_object = channel_object command.response_representation = Google::Apis::AdminDirectoryV1::Channel::Representation @@ -4034,7 +3506,6 @@ module Google command.query['event'] = event unless event.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -4044,10 +3515,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -4060,12 +3529,11 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def delete_user_photo(user_key, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:delete, 'users/{userKey}/photos/thumbnail', options) + def delete_user_photo(user_key, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'admin/directory/v1/users/{userKey}/photos/thumbnail', options) command.params['userKey'] = user_key unless user_key.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -4075,10 +3543,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -4091,28 +3557,25 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_user_photo(user_key, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'users/{userKey}/photos/thumbnail', options) + def get_user_photo(user_key, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'admin/directory/v1/users/{userKey}/photos/thumbnail', options) command.response_representation = Google::Apis::AdminDirectoryV1::UserPhoto::Representation command.response_class = Google::Apis::AdminDirectoryV1::UserPhoto command.params['userKey'] = user_key unless user_key.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Add a photo for the user. This method supports patch semantics. + # Patch Photo via Apiary Patch Orchestration # @param [String] user_key # Email or immutable ID of the user # @param [Google::Apis::AdminDirectoryV1::UserPhoto] user_photo_object # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -4125,8 +3588,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def patch_user_photo(user_key, user_photo_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:patch, 'users/{userKey}/photos/thumbnail', options) + def patch_user_photo(user_key, user_photo_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:patch, 'admin/directory/v1/users/{userKey}/photos/thumbnail', options) command.request_representation = Google::Apis::AdminDirectoryV1::UserPhoto::Representation command.request_object = user_photo_object command.response_representation = Google::Apis::AdminDirectoryV1::UserPhoto::Representation @@ -4134,7 +3597,6 @@ module Google command.params['userKey'] = user_key unless user_key.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -4145,10 +3607,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -4161,8 +3621,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def update_user_photo(user_key, user_photo_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:put, 'users/{userKey}/photos/thumbnail', options) + def update_user_photo(user_key, user_photo_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:put, 'admin/directory/v1/users/{userKey}/photos/thumbnail', options) command.request_representation = Google::Apis::AdminDirectoryV1::UserPhoto::Representation command.request_object = user_photo_object command.response_representation = Google::Apis::AdminDirectoryV1::UserPhoto::Representation @@ -4170,7 +3630,6 @@ module Google command.params['userKey'] = user_key unless user_key.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -4180,10 +3639,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -4196,12 +3653,11 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def generate_verification_code(user_key, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'users/{userKey}/verificationCodes/generate', options) + def generate_verification_code(user_key, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'admin/directory/v1/users/{userKey}/verificationCodes/generate', options) command.params['userKey'] = user_key unless user_key.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -4211,10 +3667,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -4227,12 +3681,11 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def invalidate_verification_code(user_key, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'users/{userKey}/verificationCodes/invalidate', options) + def invalidate_verification_code(user_key, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'admin/directory/v1/users/{userKey}/verificationCodes/invalidate', options) command.params['userKey'] = user_key unless user_key.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -4244,10 +3697,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -4260,14 +3711,13 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_verification_codes(user_key, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'users/{userKey}/verificationCodes', options) + def list_verification_codes(user_key, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'admin/directory/v1/users/{userKey}/verificationCodes', options) command.response_representation = Google::Apis::AdminDirectoryV1::VerificationCodes::Representation command.response_class = Google::Apis::AdminDirectoryV1::VerificationCodes command.params['userKey'] = user_key unless user_key.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -4276,7 +3726,6 @@ module Google def apply_command_defaults(command) command.query['key'] = key unless key.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? end end end diff --git a/generated/google/apis/admin_reports_v1.rb b/generated/google/apis/admin_reports_v1.rb index e5d3123ba..c718974f5 100644 --- a/generated/google/apis/admin_reports_v1.rb +++ b/generated/google/apis/admin_reports_v1.rb @@ -18,15 +18,16 @@ require 'google/apis/admin_reports_v1/representations.rb' module Google module Apis - # Admin Reports API + # Admin SDK # - # Fetches reports for the administrators of G Suite customers about the usage, - # collaboration, security, and risk for their users. + # Admin SDK lets administrators of enterprise domains to view and manage + # 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 VERSION = 'ReportsV1' - REVISION = '20191014' + REVISION = '20200810' # View audit reports for your G Suite domain AUTH_ADMIN_REPORTS_AUDIT_READONLY = 'https://www.googleapis.com/auth/admin.reports.audit.readonly' diff --git a/generated/google/apis/admin_reports_v1/classes.rb b/generated/google/apis/admin_reports_v1/classes.rb index 264eda2d0..8b1ce7e4e 100644 --- a/generated/google/apis/admin_reports_v1/classes.rb +++ b/generated/google/apis/admin_reports_v1/classes.rb @@ -22,7 +22,7 @@ module Google module Apis module AdminReportsV1 - # JSON template for a collection of activites. + # JSON template for a collection of activities. class Activities 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 # API. And each eventName is related to a specific G Suite service or feature - # which the API organizes into types of events. - # For eventName request parameters in general: - # - If no eventName is given, the report returns all possible instances of an - # eventName. - # - When you request an eventName, the API's response returns all activities - # which contain that eventName. It is possible that the returned activities will - # have other eventName properties in addition to the one requested. - # For more information about eventName properties, see the list of event names - # for various applications above in applicationName. + # which the API organizes into types of events. For eventName request parameters + # in general: - If no eventName is given, the report returns all possible + # instances of an eventName. - When you request an eventName, the API's response + # returns all activities which contain that eventName. It is possible that the + # returned activities will have other eventName properties in addition to the + # one requested. For more information about eventName properties, see the list + # of event names for various applications above in applicationName. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -351,7 +349,7 @@ module Google end end - # An notification channel used to watch for resource changes. + # A notification channel used to watch for resource changes. class Channel include Google::Apis::Core::Hashable @@ -489,12 +487,12 @@ module Google class UsageReport 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` # @return [String] 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` # @return [Google::Apis::AdminReportsV1::UsageReport::Entity] attr_accessor :entity @@ -510,8 +508,9 @@ module Google # @return [String] attr_accessor :kind - # Parameter value pairs for various applications. For the Customers usage report - # parameters and values, see the customer usage parameters reference. + # Output only. Parameter value pairs for various applications. For the Customers + # usage report parameters and values, see the customer usage parameters + # reference. # Corresponds to the JSON property `parameters` # @return [Array] attr_accessor :parameters @@ -529,32 +528,32 @@ module Google @parameters = args[:parameters] if args.key?(:parameters) end - # Information about the type of the item. + # Output only. Information about the type of the item. class Entity 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` # @return [String] attr_accessor :customer_id - # Object key. Only relevant if entity.type = "OBJECT" Note: external-facing name - # of report is "Entities" rather than "Objects". + # Output only. Object key. Only relevant if entity.type = "OBJECT" Note: + # external-facing name of report is "Entities" rather than "Objects". # Corresponds to the JSON property `entityId` # @return [String] attr_accessor :entity_id - # The user's immutable G Suite profile identifier. + # Output only. The user's immutable G Suite profile identifier. # Corresponds to the JSON property `profileId` # @return [String] 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` # @return [String] 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` # @return [String] attr_accessor :user_email @@ -577,7 +576,7 @@ module Google class Parameter include Google::Apis::Core::Hashable - # Boolean value of the parameter. + # Output only. Boolean value of the parameter. # Corresponds to the JSON property `boolValue` # @return [Boolean] attr_accessor :bool_value @@ -589,22 +588,22 @@ module Google # @return [DateTime] attr_accessor :datetime_value - # Integer value of the parameter. + # Output only. Integer value of the parameter. # Corresponds to the JSON property `intValue` # @return [Fixnum] attr_accessor :int_value - # Nested message value of the parameter. + # Output only. Nested message value of the parameter. # Corresponds to the JSON property `msgValue` # @return [Array>] attr_accessor :msg_value - # + # Name of the parameter. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # String value of the parameter. + # Output only. String value of the parameter. # Corresponds to the JSON property `stringValue` # @return [String] attr_accessor :string_value @@ -684,12 +683,11 @@ module Google # @return [Array] attr_accessor :data - # The human readable messages for a warning are: - # - Data is not available warning - Sorry, data for date yyyy-mm-dd for - # application "application name" is not available. - # - Partial data is available warning - Data for date yyyy-mm-dd for application - # "application name" is not available right now, please try again after a few - # hours. + # The human readable messages for a warning are: - Data is not available warning + # - Sorry, data for date yyyy-mm-dd for application "application name" is not + # available. - Partial data is available warning - Data for date yyyy-mm-dd for + # application "application name" is not available right now, please try again + # after a few hours. # Corresponds to the JSON property `message` # @return [String] attr_accessor :message diff --git a/generated/google/apis/admin_reports_v1/service.rb b/generated/google/apis/admin_reports_v1/service.rb index a0b277a4d..e25ba73f7 100644 --- a/generated/google/apis/admin_reports_v1/service.rb +++ b/generated/google/apis/admin_reports_v1/service.rb @@ -20,10 +20,11 @@ require 'google/apis/errors' module Google module Apis module AdminReportsV1 - # Admin Reports API + # Admin SDK # - # Fetches reports for the administrators of G Suite customers about the usage, - # collaboration, security, and risk for their users. + # Admin SDK lets administrators of enterprise domains to view and manage + # resources like user, groups etc. It also provides audit and usage reports of + # domain. # # @example # require 'google/apis/admin_reports_v1' @@ -31,7 +32,7 @@ module Google # Admin = Google::Apis::AdminReportsV1 # Alias the module # service = Admin::ReportsService.new # - # @see /admin-sdk/reports/ + # @see http://developers.google.com/admin-sdk/ class ReportsService < Google::Apis::Core::BaseService # @return [String] # API key. Your API key identifies your project and provides you with API access, @@ -39,16 +40,12 @@ module Google attr_accessor :key # @return [String] - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. attr_accessor :quota_user - # @return [String] - # Deprecated. Please use quotaUser instead. - attr_accessor :user_ip - def initialize - super('https://www.googleapis.com/', 'admin/reports/v1/') + super('https://www.googleapis.com/', '') @batch_path = 'batch/admin/reports_v1' end @@ -76,15 +73,13 @@ module Google # 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 # approximate time of the API request. An API report has three basic time - # concepts: - # - Date of the API's request for a report: When the API created and retrieved - # the report. - # - Report's start time: The beginning of the timespan shown in the report. The - # startTime must be before the endTime (if specified) and the current time when - # 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, + # concepts: - *Date of the API's request for a report*: When the API created and + # retrieved the report. - *Report's start time*: The beginning of the timespan + # shown in the report. The startTime must be before the endTime (if specified) + # and the current time when 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 - # 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 # current time or the most recent 180 days if the startTime is more than 180 # days in the past. @@ -101,39 +96,33 @@ module Google # @param [String] filters # The filters query string is a comma-separated list. The list is composed of # event parameters that are manipulated by relational operators. Event - # parameters are in the form [parameter1 name][relational operator][parameter1 - # value],[parameter2 name][relational operator][parameter2 value],... - # These event parameters are associated with a specific eventName. An empty - # report is returned if the filtered request's parameter does not belong to the - # eventName. For more information about eventName parameters, see the list of - # event names for various applications above in applicationName. - # In the following Admin Activity example, the <> operator is URL-encoded in the - # request's query string (%3C%3E): - # GET...&eventName=CHANGE_CALENDAR_SETTING &filters=NEW_VALUE%3C% - # 3EREAD_ONLY_ACCESS - # In the following Drive example, the list can be a view or edit event's doc_id + # parameters are in the form parameter1 name[parameter1 value],parameter2 name[ + # parameter2 value],... These event parameters are associated with a specific + # eventName. An empty report is returned if the filtered request's parameter + # does not belong to the eventName. For more information about eventName + # parameters, see the list of event names for various applications above in + # applicationName. In the following Admin Activity example, the <> operator is + # URL-encoded in the request's query string (%3C%3E): GET...&eventName= + # CHANGE_CALENDAR_SETTING &filters=NEW_VALUE%3C%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 # to' (<>) relational operator. In the first 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 which have a doc_id value of 98765. The <> operator is URL- - # encoded in the request's query string (%3C%3E): - # GET...&eventName=edit&filters=doc_id GET...&eventName=view&filters=doc_id== - # 12345,doc_id%3C%3E98765 - # The relational operators include: - # - == - 'equal to'. - # - <> - '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=). - # Note: The API doesn't accept multiple values of a parameter. If a particular + # encoded in the request's query string (%3C%3E): GET...&eventName=edit&filters= + # doc_id GET...&eventName=view&filters=doc_id==12345,doc_id%3C%3E98765 The + # relational operators include: - == - 'equal to'. - <> - '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=). * + # 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 - # the last value of that request parameter. - # In addition, if an invalid request parameter is supplied in the API request, - # the API ignores that request parameter and returns the response corresponding - # to the remaining valid request parameters. If no parameters are requested, all - # parameters are returned. + # the last value of that request parameter. In addition, if an invalid request + # parameter is supplied in the API request, the API ignores that request + # parameter and returns the response corresponding to the remaining valid + # request parameters. If no parameters are requested, all parameters are + # returned. # @param [Fixnum] max_results # 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, @@ -158,10 +147,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -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::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_activities(user_key, application_name, actor_ip_address: nil, customer_id: nil, end_time: nil, event_name: nil, filters: nil, max_results: nil, org_unit_id: nil, page_token: nil, start_time: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'activity/users/{userKey}/applications/{applicationName}', options) + 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, 'admin/reports/v1/activity/users/{userKey}/applications/{applicationName}', options) command.response_representation = Google::Apis::AdminReportsV1::Activities::Representation command.response_class = Google::Apis::AdminReportsV1::Activities command.params['userKey'] = user_key unless user_key.nil? @@ -191,7 +178,6 @@ module Google command.query['startTime'] = start_time unless start_time.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -217,15 +203,13 @@ module Google # 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 # approximate time of the API request. An API report has three basic time - # concepts: - # - Date of the API's request for a report: When the API created and retrieved - # the report. - # - Report's start time: The beginning of the timespan shown in the report. The - # startTime must be before the endTime (if specified) and the current time when - # 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, + # concepts: - *Date of the API's request for a report*: When the API created and + # retrieved the report. - *Report's start time*: The beginning of the timespan + # shown in the report. The startTime must be before the endTime (if specified) + # and the current time when 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 - # 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 # current time or the most recent 180 days if the startTime is more than 180 # days in the past. @@ -242,39 +226,33 @@ module Google # @param [String] filters # The filters query string is a comma-separated list. The list is composed of # event parameters that are manipulated by relational operators. Event - # parameters are in the form [parameter1 name][relational operator][parameter1 - # value],[parameter2 name][relational operator][parameter2 value],... - # These event parameters are associated with a specific eventName. An empty - # report is returned if the filtered request's parameter does not belong to the - # eventName. For more information about eventName parameters, see the list of - # event names for various applications above in applicationName. - # In the following Admin Activity example, the <> operator is URL-encoded in the - # request's query string (%3C%3E): - # GET...&eventName=CHANGE_CALENDAR_SETTING &filters=NEW_VALUE%3C% - # 3EREAD_ONLY_ACCESS - # In the following Drive example, the list can be a view or edit event's doc_id + # parameters are in the form parameter1 name[parameter1 value],parameter2 name[ + # parameter2 value],... These event parameters are associated with a specific + # eventName. An empty report is returned if the filtered request's parameter + # does not belong to the eventName. For more information about eventName + # parameters, see the list of event names for various applications above in + # applicationName. In the following Admin Activity example, the <> operator is + # URL-encoded in the request's query string (%3C%3E): GET...&eventName= + # CHANGE_CALENDAR_SETTING &filters=NEW_VALUE%3C%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 # to' (<>) relational operator. In the first 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 which have a doc_id value of 98765. The <> operator is URL- - # encoded in the request's query string (%3C%3E): - # GET...&eventName=edit&filters=doc_id GET...&eventName=view&filters=doc_id== - # 12345,doc_id%3C%3E98765 - # The relational operators include: - # - == - 'equal to'. - # - <> - '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=). - # Note: The API doesn't accept multiple values of a parameter. If a particular + # encoded in the request's query string (%3C%3E): GET...&eventName=edit&filters= + # doc_id GET...&eventName=view&filters=doc_id==12345,doc_id%3C%3E98765 The + # relational operators include: - == - 'equal to'. - <> - '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=). * + # 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 - # the last value of that request parameter. - # In addition, if an invalid request parameter is supplied in the API request, - # the API ignores that request parameter and returns the response corresponding - # to the remaining valid request parameters. If no parameters are requested, all - # parameters are returned. + # the last value of that request parameter. In addition, if an invalid request + # parameter is supplied in the API request, the API ignores that request + # parameter and returns the response corresponding to the remaining valid + # request parameters. If no parameters are requested, all parameters are + # returned. # @param [Fixnum] max_results # 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, @@ -299,10 +277,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -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::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def watch_activity(user_key, application_name, channel_object = nil, actor_ip_address: nil, customer_id: nil, end_time: nil, event_name: nil, filters: nil, max_results: nil, org_unit_id: nil, page_token: nil, start_time: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'activity/users/{userKey}/applications/{applicationName}/watch', options) + 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, 'admin/reports/v1/activity/users/{userKey}/applications/{applicationName}/watch', options) command.request_representation = Google::Apis::AdminReportsV1::Channel::Representation command.request_object = channel_object command.response_representation = Google::Apis::AdminReportsV1::Channel::Representation @@ -334,19 +310,16 @@ module Google command.query['startTime'] = start_time unless start_time.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Stop watching resources through this channel + # Stop watching resources through this channel. # @param [Google::Apis::AdminReportsV1::Channel] channel_object # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -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::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def stop_channel(channel_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, '/admin/reports_v1/channels/stop', options) + 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.request_representation = Google::Apis::AdminReportsV1::Channel::Representation command.request_object = channel_object command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -387,24 +359,20 @@ module Google # refine a report's results. The parameter is associated with a specific # application. The application values for the Customers usage report include # accounts, app_maker, apps_scripts, calendar, classroom, cros, docs, gmail, - # gplus, device_management, meet, and sites. - # A parameters 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 a parameter. If a particular - # parameter is supplied more than once in the API request, the API only accepts - # the last value of that request parameter. - # In addition, if an invalid request parameter is supplied in the API request, - # the API ignores that request parameter and returns the response corresponding - # to the remaining valid request parameters. + # gplus, device_management, meet, and sites. A parameters 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 a parameter. If a particular parameter is + # supplied more than once in the API request, the API only accepts the last + # value of that request parameter. In addition, if an invalid request parameter + # is supplied in the API request, 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 # application. If no parameters are requested, all parameters are returned. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] 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::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_customer_usage_report(date, customer_id: nil, page_token: nil, parameters: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'usage/dates/{date}', options) + 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, 'admin/reports/v1/usage/dates/{date}', options) command.response_representation = Google::Apis::AdminReportsV1::UsageReports::Representation command.response_class = Google::Apis::AdminReportsV1::UsageReports command.params['date'] = date unless date.nil? @@ -427,7 +395,6 @@ module Google command.query['parameters'] = parameters unless parameters.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -449,22 +416,16 @@ module Google # 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 # returned in the report. The application values for the Entities usage report - # include accounts, docs, and gmail. - # Filters are in the form [application name]:[parameter name][relational - # operator][parameter value],.... - # In this example, the <> 'not equal to' operator is URL-encoded in the request' - # s query string (%3C%3E): - # GET https://www.googleapis.com/admin/reports/v1/usage/gplus_communities/all/ - # dates/2017-12-01 ?parameters=gplus:community_name,gplus:num_total_members & - # filters=gplus:num_total_members>0 - # The relational operators include: - # - == - 'equal to'. - # - <> - '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. + # include accounts, docs, and gmail. Filters are in the form [application name]: + # parameter name[parameter value],.... In this example, the <> 'not equal to' + # operator is URL-encoded in the request's query string (%3C%3E): GET https:// + # www.googleapis.com/admin/reports/v1/usage/gplus_communities/all/dates/2017-12- + # 01 ?parameters=gplus:community_name,gplus:num_total_members &filters=gplus: + # num_total_members>0 The relational operators include: - == - 'equal to'. - <> - + # '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 # 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, @@ -478,24 +439,20 @@ module Google # 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 # application. The application values for the Entities usage report are only - # gplus. - # 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 a parameter. If a particular - # parameter is supplied more than once in the API request, the API only accepts - # the last value of that request parameter. - # In addition, if an invalid request parameter is supplied in the API request, - # 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 - # application. If no parameters are requested, all parameters are returned. + # gplus. 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 + # a parameter. If a particular parameter is supplied more than once in the API + # request, the API only accepts the last value of that request parameter. In + # addition, if an invalid request parameter is supplied in the API request, 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 application. If no parameters are + # requested, all parameters are returned. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] 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::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_entity_usage_report(entity_type, entity_key, date, customer_id: nil, filters: nil, max_results: nil, page_token: nil, parameters: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'usage/{entityType}/{entityKey}/dates/{date}', options) + 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, 'admin/reports/v1/usage/{entityType}/{entityKey}/dates/{date}', options) command.response_representation = Google::Apis::AdminReportsV1::UsageReports::Representation command.response_class = Google::Apis::AdminReportsV1::UsageReports command.params['entityType'] = entity_type unless entity_type.nil? @@ -522,7 +479,6 @@ module Google command.query['parameters'] = parameters unless parameters.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -544,27 +500,21 @@ module Google # 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 # returned in the report. The application values for the Users Usage Report - # include accounts, docs, and gmail. - # Filters are in the form [application name]:[parameter name][relational - # operator][parameter value],.... - # In this example, the <> 'not equal to' operator is URL-encoded in the request' - # s query string (%3C%3E): - # GET https://www.googleapis.com/admin/reports/v1/usage/users/all/dates/2013-03- - # 03 ?parameters=accounts:last_login_time &filters=accounts:last_login_time>2010- - # 10-28T10:26:35.000Z - # The relational operators include: - # - == - 'equal to'. - # - <> - '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=). + # include accounts, docs, and gmail. Filters are in the form [application name]: + # parameter name[parameter value],.... In this example, the <> 'not equal to' + # operator is URL-encoded in the request's query string (%3C%3E): GET https:// + # www.googleapis.com/admin/reports/v1/usage/users/all/dates/2013-03-03 ? + # parameters=accounts:last_login_time &filters=accounts:last_login_time>2010-10- + # 28T10:26:35.000Z The relational operators include: - == - 'equal to'. - <> - ' + # 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 # 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, # the report has two pages. The response's nextPageToken property has the token - # to the second page. - # The maxResults query string is optional. + # to the second page. The maxResults query string is optional. # @param [String] org_unit_id # 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, @@ -578,24 +528,20 @@ module Google # refine a report's results. The parameter is associated with a specific # application. The application values for the Customers usage report include # accounts, app_maker, apps_scripts, calendar, classroom, cros, docs, gmail, - # gplus, device_management, meet, and sites. - # A parameters 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 a parameter. - # If a particular parameter is supplied more than once in the API request, the - # API only accepts the last value of that request parameter. In addition, if an - # invalid request parameter is supplied in the API request, the API ignores that - # request parameter and returns the response corresponding to the remaining - # valid request parameters. + # gplus, device_management, meet, and sites. A parameters 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 a parameter. If a particular parameter is + # supplied more than once in the API request, the API only accepts the last + # value of that request parameter. In addition, if an invalid request parameter + # is supplied in the API request, 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 # application. If no parameters are requested, all parameters are returned. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] 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::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_user_usage_report(user_key, date, customer_id: nil, filters: nil, max_results: nil, org_unit_id: nil, page_token: nil, parameters: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'usage/users/{userKey}/dates/{date}', options) + 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, 'admin/reports/v1/usage/users/{userKey}/dates/{date}', options) command.response_representation = Google::Apis::AdminReportsV1::UsageReports::Representation command.response_class = Google::Apis::AdminReportsV1::UsageReports command.params['userKey'] = user_key unless user_key.nil? @@ -622,7 +568,6 @@ module Google command.query['parameters'] = parameters unless parameters.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -631,7 +576,6 @@ module Google def apply_command_defaults(command) command.query['key'] = key unless key.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? end end end diff --git a/generated/google/apis/androidmanagement_v1.rb b/generated/google/apis/androidmanagement_v1.rb index 09fc266e2..04ca802cc 100644 --- a/generated/google/apis/androidmanagement_v1.rb +++ b/generated/google/apis/androidmanagement_v1.rb @@ -26,7 +26,7 @@ module Google # @see https://developers.google.com/android/management module AndroidmanagementV1 VERSION = 'V1' - REVISION = '20200803' + REVISION = '20200807' # Manage Android devices and apps for your customers AUTH_ANDROIDMANAGEMENT = 'https://www.googleapis.com/auth/androidmanagement' diff --git a/generated/google/apis/androidmanagement_v1/classes.rb b/generated/google/apis/androidmanagement_v1/classes.rb index 4ed2202d3..400b0496f 100644 --- a/generated/google/apis/androidmanagement_v1/classes.rb +++ b/generated/google/apis/androidmanagement_v1/classes.rb @@ -234,6 +234,12 @@ module Google # @return [Array] 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, # 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. @@ -268,13 +274,9 @@ module Google # Managed configuration applied to the app. The format for the configuration is # dictated by the ManagedProperty values supported by the app. Each field name # in the managed configuration must match the key field of the ManagedProperty. - # The field value must be compatible with the type of the ManagedProperty: < - # table> typeJSON value BOOLtrue or false STRINGstring - # INTEGERnumber CHOICEstring < - # td>MULTISELECTarray of strings HIDDEN - # string BUNDLE_ARRAYarray of objects + # The field value must be compatible with the type of the ManagedProperty: *type* + # *JSON value* BOOL true or false STRING string INTEGER number CHOICE string + # MULTISELECT array of strings HIDDEN string BUNDLE_ARRAY array of objects # Corresponds to the JSON property `managedConfiguration` # @return [Hash] attr_accessor :managed_configuration @@ -314,6 +316,7 @@ module Google # Update properties of this object def update!(**args) @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) @delegated_scopes = args[:delegated_scopes] if args.key?(:delegated_scopes) @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 # and time zone are either specified elsewhere or are not significant. The date - # is relative to the Proleptic Gregorian Calendar. This can represent: - # A full date, with non-zero year, month and day values - # A month and day value, with a zero year, e.g. an anniversary - # A year on its own, with zero month and day values - # A year and month value, with a zero day, e.g. a credit card expiration + # is relative to the Proleptic Gregorian Calendar. This can represent: A full + # date, with non-zero year, month and day values A month and day value, with a + # zero year, e.g. an anniversary A year on its own, with zero month and day + # values A year and month value, with a zero day, e.g. a credit card expiration # dateRelated types are google.type.TimeOfDay and google.protobuf.Timestamp. class Date 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 # messages in your APIs. A typical example is to use it as the request or the - # response type of an API method. For instance: - # service Foo ` - # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); - # ` - # The JSON representation for Empty is empty JSON object ``. + # response type of an API method. For instance: service Foo ` rpc Bar(google. + # protobuf.Empty) returns (google.protobuf.Empty); ` The JSON representation for + # Empty is empty JSON object ``. class Empty include Google::Apis::Core::Hashable @@ -1248,11 +1248,10 @@ module Google # Represents a whole or partial calendar date, e.g. a birthday. The time of day # and time zone are either specified elsewhere or are not significant. The date - # is relative to the Proleptic Gregorian Calendar. This can represent: - # A full date, with non-zero year, month and day values - # A month and day value, with a zero year, e.g. an anniversary - # A year on its own, with zero month and day values - # A year and month value, with a zero day, e.g. a credit card expiration + # is relative to the Proleptic Gregorian Calendar. This can represent: A full + # date, with non-zero year, month and day values A month and day value, with a + # zero year, e.g. an anniversary A year on its own, with zero month and day + # values A year and month value, with a zero day, e.g. a credit card expiration # dateRelated types are google.type.TimeOfDay and google.protobuf.Timestamp. # Corresponds to the JSON property `endDate` # @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 # and time zone are either specified elsewhere or are not significant. The date - # is relative to the Proleptic Gregorian Calendar. This can represent: - # A full date, with non-zero year, month and day values - # A month and day value, with a zero year, e.g. an anniversary - # A year on its own, with zero month and day values - # A year and month value, with a zero day, e.g. a credit card expiration + # is relative to the Proleptic Gregorian Calendar. This can represent: A full + # date, with non-zero year, month and day values A month and day value, with a + # zero year, e.g. an anniversary A year on its own, with zero month and day + # values A year and month value, with a zero day, e.g. a credit card expiration # dateRelated types are google.type.TimeOfDay and google.protobuf.Timestamp. # Corresponds to the JSON property `startDate` # @return [Google::Apis::AndroidmanagementV1::Date] @@ -1669,8 +1667,8 @@ module Google class ManagedConfigurationTemplate include Google::Apis::Core::Hashable - # Optional, a map containing configuration variables defined for - # the configuration. + # Optional, a map containing configuration variables defined for the + # configuration. # Corresponds to the JSON property `configurationVariables` # @return [Hash] attr_accessor :configuration_variables @@ -1884,8 +1882,8 @@ module Google # compliance, this specifies the full path to the offending field. The path is # formatted in the same way the policy JSON field would be referenced in # JavaScript, that is: 1) For object-typed fields, the field name is followed by - # a dot then by a subfield name. 2) For array-typed fields, the field name is - # followed by the array index enclosed in brackets. For example, to indicate a + # a dot then by a subfield name. 2) For array-typed fields, the field name is + # followed by the array index enclosed in brackets. For example, to indicate a # problem with the url field in the externalData field in the 3rd application, # the path would be applications[2].externalData.url # Corresponds to the JSON property `fieldPath` @@ -1909,7 +1907,7 @@ module Google attr_accessor :package_name # The name of the policy setting. This is the JSON field name of a top-level - # Policy field. + # Policy field. # Corresponds to the JSON property `settingName` # @return [String] attr_accessor :setting_name @@ -3098,13 +3096,12 @@ module Google include Google::Apis::Core::Hashable # Controls whether personal usage is allowed on a device provisioned with this - # enrollment token.For company-owned devices: - # Enabling personal usage allows the user to set up a work profile on the device. - # Disabling personal usage requires the user provision the device as a fully - # managed device.For personally-owned devices: - # Enabling personal usage allows the user to set up a work profile on the device. - # Disabling personal usage will prevent the device from provisioning. Personal - # usage cannot be disabled on personally-owned device. + # enrollment token.For company-owned devices: Enabling personal usage allows the + # user to set up a work profile on the device. Disabling personal usage requires + # the user provision the device as a fully managed device.For personally-owned + # devices: Enabling personal usage allows the user to set up a work profile on + # the device. Disabling personal usage will prevent the device from provisioning. + # Personal usage cannot be disabled on personally-owned device. # Corresponds to the JSON property `allowPersonalUsage` # @return [String] attr_accessor :allow_personal_usage @@ -3125,9 +3122,9 @@ module Google # Sign-in URL for authentication when device is provisioned with a sign-in # enrollment token. The sign-in endpoint should finish authentication flow with - # a URL in the form of https://enterprise.google.com/android/enroll?et= - # for a successful login, or https://enterprise.google.com/android/enroll/ - # invalid for a failed login. + # a URL in the form of https://enterprise.google.com/android/enroll?et= for a + # successful login, or https://enterprise.google.com/android/enroll/invalid for + # a failed login. # Corresponds to the JSON property `signinUrl` # @return [String] attr_accessor :signin_url @@ -3482,9 +3479,9 @@ module Google # @return [String] attr_accessor :default_message - # A map containing pairs, where locale is a well-formed BCP 47 - # language (https://www.w3.org/International/articles/language-tags/) code, such - # as en-US, es-ES, or fr. + # A map containing pairs, where locale is a well-formed BCP 47 language (https:// + # www.w3.org/International/articles/language-tags/) code, such as en-US, es-ES, + # or fr. # Corresponds to the JSON property `localizedMessages` # @return [Hash] attr_accessor :localized_messages @@ -3559,9 +3556,9 @@ module Google include Google::Apis::Core::Hashable # 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").
  • - # The image type can be png or jpg.
  • The image should ideally be square.
  • - # The image should ideally have a size of 512x512.
+ # section 5 "Base 64 Encoding with URL and Filename Safe Alphabet"). - The image + # type can be png or jpg. - The image should ideally be square. - The image + # should ideally have a size of 512x512. # Corresponds to the JSON property `imageData` # @return [String] attr_accessor :image_data @@ -3582,10 +3579,10 @@ module Google # 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 - # to note:
  • If no features are listed here, all features are enabled — - # this is the default behavior where you give access to all features to your - # admins.
  • This must not contain any FEATURE_UNSPECIFIED values.
  • - # Repeated values are ignored
+ # to note: - If no features are listed here, all features are enabled — this is + # the default behavior where you give access to all features to your admins. - + # This must not contain any FEATURE_UNSPECIFIED values. - Repeated values are + # ignored # Corresponds to the JSON property `enabledFeatures` # @return [Array] attr_accessor :enabled_features diff --git a/generated/google/apis/androidmanagement_v1/representations.rb b/generated/google/apis/androidmanagement_v1/representations.rb index ac97ab3dd..f12334699 100644 --- a/generated/google/apis/androidmanagement_v1/representations.rb +++ b/generated/google/apis/androidmanagement_v1/representations.rb @@ -489,6 +489,7 @@ module Google # @private class Representation < Google::Apis::Core::JsonRepresentation collection :accessible_track_ids, as: 'accessibleTrackIds' + property :connected_work_and_personal_app, as: 'connectedWorkAndPersonalApp' property :default_permission_policy, as: 'defaultPermissionPolicy' collection :delegated_scopes, as: 'delegatedScopes' property :disabled, as: 'disabled' diff --git a/generated/google/apis/clouderrorreporting_v1beta1.rb b/generated/google/apis/clouderrorreporting_v1beta1.rb index c025c3fec..8ba4890a0 100644 --- a/generated/google/apis/clouderrorreporting_v1beta1.rb +++ b/generated/google/apis/clouderrorreporting_v1beta1.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/error-reporting/ module ClouderrorreportingV1beta1 VERSION = 'V1beta1' - REVISION = '20200723' + REVISION = '20200806' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/clouderrorreporting_v1beta1/classes.rb b/generated/google/apis/clouderrorreporting_v1beta1/classes.rb index 07487271e..c02de06d1 100644 --- a/generated/google/apis/clouderrorreporting_v1beta1/classes.rb +++ b/generated/google/apis/clouderrorreporting_v1beta1/classes.rb @@ -35,43 +35,39 @@ module Google end end - # A description of the context in which an error occurred. - # This data should be provided by the application when reporting an error, - # unless the - # error report has been generated automatically from Google App Engine logs. + # A description of the context in which an error occurred. This data should be + # provided by the application when reporting an error, unless the error report + # has been generated automatically from Google App Engine logs. class ErrorContext include Google::Apis::Core::Hashable - # HTTP request data that is related to a reported error. - # This data should be provided by the application when reporting an error, - # unless the - # error report has been generated automatically from Google App Engine logs. + # HTTP request data that is related to a reported error. This data should be + # provided by the application when reporting an error, unless the error report + # has been generated automatically from Google App Engine logs. # Corresponds to the JSON property `httpRequest` # @return [Google::Apis::ClouderrorreportingV1beta1::HttpRequestContext] attr_accessor :http_request # Indicates a location in the source code of the service for which errors are - # reported. `functionName` must be provided by the application when reporting - # an error, unless the error report contains a `message` with a supported - # exception stack trace. All fields are optional for the later case. + # reported. `functionName` must be provided by the application when reporting an + # error, unless the error report contains a `message` with a supported exception + # stack trace. All fields are optional for the later case. # Corresponds to the JSON property `reportLocation` # @return [Google::Apis::ClouderrorreportingV1beta1::SourceLocation] attr_accessor :report_location - # Source code that was used to build the executable which has - # caused the given error message. + # Source code that was used to build the executable which has caused the given + # error message. # Corresponds to the JSON property `sourceReferences` # @return [Array] attr_accessor :source_references - # The user who caused or was affected by the crash. - # This can be a user ID, an email address, or an arbitrary token that - # uniquely identifies the user. - # When sending an error report, leave this field empty if the user was not - # logged in. In this case the - # Error Reporting system will use other data, such as remote IP address, to - # distinguish affected users. See `affected_users_count` in - # `ErrorGroupStats`. + # The user who caused or was affected by the crash. This can be a user ID, an + # email address, or an arbitrary token that uniquely identifies the user. When + # sending an error report, leave this field empty if the user was not logged in. + # In this case the Error Reporting system will use other data, such as remote IP + # address, to distinguish affected users. See `affected_users_count` in ` + # ErrorGroupStats`. # Corresponds to the JSON property `user` # @return [String] attr_accessor :user @@ -93,17 +89,16 @@ module Google class ErrorEvent include Google::Apis::Core::Hashable - # A description of the context in which an error occurred. - # This data should be provided by the application when reporting an error, - # unless the - # error report has been generated automatically from Google App Engine logs. + # A description of the context in which an error occurred. This data should be + # provided by the application when reporting an error, unless the error report + # has been generated automatically from Google App Engine logs. # Corresponds to the JSON property `context` # @return [Google::Apis::ClouderrorreportingV1beta1::ErrorContext] attr_accessor :context - # Time when the event occurred as provided in the error report. - # If the report did not contain a timestamp, the time the error was received - # by the Error Reporting system is used. + # Time when the event occurred as provided in the error report. If the report + # did not contain a timestamp, the time the error was received by the Error + # Reporting system is used. # Corresponds to the JSON property `eventTime` # @return [String] attr_accessor :event_time @@ -113,8 +108,8 @@ module Google # @return [String] attr_accessor :message - # Describes a running service that sends errors. - # Its version changes over time and multiple versions can run in parallel. + # Describes a running service that sends errors. Its version changes over time + # and multiple versions can run in parallel. # Corresponds to the JSON property `serviceContext` # @return [Google::Apis::ClouderrorreportingV1beta1::ServiceContext] attr_accessor :service_context @@ -136,20 +131,20 @@ module Google class ErrorGroup include Google::Apis::Core::Hashable - # Group IDs are unique for a given project. If the same kind of error - # occurs in different service contexts, it will receive the same group ID. + # Group IDs are unique for a given project. If the same kind of error occurs in + # different service contexts, it will receive the same group ID. # Corresponds to the JSON property `groupId` # @return [String] attr_accessor :group_id - # The group resource name. - # Example: projects/my-project-123/groups/CNSgkpnppqKCUw + # The group resource name. Example: projects/my-project-123/groups/ + # CNSgkpnppqKCUw # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Error group's resolution status. - # An unspecified resolution status will be interpreted as OPEN + # Error group's resolution status. An unspecified resolution status will be + # interpreted as OPEN # Corresponds to the JSON property `resolutionStatus` # @return [String] attr_accessor :resolution_status @@ -172,43 +167,39 @@ module Google end end - # Data extracted for a specific group based on certain filter criteria, - # such as a given time period and/or service filter. + # Data extracted for a specific group based on certain filter criteria, such as + # a given time period and/or service filter. class ErrorGroupStats include Google::Apis::Core::Hashable - # Service contexts with a non-zero error count for the given filter - # criteria. This list can be truncated if multiple services are affected. - # Refer to `num_affected_services` for the total count. + # Service contexts with a non-zero error count for the given filter criteria. + # This list can be truncated if multiple services are affected. Refer to ` + # num_affected_services` for the total count. # Corresponds to the JSON property `affectedServices` # @return [Array] attr_accessor :affected_services - # Approximate number of affected users in the given group that - # match the filter criteria. - # Users are distinguished by data in the `ErrorContext` of the - # individual error events, such as their login name or their remote - # IP address in case of HTTP requests. - # The number of affected users can be zero even if the number of - # errors is non-zero if no data was provided from which the - # affected user could be deduced. - # Users are counted based on data in the request - # context that was provided in the error report. If more users are - # implicitly affected, such as due to a crash of the whole service, - # this is not reflected here. + # Approximate number of affected users in the given group that match the filter + # criteria. Users are distinguished by data in the `ErrorContext` of the + # individual error events, such as their login name or their remote IP address + # in case of HTTP requests. The number of affected users can be zero even if the + # number of errors is non-zero if no data was provided from which the affected + # user could be deduced. Users are counted based on data in the request context + # that was provided in the error report. If more users are implicitly affected, + # such as due to a crash of the whole service, this is not reflected here. # Corresponds to the JSON property `affectedUsersCount` # @return [Fixnum] attr_accessor :affected_users_count - # Approximate total number of events in the given group that match - # the filter criteria. + # Approximate total number of events in the given group that match the filter + # criteria. # Corresponds to the JSON property `count` # @return [Fixnum] attr_accessor :count - # Approximate first occurrence that was ever seen for this group - # and which matches the given filter criteria, ignoring the - # time_range that was specified in the request. + # Approximate first occurrence that was ever seen for this group and which + # matches the given filter criteria, ignoring the time_range that was specified + # in the request. # Corresponds to the JSON property `firstSeenTime` # @return [String] attr_accessor :first_seen_time @@ -218,15 +209,15 @@ module Google # @return [Google::Apis::ClouderrorreportingV1beta1::ErrorGroup] attr_accessor :group - # Approximate last occurrence that was ever seen for this group and - # which matches the given filter criteria, ignoring the time_range - # that was specified in the request. + # Approximate last occurrence that was ever seen for this group and which + # matches the given filter criteria, ignoring the time_range that was specified + # in the request. # Corresponds to the JSON property `lastSeenTime` # @return [String] attr_accessor :last_seen_time - # The total number of services with a non-zero error count for the given - # filter criteria. + # The total number of services with a non-zero error count for the given filter + # criteria. # Corresponds to the JSON property `numAffectedServices` # @return [Fixnum] attr_accessor :num_affected_services @@ -236,11 +227,9 @@ module Google # @return [Google::Apis::ClouderrorreportingV1beta1::ErrorEvent] attr_accessor :representative - # Approximate number of occurrences over time. - # Timed counts returned by ListGroups are guaranteed to be: - # - Inside the requested time interval - # - Non-overlapping, and - # - Ordered by ascending time. + # Approximate number of occurrences over time. Timed counts returned by + # ListGroups are guaranteed to be: - Inside the requested time interval - Non- + # overlapping, and - Ordered by ascending time. # Corresponds to the JSON property `timedCounts` # @return [Array] attr_accessor :timed_counts @@ -263,10 +252,9 @@ module Google end end - # HTTP request data that is related to a reported error. - # This data should be provided by the application when reporting an error, - # unless the - # error report has been generated automatically from Google App Engine logs. + # HTTP request data that is related to a reported error. This data should be + # provided by the application when reporting an error, unless the error report + # has been generated automatically from Google App Engine logs. class HttpRequestContext include Google::Apis::Core::Hashable @@ -280,10 +268,9 @@ module Google # @return [String] attr_accessor :referrer - # The IP address from which the request originated. - # This can be IPv4, IPv6, or a token which is derived from the - # IP address, depending on the data that has been provided - # in the error report. + # The IP address from which the request originated. This can be IPv4, IPv6, or a + # token which is derived from the IP address, depending on the data that has + # been provided in the error report. # Corresponds to the JSON property `remoteIp` # @return [String] attr_accessor :remote_ip @@ -327,9 +314,8 @@ module Google # @return [Array] attr_accessor :error_events - # If non-empty, more results are available. - # Pass this token, along with the same query parameters as the first - # request, to view the next page of results. + # If non-empty, more results are available. Pass this token, along with the same + # query parameters as the first request, to view the next page of results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -360,17 +346,16 @@ module Google # @return [Array] attr_accessor :error_group_stats - # If non-empty, more results are available. - # Pass this token, along with the same query parameters as the first - # request, to view the next page of results. + # If non-empty, more results are available. Pass this token, along with the same + # query parameters as the first request, to view the next page of results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # The timestamp specifies the start time to which the request was restricted. - # The start time is set based on the requested time range. It may be adjusted - # to a later time if a project has exceeded the storage quota and older data - # has been deleted. + # The start time is set based on the requested time range. It may be adjusted to + # a later time if a project has exceeded the storage quota and older data has + # been deleted. # Corresponds to the JSON property `timeRangeBegin` # @return [String] attr_accessor :time_range_begin @@ -387,8 +372,8 @@ module Google end end - # Response for reporting an individual error event. - # Data may be added to this message in the future. + # Response for reporting an individual error event. Data may be added to this + # message in the future. class ReportErrorEventResponse include Google::Apis::Core::Hashable @@ -405,54 +390,43 @@ module Google class ReportedErrorEvent include Google::Apis::Core::Hashable - # A description of the context in which an error occurred. - # This data should be provided by the application when reporting an error, - # unless the - # error report has been generated automatically from Google App Engine logs. + # A description of the context in which an error occurred. This data should be + # provided by the application when reporting an error, unless the error report + # has been generated automatically from Google App Engine logs. # Corresponds to the JSON property `context` # @return [Google::Apis::ClouderrorreportingV1beta1::ErrorContext] attr_accessor :context - # Optional. Time when the event occurred. - # If not provided, the time when the event was received by the - # Error Reporting system will be used. + # Optional. Time when the event occurred. If not provided, the time when the + # event was received by the Error Reporting system will be used. # Corresponds to the JSON property `eventTime` # @return [String] attr_accessor :event_time - # Required. The error message. - # If no `context.reportLocation` is provided, the message must contain a - # header (typically consisting of the exception type name and an error - # message) and an exception stack trace in one of the supported programming - # languages and formats. - # Supported languages are Java, Python, JavaScript, Ruby, C#, PHP, and Go. - # Supported stack trace formats are: - # * **Java**: Must be the return value of - # [`Throwable.printStackTrace()`](https://docs.oracle.com/javase/7/docs/api/java/ - # lang/Throwable.html#printStackTrace%28%29). - # * **Python**: Must be the return value of - # [`traceback.format_exc()`](https://docs.python.org/2/library/traceback.html# - # traceback.format_exc). - # * **JavaScript**: Must be the value of - # [`error.stack`](https://github.com/v8/v8/wiki/Stack-Trace-API) as returned - # by V8. - # * **Ruby**: Must contain frames returned by - # [`Exception.backtrace`](https://ruby-doc.org/core-2.2.0/Exception.html#method- - # i-backtrace). - # * **C#**: Must be the return value of - # [`Exception.ToString()`](https://msdn.microsoft.com/en-us/library/system. - # exception.tostring.aspx). - # * **PHP**: Must start with `PHP (Notice|Parse error|Fatal error|Warning)` - # and contain the result of - # [`(string)$exception`](http://php.net/manual/en/exception.tostring.php). - # * **Go**: Must be the return value of - # [`runtime.Stack()`](https://golang.org/pkg/runtime/debug/#Stack). + # Required. The error message. If no `context.reportLocation` is provided, the + # message must contain a header (typically consisting of the exception type name + # and an error message) and an exception stack trace in one of the supported + # programming languages and formats. Supported languages are Java, Python, + # JavaScript, Ruby, C#, PHP, and Go. Supported stack trace formats are: * **Java* + # *: Must be the return value of [`Throwable.printStackTrace()`](https://docs. + # oracle.com/javase/7/docs/api/java/lang/Throwable.html#printStackTrace%28%29). * + # **Python**: Must be the return value of [`traceback.format_exc()`](https:// + # docs.python.org/2/library/traceback.html#traceback.format_exc). * **JavaScript* + # *: Must be the value of [`error.stack`](https://github.com/v8/v8/wiki/Stack- + # Trace-API) as returned by V8. * **Ruby**: Must contain frames returned by [` + # Exception.backtrace`](https://ruby-doc.org/core-2.2.0/Exception.html#method-i- + # backtrace). * **C#**: Must be the return value of [`Exception.ToString()`]( + # https://msdn.microsoft.com/en-us/library/system.exception.tostring.aspx). * ** + # PHP**: Must start with `PHP (Notice|Parse error|Fatal error|Warning)` and + # contain the result of [`(string)$exception`](http://php.net/manual/en/ + # exception.tostring.php). * **Go**: Must be the return value of [`runtime.Stack( + # )`](https://golang.org/pkg/runtime/debug/#Stack). # Corresponds to the JSON property `message` # @return [String] attr_accessor :message - # Describes a running service that sends errors. - # Its version changes over time and multiple versions can run in parallel. + # Describes a running service that sends errors. Its version changes over time + # and multiple versions can run in parallel. # Corresponds to the JSON property `serviceContext` # @return [Google::Apis::ClouderrorreportingV1beta1::ServiceContext] attr_accessor :service_context @@ -470,33 +444,31 @@ module Google end end - # Describes a running service that sends errors. - # Its version changes over time and multiple versions can run in parallel. + # Describes a running service that sends errors. Its version changes over time + # and multiple versions can run in parallel. class ServiceContext include Google::Apis::Core::Hashable - # Type of the MonitoredResource. List of possible values: - # https://cloud.google.com/monitoring/api/resources - # Value is set automatically for incoming errors and must not be set when - # reporting errors. + # Type of the MonitoredResource. List of possible values: https://cloud.google. + # com/monitoring/api/resources Value is set automatically for incoming errors + # and must not be set when reporting errors. # Corresponds to the JSON property `resourceType` # @return [String] attr_accessor :resource_type - # An identifier of the service, such as the name of the - # executable, job, or Google App Engine service name. This field is expected - # to have a low number of values that are relatively stable over time, as - # opposed to `version`, which can be changed whenever new code is deployed. - # Contains the service name for error reports extracted from Google - # App Engine logs or `default` if the App Engine default service is used. + # An identifier of the service, such as the name of the executable, job, or + # Google App Engine service name. This field is expected to have a low number of + # values that are relatively stable over time, as opposed to `version`, which + # can be changed whenever new code is deployed. Contains the service name for + # error reports extracted from Google App Engine logs or `default` if the App + # Engine default service is used. # Corresponds to the JSON property `service` # @return [String] attr_accessor :service - # Represents the source code version that the developer provided, - # which could represent a version label or a Git SHA-1 hash, for example. - # For App Engine standard environment, the version is set to the version of - # the app. + # Represents the source code version that the developer provided, which could + # represent a version label or a Git SHA-1 hash, for example. For App Engine + # standard environment, the version is set to the version of the app. # Corresponds to the JSON property `version` # @return [String] attr_accessor :version @@ -514,21 +486,21 @@ module Google end # Indicates a location in the source code of the service for which errors are - # reported. `functionName` must be provided by the application when reporting - # an error, unless the error report contains a `message` with a supported - # exception stack trace. All fields are optional for the later case. + # reported. `functionName` must be provided by the application when reporting an + # error, unless the error report contains a `message` with a supported exception + # stack trace. All fields are optional for the later case. class SourceLocation include Google::Apis::Core::Hashable - # The source code filename, which can include a truncated relative - # path, or a full path from a production machine. + # The source code filename, which can include a truncated relative path, or a + # full path from a production machine. # Corresponds to the JSON property `filePath` # @return [String] attr_accessor :file_path - # Human-readable name of a function or method. - # The value can include optional context like the class or package name. - # For example, `my.package.MyClass.method` in case of Java. + # Human-readable name of a function or method. The value can include optional + # context like the class or package name. For example, `my.package.MyClass. + # method` in case of Java. # Corresponds to the JSON property `functionName` # @return [String] attr_accessor :function_name @@ -555,14 +527,14 @@ module Google class SourceReference include Google::Apis::Core::Hashable - # Optional. A URI string identifying the repository. - # Example: "https://github.com/GoogleCloudPlatform/kubernetes.git" + # Optional. A URI string identifying the repository. Example: "https://github. + # com/GoogleCloudPlatform/kubernetes.git" # Corresponds to the JSON property `repository` # @return [String] attr_accessor :repository - # The canonical and persistent identifier of the deployed revision. - # Example (git): "0035781c50ec7aa23385dc841529ce8a4b70db1b" + # The canonical and persistent identifier of the deployed revision. Example (git) + # : "0035781c50ec7aa23385dc841529ce8a4b70db1b" # Corresponds to the JSON property `revisionId` # @return [String] attr_accessor :revision_id @@ -578,9 +550,8 @@ module Google end end - # The number of errors in a given time period. - # All numbers are approximate since the error events are sampled - # before counting them. + # The number of errors in a given time period. All numbers are approximate since + # the error events are sampled before counting them. class TimedCount include Google::Apis::Core::Hashable @@ -615,8 +586,8 @@ module Google class TrackingIssue include Google::Apis::Core::Hashable - # A URL pointing to a related entry in an issue tracking system. - # Example: `https://github.com/user/project/issues/4` + # A URL pointing to a related entry in an issue tracking system. Example: `https: + # //github.com/user/project/issues/4` # Corresponds to the JSON property `url` # @return [String] attr_accessor :url diff --git a/generated/google/apis/clouderrorreporting_v1beta1/service.rb b/generated/google/apis/clouderrorreporting_v1beta1/service.rb index ee233a699..c69f44310 100644 --- a/generated/google/apis/clouderrorreporting_v1beta1/service.rb +++ b/generated/google/apis/clouderrorreporting_v1beta1/service.rb @@ -50,11 +50,10 @@ module Google # Deletes all error events of a given project. # @param [String] project_name - # Required. The resource name of the Google Cloud Platform project. Written - # as `projects/`projectID``, where ``projectID`` is the - # [Google Cloud Platform project - # ID](https://support.google.com/cloud/answer/6158840). - # Example: `projects/my-project-123`. + # Required. The resource name of the Google Cloud Platform project. Written as ` + # projects/`projectID``, where ``projectID`` is the [Google Cloud Platform + # project ID](https://support.google.com/cloud/answer/6158840). Example: ` + # projects/my-project-123`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -84,11 +83,10 @@ module Google # Lists the specified events. # @param [String] project_name - # Required. The resource name of the Google Cloud Platform project. Written - # as `projects/`projectID``, where ``projectID`` is the - # [Google Cloud Platform project - # ID](https://support.google.com/cloud/answer/6158840). - # Example: `projects/my-project-123`. + # Required. The resource name of the Google Cloud Platform project. Written as ` + # projects/`projectID``, where ``projectID`` is the [Google Cloud Platform + # project ID](https://support.google.com/cloud/answer/6158840). Example: ` + # projects/my-project-123`. # @param [String] group_id # Required. The group for which events shall be returned. # @param [Fixnum] page_size @@ -96,17 +94,14 @@ module Google # @param [String] page_token # Optional. A `next_page_token` provided by a previous response. # @param [String] service_filter_resource_type - # Optional. The exact value to match against - # [`ServiceContext.resource_type`](/error-reporting/reference/rest/v1beta1/ - # ServiceContext#FIELDS.resource_type). + # Optional. The exact value to match against [`ServiceContext.resource_type`](/ + # error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.resource_type). # @param [String] service_filter_service - # Optional. The exact value to match against - # [`ServiceContext.service`](/error-reporting/reference/rest/v1beta1/ - # ServiceContext#FIELDS.service). + # Optional. The exact value to match against [`ServiceContext.service`](/error- + # reporting/reference/rest/v1beta1/ServiceContext#FIELDS.service). # @param [String] service_filter_version - # Optional. The exact value to match against - # [`ServiceContext.version`](/error-reporting/reference/rest/v1beta1/ - # ServiceContext#FIELDS.version). + # Optional. The exact value to match against [`ServiceContext.version`](/error- + # reporting/reference/rest/v1beta1/ServiceContext#FIELDS.version). # @param [String] time_range_period # Restricts the query to the specified time range. # @param [String] fields @@ -143,20 +138,16 @@ module Google execute_or_queue_command(command, &block) end - # Report an individual error event. - # This endpoint accepts **either** an OAuth token, - # **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 `key` parameter. For example: - # `POST - # https://clouderrorreporting.googleapis.com/v1beta1/`projectName`/events:report? - # key=123ABC456` + # Report an individual error event. This endpoint accepts **either** an OAuth + # token, **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 ` + # key` parameter. For example: `POST https://clouderrorreporting.googleapis.com/ + # v1beta1/`projectName`/events:report?key=123ABC456` # @param [String] project_name - # Required. The resource name of the Google Cloud Platform project. Written - # as `projects/`projectId``, where ``projectId`` is the - # [Google Cloud Platform project - # ID](https://support.google.com/cloud/answer/6158840). - # Example: // `projects/my-project-123`. + # Required. The resource name of the Google Cloud Platform project. Written as ` + # projects/`projectId``, where ``projectId`` is the [Google Cloud Platform + # project ID](https://support.google.com/cloud/answer/6158840). Example: // ` + # projects/my-project-123`. # @param [Google::Apis::ClouderrorreportingV1beta1::ReportedErrorEvent] reported_error_event_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -189,46 +180,41 @@ module Google # Lists the specified groups. # @param [String] project_name - # Required. The resource name of the Google Cloud Platform project. Written - # as `projects/`projectID``, where ``projectID`` is the - # [Google Cloud Platform project - # ID](https://support.google.com/cloud/answer/6158840). - # Example: `projects/my-project-123`. + # Required. The resource name of the Google Cloud Platform project. Written as ` + # projects/`projectID``, where ``projectID`` is the [Google Cloud Platform + # project ID](https://support.google.com/cloud/answer/6158840). Example: ` + # projects/my-project-123`. # @param [String] alignment - # Optional. The alignment of the timed counts to be returned. - # Default is `ALIGNMENT_EQUAL_AT_END`. + # Optional. The alignment of the timed counts to be returned. Default is ` + # ALIGNMENT_EQUAL_AT_END`. # @param [String] alignment_time - # Optional. Time where the timed counts shall be aligned if rounded - # alignment is chosen. Default is 00:00 UTC. + # Optional. Time where the timed counts shall be aligned if rounded alignment is + # chosen. Default is 00:00 UTC. # @param [Array, String] group_id - # Optional. List all ErrorGroupStats with these IDs. + # Optional. List all ErrorGroupStats with these IDs. # @param [String] order - # Optional. The sort order in which the results are returned. - # Default is `COUNT_DESC`. + # Optional. The sort order in which the results are returned. Default is ` + # COUNT_DESC`. # @param [Fixnum] page_size - # Optional. The maximum number of results to return per response. - # Default is 20. + # Optional. The maximum number of results to return per response. Default is 20. # @param [String] page_token # Optional. A `next_page_token` provided by a previous response. To view - # additional results, pass this token along with the identical query - # parameters as the first request. + # additional results, pass this token along with the identical query parameters + # as the first request. # @param [String] service_filter_resource_type - # Optional. The exact value to match against - # [`ServiceContext.resource_type`](/error-reporting/reference/rest/v1beta1/ - # ServiceContext#FIELDS.resource_type). + # Optional. The exact value to match against [`ServiceContext.resource_type`](/ + # error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.resource_type). # @param [String] service_filter_service - # Optional. The exact value to match against - # [`ServiceContext.service`](/error-reporting/reference/rest/v1beta1/ - # ServiceContext#FIELDS.service). + # Optional. The exact value to match against [`ServiceContext.service`](/error- + # reporting/reference/rest/v1beta1/ServiceContext#FIELDS.service). # @param [String] service_filter_version - # Optional. The exact value to match against - # [`ServiceContext.version`](/error-reporting/reference/rest/v1beta1/ - # ServiceContext#FIELDS.version). + # Optional. The exact value to match against [`ServiceContext.version`](/error- + # reporting/reference/rest/v1beta1/ServiceContext#FIELDS.version). # @param [String] time_range_period # Restricts the query to the specified time range. # @param [String] timed_count_duration - # Optional. The preferred duration for a single returned `TimedCount`. - # If not set, no timed counts are returned. + # Optional. The preferred duration for a single returned `TimedCount`. If not + # set, no timed counts are returned. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -269,12 +255,11 @@ module Google # Get the specified group. # @param [String] group_name - # Required. The group resource name. Written as - # `projects/`projectID`/groups/`group_name``. Call - # [`groupStats.list`](https://cloud.google.com/error-reporting/reference/rest/ - # v1beta1/projects.groupStats/list) - # to return a list of groups belonging to this project. - # Example: `projects/my-project-123/groups/my-group` + # Required. The group resource name. Written as `projects/`projectID`/groups/` + # group_name``. Call [`groupStats.list`](https://cloud.google.com/error- + # reporting/reference/rest/v1beta1/projects.groupStats/list) to return a list of + # groups belonging to this project. Example: `projects/my-project-123/groups/my- + # group` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -302,11 +287,10 @@ module Google execute_or_queue_command(command, &block) end - # Replace the data for the specified group. - # Fails if the group does not exist. + # Replace the data for the specified group. Fails if the group does not exist. # @param [String] name - # The group resource name. - # Example: projects/my-project-123/groups/CNSgkpnppqKCUw + # The group resource name. Example: projects/my-project-123/groups/ + # CNSgkpnppqKCUw # @param [Google::Apis::ClouderrorreportingV1beta1::ErrorGroup] error_group_object # @param [String] fields # Selector specifying which fields to include in a partial response. diff --git a/generated/google/apis/docs_v1.rb b/generated/google/apis/docs_v1.rb index 32e7f5ec6..0afbe419e 100644 --- a/generated/google/apis/docs_v1.rb +++ b/generated/google/apis/docs_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/docs/ module DocsV1 VERSION = 'V1' - REVISION = '20200221' + REVISION = '20200803' # View and manage your Google Docs documents AUTH_DOCUMENTS = 'https://www.googleapis.com/auth/documents' diff --git a/generated/google/apis/docs_v1/classes.rb b/generated/google/apis/docs_v1/classes.rb index 5e4a68aff..74733a3a9 100644 --- a/generated/google/apis/docs_v1/classes.rb +++ b/generated/google/apis/docs_v1/classes.rb @@ -22,21 +22,19 @@ module Google module Apis module DocsV1 - # A ParagraphElement representing a - # spot in the text that is dynamically replaced with content that can change - # over time, like a page number. + # A ParagraphElement representing a spot in the text that is dynamically + # replaced with content that can change over time, like a page number. class AutoText include Google::Apis::Core::Hashable - # The suggested deletion IDs. If empty, then there are no suggested deletions - # of this content. + # The suggested deletion IDs. If empty, then there are no suggested deletions of + # this content. # Corresponds to the JSON property `suggestedDeletionIds` # @return [Array] attr_accessor :suggested_deletion_ids - # The suggested insertion IDs. An AutoText - # may have multiple insertion IDs if it is a nested suggested change. If - # empty, then this is not a suggested insertion. + # The suggested insertion IDs. An AutoText may have multiple insertion IDs if it + # is a nested suggested change. If empty, then this is not a suggested insertion. # Corresponds to the JSON property `suggestedInsertionIds` # @return [Array] attr_accessor :suggested_insertion_ids @@ -46,20 +44,16 @@ module Google # @return [Hash] attr_accessor :suggested_text_style_changes - # Represents the styling that can be applied to text. - # Inherited text styles are represented as unset fields in this message. A - # text style's parent depends on where the text style is defined: - # * The TextStyle of text in a Paragraph - # inherits from the paragraph's corresponding named style type. - # * The TextStyle on a named style - # inherits from the normal text named style. - # * The TextStyle of the normal text named style inherits - # from the default text style in the Docs editor. - # * The TextStyle on a Paragraph element - # that is contained in a table may inherit its text style from the table - # style. - # If the text style does not inherit from a parent, unsetting fields will - # revert the style to a value matching the defaults in the Docs editor. + # Represents the styling that can be applied to text. Inherited text styles are + # represented as unset fields in this message. A text style's parent depends on + # where the text style is defined: * The TextStyle of text in a Paragraph + # inherits from the paragraph's corresponding named style type. * The TextStyle + # on a named style inherits from the normal text named style. * The TextStyle of + # the normal text named style inherits from the default text style in the Docs + # editor. * The TextStyle on a Paragraph element that is contained in a table + # may inherit its text style from the table style. If the text style does not + # inherit from a parent, unsetting fields will revert the style to a value + # matching the defaults in the Docs editor. # Corresponds to the JSON property `textStyle` # @return [Google::Apis::DocsV1::TextStyle] attr_accessor :text_style @@ -103,8 +97,8 @@ module Google end # A mask that indicates which of the fields on the base Background have been - # changed in this suggestion. - # For any field set to true, the Backgound has a new suggested value. + # changed in this suggestion. For any field set to true, the Backgound has a new + # suggested value. class BackgroundSuggestionState include Google::Apis::Core::Hashable @@ -159,8 +153,8 @@ module Google # @return [String] attr_accessor :document_id - # The reply of the updates. This maps 1:1 with the updates, although replies - # to some requests may be empty. + # The reply of the updates. This maps 1:1 with the updates, although replies to + # some requests may be empty. # Corresponds to the JSON property `replies` # @return [Array] attr_accessor :replies @@ -182,15 +176,12 @@ module Google end end - # The document body. - # The body typically contains the full document contents except for - # headers, footers - # and footnotes. + # The document body. The body typically contains the full document contents + # except for headers, footers and footnotes. class Body include Google::Apis::Core::Hashable - # The contents of the body. - # The indexes for the body's content begin at zero. + # The contents of the body. The indexes for the body's content begin at zero. # Corresponds to the JSON property `content` # @return [Array] attr_accessor :content @@ -219,20 +210,16 @@ module Google # @return [Fixnum] attr_accessor :nesting_level - # Represents the styling that can be applied to text. - # Inherited text styles are represented as unset fields in this message. A - # text style's parent depends on where the text style is defined: - # * The TextStyle of text in a Paragraph - # inherits from the paragraph's corresponding named style type. - # * The TextStyle on a named style - # inherits from the normal text named style. - # * The TextStyle of the normal text named style inherits - # from the default text style in the Docs editor. - # * The TextStyle on a Paragraph element - # that is contained in a table may inherit its text style from the table - # style. - # If the text style does not inherit from a parent, unsetting fields will - # revert the style to a value matching the defaults in the Docs editor. + # Represents the styling that can be applied to text. Inherited text styles are + # represented as unset fields in this message. A text style's parent depends on + # where the text style is defined: * The TextStyle of text in a Paragraph + # inherits from the paragraph's corresponding named style type. * The TextStyle + # on a named style inherits from the normal text named style. * The TextStyle of + # the normal text named style inherits from the default text style in the Docs + # editor. * The TextStyle on a Paragraph element that is contained in a table + # may inherit its text style from the table style. If the text style does not + # inherit from a parent, unsetting fields will revert the style to a value + # matching the defaults in the Docs editor. # Corresponds to the JSON property `textStyle` # @return [Google::Apis::DocsV1::TextStyle] attr_accessor :text_style @@ -249,29 +236,26 @@ module Google end end - # A mask that indicates which of the fields on the base - # Bullet have been changed in this suggestion. - # For any field set to true, there is a new suggested value. + # A mask that indicates which of the fields on the base Bullet have been changed + # in this suggestion. For any field set to true, there is a new suggested value. class BulletSuggestionState include Google::Apis::Core::Hashable - # Indicates if there was a suggested change to the - # list_id. + # Indicates if there was a suggested change to the list_id. # Corresponds to the JSON property `listIdSuggested` # @return [Boolean] attr_accessor :list_id_suggested alias_method :list_id_suggested?, :list_id_suggested - # Indicates if there was a suggested change to the - # nesting_level. + # Indicates if there was a suggested change to the nesting_level. # Corresponds to the JSON property `nestingLevelSuggested` # @return [Boolean] attr_accessor :nesting_level_suggested alias_method :nesting_level_suggested?, :nesting_level_suggested # A mask that indicates which of the fields on the base TextStyle have been - # changed in this suggestion. - # For any field set to true, there is a new suggested value. + # changed in this suggestion. For any field set to true, there is a new + # suggested value. # Corresponds to the JSON property `textStyleSuggestionState` # @return [Google::Apis::DocsV1::TextStyleSuggestionState] attr_accessor :text_style_suggestion_state @@ -307,46 +291,39 @@ module Google end end - # A ParagraphElement representing a - # column break. A column break makes the subsequent text start at the top of - # the next column. + # A ParagraphElement representing a column break. A column break makes the + # subsequent text start at the top of the next column. class ColumnBreak include Google::Apis::Core::Hashable - # The suggested deletion IDs. If empty, then there are no suggested deletions - # of this content. + # The suggested deletion IDs. If empty, then there are no suggested deletions of + # this content. # Corresponds to the JSON property `suggestedDeletionIds` # @return [Array] attr_accessor :suggested_deletion_ids # The suggested insertion IDs. A ColumnBreak may have multiple insertion IDs if - # it is - # a nested suggested change. If empty, then this is not a suggested + # it is a nested suggested change. If empty, then this is not a suggested # insertion. # Corresponds to the JSON property `suggestedInsertionIds` # @return [Array] attr_accessor :suggested_insertion_ids - # The suggested text style changes to this ColumnBreak, keyed by suggestion - # ID. + # The suggested text style changes to this ColumnBreak, keyed by suggestion ID. # Corresponds to the JSON property `suggestedTextStyleChanges` # @return [Hash] attr_accessor :suggested_text_style_changes - # Represents the styling that can be applied to text. - # Inherited text styles are represented as unset fields in this message. A - # text style's parent depends on where the text style is defined: - # * The TextStyle of text in a Paragraph - # inherits from the paragraph's corresponding named style type. - # * The TextStyle on a named style - # inherits from the normal text named style. - # * The TextStyle of the normal text named style inherits - # from the default text style in the Docs editor. - # * The TextStyle on a Paragraph element - # that is contained in a table may inherit its text style from the table - # style. - # If the text style does not inherit from a parent, unsetting fields will - # revert the style to a value matching the defaults in the Docs editor. + # Represents the styling that can be applied to text. Inherited text styles are + # represented as unset fields in this message. A text style's parent depends on + # where the text style is defined: * The TextStyle of text in a Paragraph + # inherits from the paragraph's corresponding named style type. * The TextStyle + # on a named style inherits from the normal text named style. * The TextStyle of + # the normal text named style inherits from the default text style in the Docs + # editor. * The TextStyle on a Paragraph element that is contained in a table + # may inherit its text style from the table style. If the text style does not + # inherit from a parent, unsetting fields will revert the style to a value + # matching the defaults in the Docs editor. # Corresponds to the JSON property `textStyle` # @return [Google::Apis::DocsV1::TextStyle] attr_accessor :text_style @@ -364,12 +341,10 @@ module Google end end - # Creates a Footer. The new footer is applied to - # the SectionStyle at the location of the - # SectionBreak if specificed, otherwise - # it is applied to the DocumentStyle. - # If a footer of the specified type already exists, a 400 bad request error - # is returned. + # Creates a Footer. The new footer is applied to the SectionStyle at the + # location of the SectionBreak if specificed, otherwise it is applied to the + # DocumentStyle. If a footer of the specified type already exists, a 400 bad + # request error is returned. class CreateFooterRequest include Google::Apis::Core::Hashable @@ -413,11 +388,9 @@ module Google end end - # Creates a Footnote segment - # and inserts a new FootnoteReference - # to it at the given location. - # The new Footnote segment will contain a - # space followed by a newline character. + # Creates a Footnote segment and inserts a new FootnoteReference to it at the + # given location. The new Footnote segment will contain a space followed by a + # newline character. class CreateFootnoteRequest include Google::Apis::Core::Hashable @@ -462,12 +435,10 @@ module Google end end - # Creates a Header. The new header is applied to - # the SectionStyle at the location of the - # SectionBreak if specificed, otherwise - # it is applied to the DocumentStyle. - # If a header of the specified type already exists, a 400 bad request error - # is returned. + # Creates a Header. The new header is applied to the SectionStyle at the + # location of the SectionBreak if specificed, otherwise it is applied to the + # DocumentStyle. If a header of the specified type already exists, a 400 bad + # request error is returned. class CreateHeaderRequest include Google::Apis::Core::Hashable @@ -511,14 +482,13 @@ module Google end end - # Creates a NamedRange referencing the given - # range. + # Creates a NamedRange referencing the given range. class CreateNamedRangeRequest include Google::Apis::Core::Hashable - # The name of the NamedRange. Names do not need to be unique. - # Names must be at least 1 character and no more than 256 characters, - # measured in UTF-16 code units. + # The name of the NamedRange. Names do not need to be unique. Names must be at + # least 1 character and no more than 256 characters, measured in UTF-16 code + # units. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -562,10 +532,9 @@ module Google # The nesting level of each paragraph will be determined by counting leading # tabs in front of each paragraph. To avoid excess space between the bullet and # the corresponding paragraph, these leading tabs are removed by this request. - # This may change the indices of parts of the text. - # If the paragraph immediately before paragraphs being updated is in a list - # with a matching preset, the paragraphs being updated are added to that - # preceding list. + # This may change the indices of parts of the text. If the paragraph immediately + # before paragraphs being updated is in a list with a matching preset, the + # paragraphs being updated are added to that preceding list. class CreateParagraphBulletsRequest include Google::Apis::Core::Hashable @@ -590,14 +559,13 @@ module Google end end - # The crop properties of an image. - # The crop rectangle is represented using fractional offsets from the original - # content's four edges. - # - If the offset is in the interval (0, 1), the corresponding edge of crop - # rectangle is positioned inside of the image's original bounding rectangle. - # - If the offset is negative or greater than 1, the corresponding edge of crop - # rectangle is positioned outside of the image's original bounding rectangle. - # - If all offsets and rotation angle are 0, the image is not cropped. + # The crop properties of an image. The crop rectangle is represented using + # fractional offsets from the original content's four edges. - If the offset is + # in the interval (0, 1), the corresponding edge of crop rectangle is positioned + # inside of the image's original bounding rectangle. - If the offset is negative + # or greater than 1, the corresponding edge of crop rectangle is positioned + # outside of the image's original bounding rectangle. - If all offsets and + # rotation angle are 0, the image is not cropped. class CropProperties include Google::Apis::Core::Hashable @@ -607,9 +575,9 @@ module Google # @return [Float] attr_accessor :angle - # The offset specifies how far inwards the bottom edge of the crop rectangle - # is from the bottom edge of the original content as a fraction of the - # original content's height. + # The offset specifies how far inwards the bottom edge of the crop rectangle is + # from the bottom edge of the original content as a fraction of the original + # content's height. # Corresponds to the JSON property `offsetBottom` # @return [Float] attr_accessor :offset_bottom @@ -621,9 +589,9 @@ module Google # @return [Float] attr_accessor :offset_left - # The offset specifies how far inwards the right edge of the crop rectangle - # is from the right edge of the original content as a fraction of the - # original content's width. + # The offset specifies how far inwards the right edge of the crop rectangle is + # from the right edge of the original content as a fraction of the original + # content's width. # Corresponds to the JSON property `offsetRight` # @return [Float] attr_accessor :offset_right @@ -650,8 +618,8 @@ module Google end # A mask that indicates which of the fields on the base CropProperties have been - # changed in this suggestion. - # For any field set to true, there is a new suggested value. + # changed in this suggestion. For any field set to true, there is a new + # suggested value. class CropPropertiesSuggestionState include Google::Apis::Core::Hashable @@ -722,13 +690,11 @@ module Google class DeleteFooterRequest include Google::Apis::Core::Hashable - # The id of the footer to delete. If this footer is defined on - # DocumentStyle, the reference to - # this footer is removed, resulting in no footer of that type for - # the first section of the document. If this footer is defined on a - # SectionStyle, the reference to this - # footer is removed and the footer of that type is now continued from - # the previous section. + # The id of the footer to delete. If this footer is defined on DocumentStyle, + # the reference to this footer is removed, resulting in no footer of that type + # for the first section of the document. If this footer is defined on a + # SectionStyle, the reference to this footer is removed and the footer of that + # type is now continued from the previous section. # Corresponds to the JSON property `footerId` # @return [String] attr_accessor :footer_id @@ -747,13 +713,11 @@ module Google class DeleteHeaderRequest include Google::Apis::Core::Hashable - # The id of the header to delete. If this header is defined on - # DocumentStyle, the reference to - # this header is removed, resulting in no header of that type for - # the first section of the document. If this header is defined on a - # SectionStyle, the reference to this - # header is removed and the header of that type is now continued from - # the previous section. + # The id of the header to delete. If this header is defined on DocumentStyle, + # the reference to this header is removed, resulting in no header of that type + # for the first section of the document. If this header is defined on a + # SectionStyle, the reference to this header is removed and the header of that + # type is now continued from the previous section. # Corresponds to the JSON property `headerId` # @return [String] attr_accessor :header_id @@ -772,8 +736,8 @@ module Google class DeleteNamedRangeRequest include Google::Apis::Core::Hashable - # The name of the range(s) to delete. All named ranges with the given - # name will be deleted. + # The name of the range(s) to delete. All named ranges with the given name will + # be deleted. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -815,8 +779,7 @@ module Google end end - # Deletes a PositionedObject from the - # document. + # Deletes a PositionedObject from the document. class DeletePositionedObjectRequest include Google::Apis::Core::Hashable @@ -902,10 +865,8 @@ module Google class Document include Google::Apis::Core::Hashable - # The document body. - # The body typically contains the full document contents except for - # headers, footers - # and footnotes. + # The document body. The body typically contains the full document contents + # except for headers, footers and footnotes. # Corresponds to the JSON property `body` # @return [Google::Apis::DocsV1::Body] attr_accessor :body @@ -950,8 +911,7 @@ module Google # @return [Hash] attr_accessor :named_ranges - # The named styles. Paragraphs in the document can inherit their - # TextStyle and + # The named styles. Paragraphs in the document can inherit their TextStyle and # ParagraphStyle from these named styles. # Corresponds to the JSON property `namedStyles` # @return [Google::Apis::DocsV1::NamedStyles] @@ -962,17 +922,17 @@ module Google # @return [Hash] attr_accessor :positioned_objects - # Output only. The revision ID of the document. Can be used in update - # requests to specify which revision of a document to apply updates to and - # how the request should behave if the document has been edited since that - # revision. Only populated if the user has edit access to the document. - # The format of the revision ID may change over time, so it should be treated - # opaquely. A returned revision ID is only guaranteed to be valid for 24 - # hours after it has been returned and cannot be shared across users. If the - # revision ID is unchanged between calls, then the document has not changed. - # Conversely, a changed ID (for the same document and user) usually means the - # document has been updated; however, a changed ID can also be due to - # internal factors such as ID format changes. + # Output only. The revision ID of the document. Can be used in update requests + # to specify which revision of a document to apply updates to and how the + # request should behave if the document has been edited since that revision. + # Only populated if the user has edit access to the document. The format of the + # revision ID may change over time, so it should be treated opaquely. A returned + # revision ID is only guaranteed to be valid for 24 hours after it has been + # returned and cannot be shared across users. If the revision ID is unchanged + # between calls, then the document has not changed. Conversely, a changed ID ( + # for the same document and user) usually means the document has been updated; + # however, a changed ID can also be due to internal factors such as ID format + # changes. # Corresponds to the JSON property `revisionId` # @return [String] attr_accessor :revision_id @@ -983,14 +943,14 @@ module Google # @return [Hash] attr_accessor :suggested_document_style_changes - # Output only. The suggested changes to the named styles of the document, - # keyed by suggestion ID. + # Output only. The suggested changes to the named styles of the document, keyed + # by suggestion ID. # Corresponds to the JSON property `suggestedNamedStylesChanges` # @return [Hash] attr_accessor :suggested_named_styles_changes - # Output only. The suggestions view mode applied to the document. - # Note: When editing a document, changes must be based on a document with + # Output only. The suggestions view mode applied to the document. Note: When + # editing a document, changes must be based on a document with # SUGGESTIONS_INLINE. # Corresponds to the JSON property `suggestionsViewMode` # @return [String] @@ -1035,52 +995,48 @@ module Google # @return [Google::Apis::DocsV1::Background] attr_accessor :background - # The ID of the default footer. If not set, there is no default footer. - # This property is read-only. + # The ID of the default footer. If not set, there is no default footer. This + # property is read-only. # Corresponds to the JSON property `defaultFooterId` # @return [String] attr_accessor :default_footer_id - # The ID of the default header. If not set, there is no default header. - # This property is read-only. + # The ID of the default header. If not set, there is no default header. This + # property is read-only. # Corresponds to the JSON property `defaultHeaderId` # @return [String] attr_accessor :default_header_id # The ID of the footer used only for even pages. The value of - # use_even_page_header_footer determines - # whether to use the default_footer_id or this value for the - # footer on even pages. If not set, there is no even page footer. - # This property is read-only. + # use_even_page_header_footer determines whether to use the default_footer_id or + # this value for the footer on even pages. If not set, there is no even page + # footer. This property is read-only. # Corresponds to the JSON property `evenPageFooterId` # @return [String] attr_accessor :even_page_footer_id # The ID of the header used only for even pages. The value of - # use_even_page_header_footer determines - # whether to use the default_header_id or this value for the - # header on even pages. If not set, there is no even page header. - # This property is read-only. + # use_even_page_header_footer determines whether to use the default_header_id or + # this value for the header on even pages. If not set, there is no even page + # header. This property is read-only. # Corresponds to the JSON property `evenPageHeaderId` # @return [String] attr_accessor :even_page_header_id - # The ID of the footer used only for the first page. If not set then - # a unique footer for the first page does not exist. The value of - # use_first_page_header_footer determines - # whether to use the default_footer_id or this value for the - # footer on the first page. If not set, there is no first page footer. - # This property is read-only. + # The ID of the footer used only for the first page. If not set then a unique + # footer for the first page does not exist. The value of + # use_first_page_header_footer determines whether to use the default_footer_id + # or this value for the footer on the first page. If not set, there is no first + # page footer. This property is read-only. # Corresponds to the JSON property `firstPageFooterId` # @return [String] attr_accessor :first_page_footer_id - # The ID of the header used only for the first page. If not set then - # a unique header for the first page does not exist. - # The value of use_first_page_header_footer determines - # whether to use the default_header_id or this value for the - # header on the first page. If not set, there is no first page header. - # This property is read-only. + # The ID of the header used only for the first page. If not set then a unique + # header for the first page does not exist. The value of + # use_first_page_header_footer determines whether to use the default_header_id + # or this value for the header on the first page. If not set, there is no first + # page header. This property is read-only. # Corresponds to the JSON property `firstPageHeaderId` # @return [String] attr_accessor :first_page_header_id @@ -1125,31 +1081,22 @@ module Google # @return [Google::Apis::DocsV1::Size] attr_accessor :page_size - # Indicates whether DocumentStyle - # margin_header, - # SectionStyle - # margin_header and - # DocumentStyle - # margin_footer, - # SectionStyle - # margin_footer are - # respected. When false, the default values in the Docs editor for header and - # footer margin are used. - # This property is read-only. + # Indicates whether DocumentStyle margin_header, SectionStyle margin_header and + # DocumentStyle margin_footer, SectionStyle margin_footer are respected. When + # false, the default values in the Docs editor for header and footer margin are + # used. This property is read-only. # Corresponds to the JSON property `useCustomHeaderFooterMargins` # @return [Boolean] attr_accessor :use_custom_header_footer_margins alias_method :use_custom_header_footer_margins?, :use_custom_header_footer_margins - # Indicates whether to use the even page header / footer IDs for the even - # pages. + # Indicates whether to use the even page header / footer IDs for the even pages. # Corresponds to the JSON property `useEvenPageHeaderFooter` # @return [Boolean] attr_accessor :use_even_page_header_footer alias_method :use_even_page_header_footer?, :use_even_page_header_footer - # Indicates whether to use the first page header / footer IDs for the first - # page. + # Indicates whether to use the first page header / footer IDs for the first page. # Corresponds to the JSON property `useFirstPageHeaderFooter` # @return [Boolean] attr_accessor :use_first_page_header_footer @@ -1183,14 +1130,14 @@ module Google end # A mask that indicates which of the fields on the base DocumentStyle have been - # changed in this suggestion. - # For any field set to true, there is a new suggested value. + # changed in this suggestion. For any field set to true, there is a new + # suggested value. class DocumentStyleSuggestionState include Google::Apis::Core::Hashable # A mask that indicates which of the fields on the base Background have been - # changed in this suggestion. - # For any field set to true, the Backgound has a new suggested value. + # changed in this suggestion. For any field set to true, the Backgound has a new + # suggested value. # Corresponds to the JSON property `backgroundSuggestionState` # @return [Google::Apis::DocsV1::BackgroundSuggestionState] attr_accessor :background_suggestion_state @@ -1274,15 +1221,13 @@ module Google alias_method :page_number_start_suggested?, :page_number_start_suggested # A mask that indicates which of the fields on the base Size have been changed - # in this suggestion. - # For any field set to true, the Size has - # a new suggested value. + # in this suggestion. For any field set to true, the Size has a new suggested + # value. # Corresponds to the JSON property `pageSizeSuggestionState` # @return [Google::Apis::DocsV1::SizeSuggestionState] attr_accessor :page_size_suggestion_state - # Indicates if there was a suggested change to - # use_custom_header_footer_margins. + # Indicates if there was a suggested change to use_custom_header_footer_margins. # Corresponds to the JSON property `useCustomHeaderFooterMarginsSuggested` # @return [Boolean] attr_accessor :use_custom_header_footer_margins_suggested @@ -1341,9 +1286,8 @@ module Google end # A mask that indicates which of the fields on the base - # EmbeddedDrawingProperties - # have been changed in this suggestion. For any field set to true, there is a - # new suggested value. + # EmbeddedDrawingProperties have been changed in this suggestion. For any field + # set to true, there is a new suggested value. class EmbeddedDrawingPropertiesSuggestionState include Google::Apis::Core::Hashable @@ -1360,8 +1304,8 @@ module Google class EmbeddedObject include Google::Apis::Core::Hashable - # The description of the embedded object. The `title` and `description` are - # both combined to display alt text. + # The description of the embedded object. The `title` and `description` are both + # combined to display alt text. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description @@ -1475,8 +1419,8 @@ module Google end # A mask that indicates which of the fields on the base EmbeddedObjectBorder - # have been changed in this - # suggestion. For any field set to true, there is a new suggested value. + # have been changed in this suggestion. For any field set to true, there is a + # new suggested value. class EmbeddedObjectBorderSuggestionState include Google::Apis::Core::Hashable @@ -1518,8 +1462,8 @@ module Google end # A mask that indicates which of the fields on the base EmbeddedObject have been - # changed in this suggestion. - # For any field set to true, there is a new suggested value. + # changed in this suggestion. For any field set to true, there is a new + # suggested value. class EmbeddedObjectSuggestionState include Google::Apis::Core::Hashable @@ -1530,31 +1474,29 @@ module Google alias_method :description_suggested?, :description_suggested # A mask that indicates which of the fields on the base - # EmbeddedDrawingProperties - # have been changed in this suggestion. For any field set to true, there is a - # new suggested value. + # EmbeddedDrawingProperties have been changed in this suggestion. For any field + # set to true, there is a new suggested value. # Corresponds to the JSON property `embeddedDrawingPropertiesSuggestionState` # @return [Google::Apis::DocsV1::EmbeddedDrawingPropertiesSuggestionState] attr_accessor :embedded_drawing_properties_suggestion_state # A mask that indicates which of the fields on the base EmbeddedObjectBorder - # have been changed in this - # suggestion. For any field set to true, there is a new suggested value. + # have been changed in this suggestion. For any field set to true, there is a + # new suggested value. # Corresponds to the JSON property `embeddedObjectBorderSuggestionState` # @return [Google::Apis::DocsV1::EmbeddedObjectBorderSuggestionState] attr_accessor :embedded_object_border_suggestion_state # A mask that indicates which of the fields on the base ImageProperties have - # been changed in this suggestion. - # For any field set to true, there is a new suggested value. + # been changed in this suggestion. For any field set to true, there is a new + # suggested value. # Corresponds to the JSON property `imagePropertiesSuggestionState` # @return [Google::Apis::DocsV1::ImagePropertiesSuggestionState] attr_accessor :image_properties_suggestion_state - # A mask that indicates which of the fields on the base - # LinkedContentReference have - # been changed in this suggestion. For any field set to true, there is a new - # suggested value. + # A mask that indicates which of the fields on the base LinkedContentReference + # have been changed in this suggestion. For any field set to true, there is a + # new suggested value. # Corresponds to the JSON property `linkedContentReferenceSuggestionState` # @return [Google::Apis::DocsV1::LinkedContentReferenceSuggestionState] attr_accessor :linked_content_reference_suggestion_state @@ -1584,9 +1526,8 @@ module Google alias_method :margin_top_suggested?, :margin_top_suggested # A mask that indicates which of the fields on the base Size have been changed - # in this suggestion. - # For any field set to true, the Size has - # a new suggested value. + # in this suggestion. For any field set to true, the Size has a new suggested + # value. # Corresponds to the JSON property `sizeSuggestionState` # @return [Google::Apis::DocsV1::SizeSuggestionState] attr_accessor :size_suggestion_state @@ -1622,8 +1563,8 @@ module Google class EndOfSegmentLocation include Google::Apis::Core::Hashable - # The ID of the header, footer or footnote the location is in. An empty - # segment ID signifies the document's body. + # The ID of the header, footer or footnote the location is in. An empty segment + # ID signifies the document's body. # Corresponds to the JSON property `segmentId` # @return [String] attr_accessor :segment_id @@ -1638,20 +1579,18 @@ module Google end end - # A ParagraphElement representing an - # equation. + # A ParagraphElement representing an equation. class Equation include Google::Apis::Core::Hashable - # The suggested deletion IDs. If empty, then there are no suggested deletions - # of this content. + # The suggested deletion IDs. If empty, then there are no suggested deletions of + # this content. # Corresponds to the JSON property `suggestedDeletionIds` # @return [Array] attr_accessor :suggested_deletion_ids - # The suggested insertion IDs. A Equation - # may have multiple insertion IDs if it is a nested suggested change. If - # empty, then this is not a suggested insertion. + # The suggested insertion IDs. A Equation may have multiple insertion IDs if it + # is a nested suggested change. If empty, then this is not a suggested insertion. # Corresponds to the JSON property `suggestedInsertionIds` # @return [Array] attr_accessor :suggested_insertion_ids @@ -1671,8 +1610,7 @@ module Google class Footer include Google::Apis::Core::Hashable - # The contents of the footer. - # The indexes for a footer's content begin at zero. + # The contents of the footer. The indexes for a footer's content begin at zero. # Corresponds to the JSON property `content` # @return [Array] attr_accessor :content @@ -1697,8 +1635,8 @@ module Google class Footnote include Google::Apis::Core::Hashable - # The contents of the footnote. - # The indexes for a footnote's content begin at zero. + # The contents of the footnote. The indexes for a footnote's content begin at + # zero. # Corresponds to the JSON property `content` # @return [Array] attr_accessor :content @@ -1719,14 +1657,12 @@ module Google end end - # A ParagraphElement representing a - # footnote reference. A footnote reference is the inline content rendered with - # a number and is used to identify the footnote. + # A ParagraphElement representing a footnote reference. A footnote reference is + # the inline content rendered with a number and is used to identify the footnote. class FootnoteReference include Google::Apis::Core::Hashable - # The ID of the footnote that - # contains the content of this footnote reference. + # The ID of the footnote that contains the content of this footnote reference. # Corresponds to the JSON property `footnoteId` # @return [String] attr_accessor :footnote_id @@ -1736,15 +1672,14 @@ module Google # @return [String] attr_accessor :footnote_number - # The suggested deletion IDs. If empty, then there are no suggested deletions - # of this content. + # The suggested deletion IDs. If empty, then there are no suggested deletions of + # this content. # Corresponds to the JSON property `suggestedDeletionIds` # @return [Array] attr_accessor :suggested_deletion_ids # The suggested insertion IDs. A FootnoteReference may have multiple insertion - # IDs if - # it is a nested suggested change. If empty, then this is not a suggested + # IDs if it is a nested suggested change. If empty, then this is not a suggested # insertion. # Corresponds to the JSON property `suggestedInsertionIds` # @return [Array] @@ -1756,20 +1691,16 @@ module Google # @return [Hash] attr_accessor :suggested_text_style_changes - # Represents the styling that can be applied to text. - # Inherited text styles are represented as unset fields in this message. A - # text style's parent depends on where the text style is defined: - # * The TextStyle of text in a Paragraph - # inherits from the paragraph's corresponding named style type. - # * The TextStyle on a named style - # inherits from the normal text named style. - # * The TextStyle of the normal text named style inherits - # from the default text style in the Docs editor. - # * The TextStyle on a Paragraph element - # that is contained in a table may inherit its text style from the table - # style. - # If the text style does not inherit from a parent, unsetting fields will - # revert the style to a value matching the defaults in the Docs editor. + # Represents the styling that can be applied to text. Inherited text styles are + # represented as unset fields in this message. A text style's parent depends on + # where the text style is defined: * The TextStyle of text in a Paragraph + # inherits from the paragraph's corresponding named style type. * The TextStyle + # on a named style inherits from the normal text named style. * The TextStyle of + # the normal text named style inherits from the default text style in the Docs + # editor. * The TextStyle on a Paragraph element that is contained in a table + # may inherit its text style from the table style. If the text style does not + # inherit from a parent, unsetting fields will revert the style to a value + # matching the defaults in the Docs editor. # Corresponds to the JSON property `textStyle` # @return [Google::Apis::DocsV1::TextStyle] attr_accessor :text_style @@ -1793,8 +1724,7 @@ module Google class Header include Google::Apis::Core::Hashable - # The contents of the header. - # The indexes for a header's content begin at zero. + # The contents of the header. The indexes for a header's content begin at zero. # Corresponds to the JSON property `content` # @return [Array] attr_accessor :content @@ -1815,45 +1745,39 @@ module Google end end - # A ParagraphElement representing a - # horizontal line. + # A ParagraphElement representing a horizontal line. class HorizontalRule include Google::Apis::Core::Hashable - # The suggested deletion IDs. If empty, then there are no suggested deletions - # of this content. + # The suggested deletion IDs. If empty, then there are no suggested deletions of + # this content. # Corresponds to the JSON property `suggestedDeletionIds` # @return [Array] attr_accessor :suggested_deletion_ids # The suggested insertion IDs. A HorizontalRule may have multiple insertion IDs - # if it - # is a nested suggested change. If empty, then this is not a suggested + # if it is a nested suggested change. If empty, then this is not a suggested # insertion. # Corresponds to the JSON property `suggestedInsertionIds` # @return [Array] attr_accessor :suggested_insertion_ids - # The suggested text style changes to this HorizontalRule, keyed by - # suggestion ID. + # The suggested text style changes to this HorizontalRule, keyed by suggestion + # ID. # Corresponds to the JSON property `suggestedTextStyleChanges` # @return [Hash] attr_accessor :suggested_text_style_changes - # Represents the styling that can be applied to text. - # Inherited text styles are represented as unset fields in this message. A - # text style's parent depends on where the text style is defined: - # * The TextStyle of text in a Paragraph - # inherits from the paragraph's corresponding named style type. - # * The TextStyle on a named style - # inherits from the normal text named style. - # * The TextStyle of the normal text named style inherits - # from the default text style in the Docs editor. - # * The TextStyle on a Paragraph element - # that is contained in a table may inherit its text style from the table - # style. - # If the text style does not inherit from a parent, unsetting fields will - # revert the style to a value matching the defaults in the Docs editor. + # Represents the styling that can be applied to text. Inherited text styles are + # represented as unset fields in this message. A text style's parent depends on + # where the text style is defined: * The TextStyle of text in a Paragraph + # inherits from the paragraph's corresponding named style type. * The TextStyle + # on a named style inherits from the normal text named style. * The TextStyle of + # the normal text named style inherits from the default text style in the Docs + # editor. * The TextStyle on a Paragraph element that is contained in a table + # may inherit its text style from the table style. If the text style does not + # inherit from a parent, unsetting fields will revert the style to a value + # matching the defaults in the Docs editor. # Corresponds to the JSON property `textStyle` # @return [Google::Apis::DocsV1::TextStyle] attr_accessor :text_style @@ -1880,34 +1804,33 @@ module Google # @return [Float] attr_accessor :angle - # The brightness effect of the image. The value should be in the interval - # [-1.0, 1.0], where 0 means no effect. + # The brightness effect of the image. The value should be in the interval [-1.0, + # 1.0], where 0 means no effect. # Corresponds to the JSON property `brightness` # @return [Float] attr_accessor :brightness - # A URI to the image with a default lifetime of 30 minutes. - # This URI is tagged with the account of the requester. Anyone with the URI - # effectively accesses the image as the original requester. Access to the - # image may be lost if the document's sharing settings change. + # A URI to the image with a default lifetime of 30 minutes. This URI is tagged + # with the account of the requester. Anyone with the URI effectively accesses + # the image as the original requester. Access to the image may be lost if the + # document's sharing settings change. # Corresponds to the JSON property `contentUri` # @return [String] attr_accessor :content_uri - # The contrast effect of the image. The value should be in the interval - # [-1.0, 1.0], where 0 means no effect. + # The contrast effect of the image. The value should be in the interval [-1.0, 1. + # 0], where 0 means no effect. # Corresponds to the JSON property `contrast` # @return [Float] attr_accessor :contrast - # The crop properties of an image. - # The crop rectangle is represented using fractional offsets from the original - # content's four edges. - # - If the offset is in the interval (0, 1), the corresponding edge of crop - # rectangle is positioned inside of the image's original bounding rectangle. - # - If the offset is negative or greater than 1, the corresponding edge of crop - # rectangle is positioned outside of the image's original bounding rectangle. - # - If all offsets and rotation angle are 0, the image is not cropped. + # The crop properties of an image. The crop rectangle is represented using + # fractional offsets from the original content's four edges. - If the offset is + # in the interval (0, 1), the corresponding edge of crop rectangle is positioned + # inside of the image's original bounding rectangle. - If the offset is negative + # or greater than 1, the corresponding edge of crop rectangle is positioned + # outside of the image's original bounding rectangle. - If all offsets and + # rotation angle are 0, the image is not cropped. # Corresponds to the JSON property `cropProperties` # @return [Google::Apis::DocsV1::CropProperties] attr_accessor :crop_properties @@ -1918,8 +1841,8 @@ module Google # @return [String] attr_accessor :source_uri - # The transparency effect of the image. The value should be in the interval - # [0.0, 1.0], where 0 means no effect and 1 means completely transparent. + # The transparency effect of the image. The value should be in the interval [0.0, + # 1.0], where 0 means no effect and 1 means completely transparent. # Corresponds to the JSON property `transparency` # @return [Float] attr_accessor :transparency @@ -1941,8 +1864,8 @@ module Google end # A mask that indicates which of the fields on the base ImageProperties have - # been changed in this suggestion. - # For any field set to true, there is a new suggested value. + # been changed in this suggestion. For any field set to true, there is a new + # suggested value. class ImagePropertiesSuggestionState include Google::Apis::Core::Hashable @@ -1958,8 +1881,7 @@ module Google attr_accessor :brightness_suggested alias_method :brightness_suggested?, :brightness_suggested - # Indicates if there was a suggested change to - # content_uri. + # Indicates if there was a suggested change to content_uri. # Corresponds to the JSON property `contentUriSuggested` # @return [Boolean] attr_accessor :content_uri_suggested @@ -1972,8 +1894,8 @@ module Google alias_method :contrast_suggested?, :contrast_suggested # A mask that indicates which of the fields on the base CropProperties have been - # changed in this suggestion. - # For any field set to true, there is a new suggested value. + # changed in this suggestion. For any field set to true, there is a new + # suggested value. # Corresponds to the JSON property `cropPropertiesSuggestionState` # @return [Google::Apis::DocsV1::CropPropertiesSuggestionState] attr_accessor :crop_properties_suggestion_state @@ -2006,8 +1928,8 @@ module Google end end - # An object that appears inline with text. An InlineObject contains - # an EmbeddedObject such as an image. + # An object that appears inline with text. An InlineObject contains an + # EmbeddedObject such as an image. class InlineObject include Google::Apis::Core::Hashable @@ -2021,20 +1943,18 @@ module Google # @return [String] attr_accessor :object_id_prop - # The suggested deletion IDs. If empty, then there are no suggested deletions - # of this content. + # The suggested deletion IDs. If empty, then there are no suggested deletions of + # this content. # Corresponds to the JSON property `suggestedDeletionIds` # @return [Array] attr_accessor :suggested_deletion_ids - # The suggested changes to the inline object properties, keyed by suggestion - # ID. + # The suggested changes to the inline object properties, keyed by suggestion ID. # Corresponds to the JSON property `suggestedInlineObjectPropertiesChanges` # @return [Hash] attr_accessor :suggested_inline_object_properties_changes - # The suggested insertion ID. If empty, then this is not a suggested - # insertion. + # The suggested insertion ID. If empty, then this is not a suggested insertion. # Corresponds to the JSON property `suggestedInsertionId` # @return [String] attr_accessor :suggested_insertion_id @@ -2053,51 +1973,43 @@ module Google end end - # A ParagraphElement that contains - # an InlineObject. + # A ParagraphElement that contains an InlineObject. class InlineObjectElement include Google::Apis::Core::Hashable - # The ID of the InlineObject this - # element contains. + # The ID of the InlineObject this element contains. # Corresponds to the JSON property `inlineObjectId` # @return [String] attr_accessor :inline_object_id - # The suggested deletion IDs. If empty, then there are no suggested deletions - # of this content. + # The suggested deletion IDs. If empty, then there are no suggested deletions of + # this content. # Corresponds to the JSON property `suggestedDeletionIds` # @return [Array] attr_accessor :suggested_deletion_ids # The suggested insertion IDs. An InlineObjectElement may have multiple - # insertion IDs - # if it is a nested suggested change. If empty, then this is not a suggested - # insertion. + # insertion IDs if it is a nested suggested change. If empty, then this is not a + # suggested insertion. # Corresponds to the JSON property `suggestedInsertionIds` # @return [Array] attr_accessor :suggested_insertion_ids - # The suggested text style changes to this InlineObject, keyed by suggestion - # ID. + # The suggested text style changes to this InlineObject, keyed by suggestion ID. # Corresponds to the JSON property `suggestedTextStyleChanges` # @return [Hash] attr_accessor :suggested_text_style_changes - # Represents the styling that can be applied to text. - # Inherited text styles are represented as unset fields in this message. A - # text style's parent depends on where the text style is defined: - # * The TextStyle of text in a Paragraph - # inherits from the paragraph's corresponding named style type. - # * The TextStyle on a named style - # inherits from the normal text named style. - # * The TextStyle of the normal text named style inherits - # from the default text style in the Docs editor. - # * The TextStyle on a Paragraph element - # that is contained in a table may inherit its text style from the table - # style. - # If the text style does not inherit from a parent, unsetting fields will - # revert the style to a value matching the defaults in the Docs editor. + # Represents the styling that can be applied to text. Inherited text styles are + # represented as unset fields in this message. A text style's parent depends on + # where the text style is defined: * The TextStyle of text in a Paragraph + # inherits from the paragraph's corresponding named style type. * The TextStyle + # on a named style inherits from the normal text named style. * The TextStyle of + # the normal text named style inherits from the default text style in the Docs + # editor. * The TextStyle on a Paragraph element that is contained in a table + # may inherit its text style from the table style. If the text style does not + # inherit from a parent, unsetting fields will revert the style to a value + # matching the defaults in the Docs editor. # Corresponds to the JSON property `textStyle` # @return [Google::Apis::DocsV1::TextStyle] attr_accessor :text_style @@ -2135,16 +2047,15 @@ module Google end end - # A mask that indicates which of the fields on the base - # InlineObjectProperties have - # been changed in this suggestion. For any field set to true, there is a new - # suggested value. + # A mask that indicates which of the fields on the base InlineObjectProperties + # have been changed in this suggestion. For any field set to true, there is a + # new suggested value. class InlineObjectPropertiesSuggestionState include Google::Apis::Core::Hashable # A mask that indicates which of the fields on the base EmbeddedObject have been - # changed in this suggestion. - # For any field set to true, there is a new suggested value. + # changed in this suggestion. For any field set to true, there is a new + # suggested value. # Corresponds to the JSON property `embeddedObjectSuggestionState` # @return [Google::Apis::DocsV1::EmbeddedObjectSuggestionState] attr_accessor :embedded_object_suggestion_state @@ -2159,8 +2070,7 @@ module Google end end - # Inserts an InlineObject containing an - # image at the given location. + # Inserts an InlineObject containing an image at the given location. class InsertInlineImageRequest include Google::Apis::Core::Hashable @@ -2180,12 +2090,11 @@ module Google # @return [Google::Apis::DocsV1::Size] attr_accessor :object_size - # The image URI. - # The image is fetched once at insertion time and a copy is stored for - # display inside the document. Images must be less than 50MB in size, cannot - # exceed 25 megapixels, and must be in one of PNG, JPEG, or GIF format. - # The provided URI can be at most 2 kB in length. The URI itself is saved - # with the image, and exposed via the ImageProperties.content_uri field. + # The image URI. The image is fetched once at insertion time and a copy is + # stored for display inside the document. Images must be less than 50MB in size, + # cannot exceed 25 megapixels, and must be in one of PNG, JPEG, or GIF format. + # The provided URI can be at most 2 kB in length. The URI itself is saved with + # the image, and exposed via the ImageProperties.content_uri field. # Corresponds to the JSON property `uri` # @return [String] attr_accessor :uri @@ -2267,8 +2176,8 @@ module Google end end - # Inserts a section break at the given location. - # A newline character will be inserted before the section break. + # Inserts a section break at the given location. A newline character will be + # inserted before the section break. class InsertSectionBreakRequest include Google::Apis::Core::Hashable @@ -2304,9 +2213,8 @@ module Google class InsertTableColumnRequest include Google::Apis::Core::Hashable - # Whether to insert new column to the right of the reference cell location. - # - `True`: insert to the right. - # - `False`: insert to the left. + # Whether to insert new column to the right of the reference cell location. - ` + # True`: insert to the right. - `False`: insert to the left. # Corresponds to the JSON property `insertRight` # @return [Boolean] attr_accessor :insert_right @@ -2328,8 +2236,8 @@ module Google end end - # Inserts a table at the specified location. - # A newline character will be inserted before the inserted table. + # Inserts a table at the specified location. A newline character will be + # inserted before the inserted table. class InsertTableRequest include Google::Apis::Core::Hashable @@ -2371,9 +2279,8 @@ module Google class InsertTableRowRequest include Google::Apis::Core::Hashable - # Whether to insert new row below the reference cell location. - # - `True`: insert below the cell. - # - `False`: insert above the cell. + # Whether to insert new row below the reference cell location. - `True`: insert + # below the cell. - `False`: insert above the cell. # Corresponds to the JSON property `insertBelow` # @return [Boolean] attr_accessor :insert_below @@ -2410,18 +2317,15 @@ module Google # @return [Google::Apis::DocsV1::Location] attr_accessor :location - # The text to be inserted. - # Inserting a newline character will implicitly create a new - # Paragraph at that index. - # The paragraph style of the new paragraph will be copied from the paragraph - # at the current insertion index, including lists and bullets. - # Text styles for inserted text will be determined automatically, generally - # preserving the styling of neighboring text. In most cases, the text style - # for the inserted text will match the text immediately before the insertion - # index. - # Some control characters (U+0000-U+0008, U+000C-U+001F) and characters - # from the Unicode Basic Multilingual Plane Private Use Area (U+E000-U+F8FF) - # will be stripped out of the inserted text. + # The text to be inserted. Inserting a newline character will implicitly create + # a new Paragraph at that index. The paragraph style of the new paragraph will + # be copied from the paragraph at the current insertion index, including lists + # and bullets. Text styles for inserted text will be determined automatically, + # generally preserving the styling of neighboring text. In most cases, the text + # style for the inserted text will match the text immediately before the + # insertion index. Some control characters (U+0000-U+0008, U+000C-U+001F) and + # characters from the Unicode Basic Multilingual Plane Private Use Area (U+E000- + # U+F8FF) will be stripped out of the inserted text. # Corresponds to the JSON property `text` # @return [String] attr_accessor :text @@ -2488,16 +2392,15 @@ module Google end end - # A mask that indicates which of the fields on the base - # LinkedContentReference have - # been changed in this suggestion. For any field set to true, there is a new - # suggested value. + # A mask that indicates which of the fields on the base LinkedContentReference + # have been changed in this suggestion. For any field set to true, there is a + # new suggested value. class LinkedContentReferenceSuggestionState include Google::Apis::Core::Hashable # A mask that indicates which of the fields on the base SheetsChartReference - # have been changed in this - # suggestion. For any field set to true, there is a new suggested value. + # have been changed in this suggestion. For any field set to true, there is a + # new suggested value. # Corresponds to the JSON property `sheetsChartReferenceSuggestionState` # @return [Google::Apis::DocsV1::SheetsChartReferenceSuggestionState] attr_accessor :sheets_chart_reference_suggestion_state @@ -2513,31 +2416,29 @@ module Google end # A List represents the list attributes for a group of paragraphs that all - # belong to the same list. A paragraph that is part of a list has a reference - # to the list's ID in its bullet. + # belong to the same list. A paragraph that is part of a list has a reference to + # the list's ID in its bullet. class List include Google::Apis::Core::Hashable - # The properties of a list which describe the look - # and feel of bullets belonging to paragraphs associated with a list. + # The properties of a list which describe the look and feel of bullets belonging + # to paragraphs associated with a list. # Corresponds to the JSON property `listProperties` # @return [Google::Apis::DocsV1::ListProperties] attr_accessor :list_properties - # The suggested deletion IDs. If empty, then there are no suggested deletions - # of this list. + # The suggested deletion IDs. If empty, then there are no suggested deletions of + # this list. # Corresponds to the JSON property `suggestedDeletionIds` # @return [Array] attr_accessor :suggested_deletion_ids - # The suggested insertion ID. If empty, then this is not a suggested - # insertion. + # The suggested insertion ID. If empty, then this is not a suggested insertion. # Corresponds to the JSON property `suggestedInsertionId` # @return [String] attr_accessor :suggested_insertion_id - # The suggested changes to the list properties, keyed by suggestion - # ID. + # The suggested changes to the list properties, keyed by suggestion ID. # Corresponds to the JSON property `suggestedListPropertiesChanges` # @return [Hash] attr_accessor :suggested_list_properties_changes @@ -2555,16 +2456,15 @@ module Google end end - # The properties of a list which describe the look - # and feel of bullets belonging to paragraphs associated with a list. + # The properties of a list which describe the look and feel of bullets belonging + # to paragraphs associated with a list. class ListProperties include Google::Apis::Core::Hashable - # Describes the properties of the bullets at the associated level. - # A list has at most nine levels of nesting with nesting level 0 - # corresponding to the top-most level and nesting level 8 corresponding to - # the most nested level. The nesting levels are returned in ascending order - # with the least nested returned first. + # Describes the properties of the bullets at the associated level. A list has at + # most nine levels of nesting with nesting level 0 corresponding to the top-most + # level and nesting level 8 corresponding to the most nested level. The nesting + # levels are returned in ascending order with the least nested returned first. # Corresponds to the JSON property `nestingLevels` # @return [Array] attr_accessor :nesting_levels @@ -2580,16 +2480,15 @@ module Google end # A mask that indicates which of the fields on the base ListProperties have been - # changed in this suggestion. - # For any field set to true, there is a new suggested value. + # changed in this suggestion. For any field set to true, there is a new + # suggested value. class ListPropertiesSuggestionState include Google::Apis::Core::Hashable - # A mask that indicates which of the fields on the corresponding - # NestingLevel in nesting_levels have been changed in - # this suggestion. - # The nesting level suggestion states are returned in ascending order of the - # nesting level with the least nested returned first. + # A mask that indicates which of the fields on the corresponding NestingLevel in + # nesting_levels have been changed in this suggestion. The nesting level + # suggestion states are returned in ascending order of the nesting level with + # the least nested returned first. # Corresponds to the JSON property `nestingLevelsSuggestionStates` # @return [Array] attr_accessor :nesting_levels_suggestion_states @@ -2608,15 +2507,14 @@ module Google class Location include Google::Apis::Core::Hashable - # The zero-based index, in UTF-16 code units. - # The index is relative to the beginning of the segment specified by - # segment_id. + # The zero-based index, in UTF-16 code units. The index is relative to the + # beginning of the segment specified by segment_id. # Corresponds to the JSON property `index` # @return [Fixnum] attr_accessor :index - # The ID of the header, footer or footnote the location is in. An empty - # segment ID signifies the document's body. + # The ID of the header, footer or footnote the location is in. An empty segment + # ID signifies the document's body. # Corresponds to the JSON property `segmentId` # @return [String] attr_accessor :segment_id @@ -2636,17 +2534,12 @@ module Google class MergeTableCellsRequest include Google::Apis::Core::Hashable - # A table range represents a reference to a subset of a table. - # It's important to note that the cells specified by a table range do not - # necessarily form a rectangle. For example, let's say we have a 3 x 3 table - # where all the cells of the last row are merged together. The table looks - # like this: - # - # [ ] - # A table range with table cell location = (table_start_location, row = 0, - # column = 0), row span = 3 and column span = 2 specifies the following cells: - # x x - # [ x x x ] + # A table range represents a reference to a subset of a table. It's important to + # note that the cells specified by a table range do not necessarily form a + # rectangle. For example, let's say we have a 3 x 3 table where all the cells of + # the last row are merged together. The table looks like this: [ ] A table range + # with table cell location = (table_start_location, row = 0, column = 0), row + # span = 3 and column span = 2 specifies the following cells: x x [ x x x ] # Corresponds to the JSON property `tableRange` # @return [Google::Apis::DocsV1::TableRange] attr_accessor :table_range @@ -2661,16 +2554,13 @@ module Google end end - # A collection of Ranges with the same named range - # ID. - # Named ranges allow developers to associate parts of a document with an - # arbitrary user-defined label so their contents can be programmatically read - # or edited at a later time. A document can contain multiple named ranges with - # the same name, but every named range has a unique ID. - # A named range is created with a single Range, - # and content inserted inside a named range generally expands that range. - # However, certain document changes can cause the range to be split into - # multiple ranges. + # A collection of Ranges with the same named range ID. Named ranges allow + # developers to associate parts of a document with an arbitrary user-defined + # label so their contents can be programmatically read or edited at a later time. + # A document can contain multiple named ranges with the same name, but every + # named range has a unique ID. A named range is created with a single Range, and + # content inserted inside a named range generally expands that range. However, + # certain document changes can cause the range to be split into multiple ranges. # Named ranges are not private. All applications and collaborators that have # access to the document can see its named ranges. class NamedRange @@ -2703,8 +2593,7 @@ module Google end end - # A collection of all the NamedRanges in the - # document that share a given name. + # A collection of all the NamedRanges in the document that share a given name. class NamedRanges include Google::Apis::Core::Hashable @@ -2729,10 +2618,8 @@ module Google end end - # A named style. Paragraphs in the document can inherit their - # TextStyle and - # ParagraphStyle from this named style - # when they have the same named style type. + # A named style. Paragraphs in the document can inherit their TextStyle and + # ParagraphStyle from this named style when they have the same named style type. class NamedStyle include Google::Apis::Core::Hashable @@ -2741,38 +2628,31 @@ module Google # @return [String] attr_accessor :named_style_type - # Styles that apply to a whole paragraph. - # Inherited paragraph styles are represented as unset fields in this message. - # A paragraph style's parent depends on where the paragraph style is defined: - # * The ParagraphStyle on a Paragraph - # inherits from the paragraph's corresponding named style type. - # * The ParagraphStyle on a named style - # inherits from the normal text named style. - # * The ParagraphStyle of the normal text named style inherits - # from the default paragraph style in the Docs editor. - # * The ParagraphStyle on a Paragraph - # element that is contained in a table may inherit its paragraph style from - # the table style. - # If the paragraph style does not inherit from a parent, unsetting fields will - # revert the style to a value matching the defaults in the Docs editor. + # Styles that apply to a whole paragraph. Inherited paragraph styles are + # represented as unset fields in this message. A paragraph style's parent + # depends on where the paragraph style is defined: * The ParagraphStyle on a + # Paragraph inherits from the paragraph's corresponding named style type. * The + # ParagraphStyle on a named style inherits from the normal text named style. * + # The ParagraphStyle of the normal text named style inherits from the default + # paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph + # element that is contained in a table may inherit its paragraph style from the + # table style. If the paragraph style does not inherit from a parent, unsetting + # fields will revert the style to a value matching the defaults in the Docs + # editor. # Corresponds to the JSON property `paragraphStyle` # @return [Google::Apis::DocsV1::ParagraphStyle] attr_accessor :paragraph_style - # Represents the styling that can be applied to text. - # Inherited text styles are represented as unset fields in this message. A - # text style's parent depends on where the text style is defined: - # * The TextStyle of text in a Paragraph - # inherits from the paragraph's corresponding named style type. - # * The TextStyle on a named style - # inherits from the normal text named style. - # * The TextStyle of the normal text named style inherits - # from the default text style in the Docs editor. - # * The TextStyle on a Paragraph element - # that is contained in a table may inherit its text style from the table - # style. - # If the text style does not inherit from a parent, unsetting fields will - # revert the style to a value matching the defaults in the Docs editor. + # Represents the styling that can be applied to text. Inherited text styles are + # represented as unset fields in this message. A text style's parent depends on + # where the text style is defined: * The TextStyle of text in a Paragraph + # inherits from the paragraph's corresponding named style type. * The TextStyle + # on a named style inherits from the normal text named style. * The TextStyle of + # the normal text named style inherits from the default text style in the Docs + # editor. * The TextStyle on a Paragraph element that is contained in a table + # may inherit its text style from the table style. If the text style does not + # inherit from a parent, unsetting fields will revert the style to a value + # matching the defaults in the Docs editor. # Corresponds to the JSON property `textStyle` # @return [Google::Apis::DocsV1::TextStyle] attr_accessor :text_style @@ -2793,23 +2673,23 @@ module Google class NamedStyleSuggestionState include Google::Apis::Core::Hashable - # The named style type that this suggestion state corresponds to. - # This field is provided as a convenience for matching the - # NamedStyleSuggestionState with its corresponding NamedStyle. + # The named style type that this suggestion state corresponds to. This field is + # provided as a convenience for matching the NamedStyleSuggestionState with its + # corresponding NamedStyle. # Corresponds to the JSON property `namedStyleType` # @return [String] attr_accessor :named_style_type # A mask that indicates which of the fields on the base ParagraphStyle have been - # changed in this suggestion. - # For any field set to true, there is a new suggested value. + # changed in this suggestion. For any field set to true, there is a new + # suggested value. # Corresponds to the JSON property `paragraphStyleSuggestionState` # @return [Google::Apis::DocsV1::ParagraphStyleSuggestionState] attr_accessor :paragraph_style_suggestion_state # A mask that indicates which of the fields on the base TextStyle have been - # changed in this suggestion. - # For any field set to true, there is a new suggested value. + # changed in this suggestion. For any field set to true, there is a new + # suggested value. # Corresponds to the JSON property `textStyleSuggestionState` # @return [Google::Apis::DocsV1::TextStyleSuggestionState] attr_accessor :text_style_suggestion_state @@ -2826,14 +2706,12 @@ module Google end end - # The named styles. Paragraphs in the document can inherit their - # TextStyle and + # The named styles. Paragraphs in the document can inherit their TextStyle and # ParagraphStyle from these named styles. class NamedStyles include Google::Apis::Core::Hashable - # The named styles. - # There is an entry for each of the possible named style types. + # The named styles. There is an entry for each of the possible named style types. # Corresponds to the JSON property `styles` # @return [Array] attr_accessor :styles @@ -2848,16 +2726,14 @@ module Google end end - # The suggestion state of a NamedStyles - # message. + # The suggestion state of a NamedStyles message. class NamedStylesSuggestionState include Google::Apis::Core::Hashable # A mask that indicates which of the fields on the corresponding NamedStyle in - # styles have been changed in this - # suggestion. - # The order of these named style suggestion states match the order of the - # corresponding named style within the named styles suggestion. + # styles have been changed in this suggestion. The order of these named style + # suggestion states match the order of the corresponding named style within the + # named styles suggestion. # Corresponds to the JSON property `stylesSuggestionStates` # @return [Array] attr_accessor :styles_suggestion_states @@ -2877,67 +2753,49 @@ module Google class NestingLevel include Google::Apis::Core::Hashable - # The alignment of the bullet within the space allotted for rendering the - # bullet. + # The alignment of the bullet within the space allotted for rendering the bullet. # Corresponds to the JSON property `bulletAlignment` # @return [String] attr_accessor :bullet_alignment - # The format string used by bullets at this level of nesting. - # The glyph format contains one or more placeholders, and these placeholder - # are replaced with the appropriate values depending on the glyph_type or - # glyph_symbol. The placeholders follow - # the pattern `%[nesting_level]`. Furthermore, placeholders can have prefixes - # and suffixes. Thus, the glyph format follows the pattern - # `%[nesting_level]`. Note that the prefix and suffix are - # optional and can be arbitrary strings. - # For example, the glyph format `%0.` indicates that the rendered glyph will - # replace the placeholder with the corresponding glyph for nesting level 0 - # followed by a period as the suffix. So a list with a glyph type of - # UPPER_ALPHA and - # glyph format `%0.` at nesting level 0 will result in a list with rendered - # glyphs - #

`A.` - #

`B.` - #

`C.` - # The glyph format can contain placeholders for the current nesting level as - # well as placeholders for parent nesting levels. For example, a - # list can have a glyph format of `%0.` at nesting level 0 and a - # glyph format of `%0.%1.` at nesting level 1. Assuming both nesting levels - # have DECIMAL glyph - # types, this would result in a list with rendered glyphs - #

`1.` - #

`2.` - #

` 2.1.` - #

` 2.2.` - #

`3.` - # For nesting levels that are ordered, the string that replaces a placeholder - # in the glyph format for a particular paragraph depends on the paragraph's - # order within the list. + # The format string used by bullets at this level of nesting. The glyph format + # contains one or more placeholders, and these placeholder are replaced with the + # appropriate values depending on the glyph_type or glyph_symbol. The + # placeholders follow the pattern `%[nesting_level]`. Furthermore, placeholders + # can have prefixes and suffixes. Thus, the glyph format follows the pattern `%[ + # nesting_level]`. Note that the prefix and suffix are optional and can be + # arbitrary strings. For example, the glyph format `%0.` indicates that the + # rendered glyph will replace the placeholder with the corresponding glyph for + # nesting level 0 followed by a period as the suffix. So a list with a glyph + # type of UPPER_ALPHA and glyph format `%0.` at nesting level 0 will result in a + # list with rendered glyphs `A.` `B.` `C.` The glyph format can contain + # placeholders for the current nesting level as well as placeholders for parent + # nesting levels. For example, a list can have a glyph format of `%0.` at + # nesting level 0 and a glyph format of `%0.%1.` at nesting level 1. Assuming + # both nesting levels have DECIMAL glyph types, this would result in a list with + # rendered glyphs `1.` `2.` ` 2.1.` ` 2.2.` `3.` For nesting levels that are + # ordered, the string that replaces a placeholder in the glyph format for a + # particular paragraph depends on the paragraph's order within the list. # Corresponds to the JSON property `glyphFormat` # @return [String] attr_accessor :glyph_format - # A custom glyph symbol used by bullets when paragraphs at this level of - # nesting are unordered. - # The glyph symbol replaces placeholders within the glyph_format. For example, - # if the - # glyph_symbol is the solid circle corresponding to Unicode U+25cf code - # point and the glyph_format is `%0`, the rendered - # glyph would be the solid circle. + # A custom glyph symbol used by bullets when paragraphs at this level of nesting + # are unordered. The glyph symbol replaces placeholders within the glyph_format. + # For example, if the glyph_symbol is the solid circle corresponding to Unicode + # U+25cf code point and the glyph_format is `%0`, the rendered glyph would be + # the solid circle. # Corresponds to the JSON property `glyphSymbol` # @return [String] attr_accessor :glyph_symbol - # The type of glyph used by bullets when paragraphs at this level of - # nesting are ordered. - # The glyph type determines the type of glyph used to replace placeholders - # within the glyph_format - # when paragraphs at this level of nesting are ordered. For example, if the - # nesting level is 0, the glyph_format is `%0.` and the glyph - # type is DECIMAL, - # then the rendered glyph would replace the placeholder `%0` in the glyph - # format with a number corresponding to list item's order within the list. + # The type of glyph used by bullets when paragraphs at this level of nesting are + # ordered. The glyph type determines the type of glyph used to replace + # placeholders within the glyph_format when paragraphs at this level of nesting + # are ordered. For example, if the nesting level is 0, the glyph_format is `%0.` + # and the glyph type is DECIMAL, then the rendered glyph would replace the + # placeholder `%0` in the glyph format with a number corresponding to list item' + # s order within the list. # Corresponds to the JSON property `glyphType` # @return [String] attr_accessor :glyph_type @@ -2952,29 +2810,25 @@ module Google # @return [Google::Apis::DocsV1::Dimension] attr_accessor :indent_start - # The number of the first list item at this nesting level. - # A value of 0 is treated as a value of 1 for lettered lists and roman - # numeraled lists, i.e. for values of both 0 and 1, lettered and roman - # numeraled lists will begin at `a` and `i` respectively. - # This value is ignored for nesting levels with unordered glyphs. + # The number of the first list item at this nesting level. A value of 0 is + # treated as a value of 1 for lettered lists and roman numeraled lists, i.e. for + # values of both 0 and 1, lettered and roman numeraled lists will begin at `a` + # and `i` respectively. This value is ignored for nesting levels with unordered + # glyphs. # Corresponds to the JSON property `startNumber` # @return [Fixnum] attr_accessor :start_number - # Represents the styling that can be applied to text. - # Inherited text styles are represented as unset fields in this message. A - # text style's parent depends on where the text style is defined: - # * The TextStyle of text in a Paragraph - # inherits from the paragraph's corresponding named style type. - # * The TextStyle on a named style - # inherits from the normal text named style. - # * The TextStyle of the normal text named style inherits - # from the default text style in the Docs editor. - # * The TextStyle on a Paragraph element - # that is contained in a table may inherit its text style from the table - # style. - # If the text style does not inherit from a parent, unsetting fields will - # revert the style to a value matching the defaults in the Docs editor. + # Represents the styling that can be applied to text. Inherited text styles are + # represented as unset fields in this message. A text style's parent depends on + # where the text style is defined: * The TextStyle of text in a Paragraph + # inherits from the paragraph's corresponding named style type. * The TextStyle + # on a named style inherits from the normal text named style. * The TextStyle of + # the normal text named style inherits from the default text style in the Docs + # editor. * The TextStyle on a Paragraph element that is contained in a table + # may inherit its text style from the table style. If the text style does not + # inherit from a parent, unsetting fields will revert the style to a value + # matching the defaults in the Docs editor. # Corresponds to the JSON property `textStyle` # @return [Google::Apis::DocsV1::TextStyle] attr_accessor :text_style @@ -2997,63 +2851,56 @@ module Google end # A mask that indicates which of the fields on the base NestingLevel have been - # changed in this suggestion. For - # any field set to true, there is a new suggested value. + # changed in this suggestion. For any field set to true, there is a new + # suggested value. class NestingLevelSuggestionState include Google::Apis::Core::Hashable - # Indicates if there was a suggested change to - # bullet_alignment. + # Indicates if there was a suggested change to bullet_alignment. # Corresponds to the JSON property `bulletAlignmentSuggested` # @return [Boolean] attr_accessor :bullet_alignment_suggested alias_method :bullet_alignment_suggested?, :bullet_alignment_suggested - # Indicates if there was a suggested change to - # glyph_format. + # Indicates if there was a suggested change to glyph_format. # Corresponds to the JSON property `glyphFormatSuggested` # @return [Boolean] attr_accessor :glyph_format_suggested alias_method :glyph_format_suggested?, :glyph_format_suggested - # Indicates if there was a suggested change to - # glyph_symbol. + # Indicates if there was a suggested change to glyph_symbol. # Corresponds to the JSON property `glyphSymbolSuggested` # @return [Boolean] attr_accessor :glyph_symbol_suggested alias_method :glyph_symbol_suggested?, :glyph_symbol_suggested - # Indicates if there was a suggested change to - # glyph_type. + # Indicates if there was a suggested change to glyph_type. # Corresponds to the JSON property `glyphTypeSuggested` # @return [Boolean] attr_accessor :glyph_type_suggested alias_method :glyph_type_suggested?, :glyph_type_suggested - # Indicates if there was a suggested change to - # indent_first_line. + # Indicates if there was a suggested change to indent_first_line. # Corresponds to the JSON property `indentFirstLineSuggested` # @return [Boolean] attr_accessor :indent_first_line_suggested alias_method :indent_first_line_suggested?, :indent_first_line_suggested - # Indicates if there was a suggested change to - # indent_start. + # Indicates if there was a suggested change to indent_start. # Corresponds to the JSON property `indentStartSuggested` # @return [Boolean] attr_accessor :indent_start_suggested alias_method :indent_start_suggested?, :indent_start_suggested - # Indicates if there was a suggested change to - # start_number. + # Indicates if there was a suggested change to start_number. # Corresponds to the JSON property `startNumberSuggested` # @return [Boolean] attr_accessor :start_number_suggested alias_method :start_number_suggested?, :start_number_suggested # A mask that indicates which of the fields on the base TextStyle have been - # changed in this suggestion. - # For any field set to true, there is a new suggested value. + # changed in this suggestion. For any field set to true, there is a new + # suggested value. # Corresponds to the JSON property `textStyleSuggestionState` # @return [Google::Apis::DocsV1::TextStyleSuggestionState] attr_accessor :text_style_suggestion_state @@ -3113,21 +2960,19 @@ module Google end end - # A ParagraphElement representing a - # page break. A page break makes the subsequent text start at the top of the - # next page. + # A ParagraphElement representing a page break. A page break makes the + # subsequent text start at the top of the next page. class PageBreak include Google::Apis::Core::Hashable - # The suggested deletion IDs. If empty, then there are no suggested deletions - # of this content. + # The suggested deletion IDs. If empty, then there are no suggested deletions of + # this content. # Corresponds to the JSON property `suggestedDeletionIds` # @return [Array] attr_accessor :suggested_deletion_ids - # The suggested insertion IDs. A PageBreak - # may have multiple insertion IDs if it is a nested suggested change. If - # empty, then this is not a suggested insertion. + # The suggested insertion IDs. A PageBreak may have multiple insertion IDs if it + # is a nested suggested change. If empty, then this is not a suggested insertion. # Corresponds to the JSON property `suggestedInsertionIds` # @return [Array] attr_accessor :suggested_insertion_ids @@ -3137,20 +2982,16 @@ module Google # @return [Hash] attr_accessor :suggested_text_style_changes - # Represents the styling that can be applied to text. - # Inherited text styles are represented as unset fields in this message. A - # text style's parent depends on where the text style is defined: - # * The TextStyle of text in a Paragraph - # inherits from the paragraph's corresponding named style type. - # * The TextStyle on a named style - # inherits from the normal text named style. - # * The TextStyle of the normal text named style inherits - # from the default text style in the Docs editor. - # * The TextStyle on a Paragraph element - # that is contained in a table may inherit its text style from the table - # style. - # If the text style does not inherit from a parent, unsetting fields will - # revert the style to a value matching the defaults in the Docs editor. + # Represents the styling that can be applied to text. Inherited text styles are + # represented as unset fields in this message. A text style's parent depends on + # where the text style is defined: * The TextStyle of text in a Paragraph + # inherits from the paragraph's corresponding named style type. * The TextStyle + # on a named style inherits from the normal text named style. * The TextStyle of + # the normal text named style inherits from the default text style in the Docs + # editor. * The TextStyle on a Paragraph element that is contained in a table + # may inherit its text style from the table style. If the text style does not + # inherit from a parent, unsetting fields will revert the style to a value + # matching the defaults in the Docs editor. # Corresponds to the JSON property `textStyle` # @return [Google::Apis::DocsV1::TextStyle] attr_accessor :text_style @@ -3168,9 +3009,8 @@ module Google end end - # A StructuralElement representing a - # paragraph. A paragraph is a range of content that is terminated with a - # newline character. + # A StructuralElement representing a paragraph. A paragraph is a range of + # content that is terminated with a newline character. class Paragraph include Google::Apis::Core::Hashable @@ -3184,20 +3024,17 @@ module Google # @return [Array] attr_accessor :elements - # Styles that apply to a whole paragraph. - # Inherited paragraph styles are represented as unset fields in this message. - # A paragraph style's parent depends on where the paragraph style is defined: - # * The ParagraphStyle on a Paragraph - # inherits from the paragraph's corresponding named style type. - # * The ParagraphStyle on a named style - # inherits from the normal text named style. - # * The ParagraphStyle of the normal text named style inherits - # from the default paragraph style in the Docs editor. - # * The ParagraphStyle on a Paragraph - # element that is contained in a table may inherit its paragraph style from - # the table style. - # If the paragraph style does not inherit from a parent, unsetting fields will - # revert the style to a value matching the defaults in the Docs editor. + # Styles that apply to a whole paragraph. Inherited paragraph styles are + # represented as unset fields in this message. A paragraph style's parent + # depends on where the paragraph style is defined: * The ParagraphStyle on a + # Paragraph inherits from the paragraph's corresponding named style type. * The + # ParagraphStyle on a named style inherits from the normal text named style. * + # The ParagraphStyle of the normal text named style inherits from the default + # paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph + # element that is contained in a table may inherit its paragraph style from the + # table style. If the paragraph style does not inherit from a parent, unsetting + # fields will revert the style to a value matching the defaults in the Docs + # editor. # Corresponds to the JSON property `paragraphStyle` # @return [Google::Apis::DocsV1::ParagraphStyle] attr_accessor :paragraph_style @@ -3212,8 +3049,8 @@ module Google # @return [Hash] attr_accessor :suggested_bullet_changes - # The suggested paragraph style changes to this paragraph, keyed by - # suggestion ID. + # The suggested paragraph style changes to this paragraph, keyed by suggestion + # ID. # Corresponds to the JSON property `suggestedParagraphStyleChanges` # @return [Hash] attr_accessor :suggested_paragraph_style_changes @@ -3277,59 +3114,51 @@ module Google end end - # A ParagraphElement describes content within a - # Paragraph. + # A ParagraphElement describes content within a Paragraph. class ParagraphElement include Google::Apis::Core::Hashable - # A ParagraphElement representing a - # spot in the text that is dynamically replaced with content that can change - # over time, like a page number. + # A ParagraphElement representing a spot in the text that is dynamically + # replaced with content that can change over time, like a page number. # Corresponds to the JSON property `autoText` # @return [Google::Apis::DocsV1::AutoText] attr_accessor :auto_text - # A ParagraphElement representing a - # column break. A column break makes the subsequent text start at the top of - # the next column. + # A ParagraphElement representing a column break. A column break makes the + # subsequent text start at the top of the next column. # Corresponds to the JSON property `columnBreak` # @return [Google::Apis::DocsV1::ColumnBreak] attr_accessor :column_break - # The zero-base end index of this paragraph element, exclusive, in UTF-16 - # code units. + # The zero-base end index of this paragraph element, exclusive, in UTF-16 code + # units. # Corresponds to the JSON property `endIndex` # @return [Fixnum] attr_accessor :end_index - # A ParagraphElement representing an - # equation. + # A ParagraphElement representing an equation. # Corresponds to the JSON property `equation` # @return [Google::Apis::DocsV1::Equation] attr_accessor :equation - # A ParagraphElement representing a - # footnote reference. A footnote reference is the inline content rendered with - # a number and is used to identify the footnote. + # A ParagraphElement representing a footnote reference. A footnote reference is + # the inline content rendered with a number and is used to identify the footnote. # Corresponds to the JSON property `footnoteReference` # @return [Google::Apis::DocsV1::FootnoteReference] attr_accessor :footnote_reference - # A ParagraphElement representing a - # horizontal line. + # A ParagraphElement representing a horizontal line. # Corresponds to the JSON property `horizontalRule` # @return [Google::Apis::DocsV1::HorizontalRule] attr_accessor :horizontal_rule - # A ParagraphElement that contains - # an InlineObject. + # A ParagraphElement that contains an InlineObject. # Corresponds to the JSON property `inlineObjectElement` # @return [Google::Apis::DocsV1::InlineObjectElement] attr_accessor :inline_object_element - # A ParagraphElement representing a - # page break. A page break makes the subsequent text start at the top of the - # next page. + # A ParagraphElement representing a page break. A page break makes the + # subsequent text start at the top of the next page. # Corresponds to the JSON property `pageBreak` # @return [Google::Apis::DocsV1::PageBreak] attr_accessor :page_break @@ -3339,8 +3168,7 @@ module Google # @return [Fixnum] attr_accessor :start_index - # A ParagraphElement that represents a - # run of text that all has the same styling. + # A ParagraphElement that represents a run of text that all has the same styling. # Corresponds to the JSON property `textRun` # @return [Google::Apis::DocsV1::TextRun] attr_accessor :text_run @@ -3364,20 +3192,17 @@ module Google end end - # Styles that apply to a whole paragraph. - # Inherited paragraph styles are represented as unset fields in this message. - # A paragraph style's parent depends on where the paragraph style is defined: - # * The ParagraphStyle on a Paragraph - # inherits from the paragraph's corresponding named style type. - # * The ParagraphStyle on a named style - # inherits from the normal text named style. - # * The ParagraphStyle of the normal text named style inherits - # from the default paragraph style in the Docs editor. - # * The ParagraphStyle on a Paragraph - # element that is contained in a table may inherit its paragraph style from - # the table style. - # If the paragraph style does not inherit from a parent, unsetting fields will - # revert the style to a value matching the defaults in the Docs editor. + # Styles that apply to a whole paragraph. Inherited paragraph styles are + # represented as unset fields in this message. A paragraph style's parent + # depends on where the paragraph style is defined: * The ParagraphStyle on a + # Paragraph inherits from the paragraph's corresponding named style type. * The + # ParagraphStyle on a named style inherits from the normal text named style. * + # The ParagraphStyle of the normal text named style inherits from the default + # paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph + # element that is contained in a table may inherit its paragraph style from the + # table style. If the paragraph style does not inherit from a parent, unsetting + # fields will revert the style to a value matching the defaults in the Docs + # editor. class ParagraphStyle include Google::Apis::Core::Hashable @@ -3386,8 +3211,8 @@ module Google # @return [String] attr_accessor :alignment - # Whether to avoid widows and orphans for the paragraph. If unset, the value - # is inherited from the parent. + # Whether to avoid widows and orphans for the paragraph. If unset, the value is + # inherited from the parent. # Corresponds to the JSON property `avoidWidowAndOrphan` # @return [Boolean] attr_accessor :avoid_widow_and_orphan @@ -3419,15 +3244,13 @@ module Google attr_accessor :border_top # The text direction of this paragraph. If unset, the value defaults to - # LEFT_TO_RIGHT since - # paragraph direction is not inherited. + # LEFT_TO_RIGHT since paragraph direction is not inherited. # Corresponds to the JSON property `direction` # @return [String] attr_accessor :direction # The heading ID of the paragraph. If empty, then this paragraph is not a - # heading. - # This property is read-only. + # heading. This property is read-only. # Corresponds to the JSON property `headingId` # @return [String] attr_accessor :heading_id @@ -3454,24 +3277,23 @@ module Google attr_accessor :keep_lines_together alias_method :keep_lines_together?, :keep_lines_together - # Whether at least a part of this paragraph should be laid out on the same - # page or column as the next paragraph if possible. If unset, the value is - # inherited from the parent. + # Whether at least a part of this paragraph should be laid out on the same page + # or column as the next paragraph if possible. If unset, the value is inherited + # from the parent. # Corresponds to the JSON property `keepWithNext` # @return [Boolean] attr_accessor :keep_with_next alias_method :keep_with_next?, :keep_with_next - # The amount of space between lines, as a percentage of normal, where normal - # is represented as 100.0. If unset, the value is inherited from the parent. + # The amount of space between lines, as a percentage of normal, where normal is + # represented as 100.0. If unset, the value is inherited from the parent. # Corresponds to the JSON property `lineSpacing` # @return [Float] attr_accessor :line_spacing - # The named style type of the paragraph. - # Since updating the named style type affects other properties within - # ParagraphStyle, the named style type is applied before the other properties - # are updated. + # The named style type of the paragraph. Since updating the named style type + # affects other properties within ParagraphStyle, the named style type is + # applied before the other properties are updated. # Corresponds to the JSON property `namedStyleType` # @return [String] attr_accessor :named_style_type @@ -3497,8 +3319,7 @@ module Google attr_accessor :spacing_mode # A list of the tab stops for this paragraph. The list of tab stops is not - # inherited. - # This property is read-only. + # inherited. This property is read-only. # Corresponds to the JSON property `tabStops` # @return [Array] attr_accessor :tab_stops @@ -3534,8 +3355,8 @@ module Google end # A mask that indicates which of the fields on the base ParagraphStyle have been - # changed in this suggestion. - # For any field set to true, there is a new suggested value. + # changed in this suggestion. For any field set to true, there is a new + # suggested value. class ParagraphStyleSuggestionState include Google::Apis::Core::Hashable @@ -3636,8 +3457,8 @@ module Google alias_method :named_style_type_suggested?, :named_style_type_suggested # A mask that indicates which of the fields on the base Shading have been - # changed in this - # suggested change. For any field set to true, there is a new suggested value. + # changed in this suggested change. For any field set to true, there is a new + # suggested value. # Corresponds to the JSON property `shadingSuggestionState` # @return [Google::Apis::DocsV1::ShadingSuggestionState] attr_accessor :shading_suggestion_state @@ -3689,10 +3510,9 @@ module Google end end - # An object that is tethered to a Paragraph - # and positioned relative to the beginning of the paragraph. A PositionedObject - # contains an EmbeddedObject such as an - # image. + # An object that is tethered to a Paragraph and positioned relative to the + # beginning of the paragraph. A PositionedObject contains an EmbeddedObject such + # as an image. class PositionedObject include Google::Apis::Core::Hashable @@ -3706,20 +3526,19 @@ module Google # @return [Google::Apis::DocsV1::PositionedObjectProperties] attr_accessor :positioned_object_properties - # The suggested deletion IDs. If empty, then there are no suggested deletions - # of this content. + # The suggested deletion IDs. If empty, then there are no suggested deletions of + # this content. # Corresponds to the JSON property `suggestedDeletionIds` # @return [Array] attr_accessor :suggested_deletion_ids - # The suggested insertion ID. If empty, then this is not a suggested - # insertion. + # The suggested insertion ID. If empty, then this is not a suggested insertion. # Corresponds to the JSON property `suggestedInsertionId` # @return [String] attr_accessor :suggested_insertion_id - # The suggested changes to the positioned object properties, keyed by - # suggestion ID. + # The suggested changes to the positioned object properties, keyed by suggestion + # ID. # Corresponds to the JSON property `suggestedPositionedObjectPropertiesChanges` # @return [Hash] attr_accessor :suggested_positioned_object_properties_changes @@ -3739,8 +3558,7 @@ module Google end # The positioning of a PositionedObject. The positioned object is positioned - # relative to the beginning of the Paragraph - # it is tethered to. + # relative to the beginning of the Paragraph it is tethered to. class PositionedObjectPositioning include Google::Apis::Core::Hashable @@ -3772,8 +3590,8 @@ module Google end # A mask that indicates which of the fields on the base - # PositionedObjectPositioning have been changed in this - # suggestion. For any field set to true, there is a new suggested value. + # PositionedObjectPositioning have been changed in this suggestion. For any + # field set to true, there is a new suggested value. class PositionedObjectPositioningSuggestionState include Google::Apis::Core::Hashable @@ -3817,8 +3635,7 @@ module Google attr_accessor :embedded_object # The positioning of a PositionedObject. The positioned object is positioned - # relative to the beginning of the Paragraph - # it is tethered to. + # relative to the beginning of the Paragraph it is tethered to. # Corresponds to the JSON property `positioning` # @return [Google::Apis::DocsV1::PositionedObjectPositioning] attr_accessor :positioning @@ -3835,22 +3652,21 @@ module Google end # A mask that indicates which of the fields on the base - # PositionedObjectProperties - # have been changed in this suggestion. For any field set to true, there is a - # new suggested value. + # PositionedObjectProperties have been changed in this suggestion. For any field + # set to true, there is a new suggested value. class PositionedObjectPropertiesSuggestionState include Google::Apis::Core::Hashable # A mask that indicates which of the fields on the base EmbeddedObject have been - # changed in this suggestion. - # For any field set to true, there is a new suggested value. + # changed in this suggestion. For any field set to true, there is a new + # suggested value. # Corresponds to the JSON property `embeddedObjectSuggestionState` # @return [Google::Apis::DocsV1::EmbeddedObjectSuggestionState] attr_accessor :embedded_object_suggestion_state # A mask that indicates which of the fields on the base - # PositionedObjectPositioning have been changed in this - # suggestion. For any field set to true, there is a new suggested value. + # PositionedObjectPositioning have been changed in this suggestion. For any + # field set to true, there is a new suggested value. # Corresponds to the JSON property `positioningSuggestionState` # @return [Google::Apis::DocsV1::PositionedObjectPositioningSuggestionState] attr_accessor :positioning_suggestion_state @@ -3870,22 +3686,22 @@ module Google class Range include Google::Apis::Core::Hashable - # The zero-based end index of this range, exclusive, in UTF-16 code units. - # In all current uses, an end index must be provided. This field is an - # Int32Value in order to accommodate future use cases with open-ended ranges. + # The zero-based end index of this range, exclusive, in UTF-16 code units. In + # all current uses, an end index must be provided. This field is an Int32Value + # in order to accommodate future use cases with open-ended ranges. # Corresponds to the JSON property `endIndex` # @return [Fixnum] attr_accessor :end_index - # The ID of the header, footer or footnote that this range is contained in. - # An empty segment ID signifies the document's body. + # The ID of the header, footer or footnote that this range is contained in. An + # empty segment ID signifies the document's body. # Corresponds to the JSON property `segmentId` # @return [String] attr_accessor :segment_id - # The zero-based start index of this range, in UTF-16 code units. - # In all current uses, a start index must be provided. This field is an - # Int32Value in order to accommodate future use cases with open-ended ranges. + # The zero-based start index of this range, in UTF-16 code units. In all current + # uses, a start index must be provided. This field is an Int32Value in order to + # accommodate future use cases with open-ended ranges. # Corresponds to the JSON property `startIndex` # @return [Fixnum] attr_accessor :start_index @@ -3946,10 +3762,9 @@ module Google end end - # Replaces an existing image with a new image. - # Replacing an image removes some image effects from the existing image in order - # to - # mirror the behavior of the Docs editor. + # Replaces an existing image with a new image. Replacing an image removes some + # image effects from the existing image in order to mirror the behavior of the + # Docs editor. class ReplaceImageRequest include Google::Apis::Core::Hashable @@ -3963,12 +3778,11 @@ module Google # @return [String] attr_accessor :image_replace_method - # The URI of the new image. - # The image is fetched once at insertion time and a copy is stored for - # display inside the document. Images must be less than 50MB in size, cannot - # exceed 25 megapixels, and must be in one of PNG, JPEG, or GIF format. - # The provided URI can be at most 2 kB in length. The URI itself is saved - # with the image, and exposed via the ImageProperties.source_uri field. + # The URI of the new image. The image is fetched once at insertion time and a + # copy is stored for display inside the document. Images must be less than 50MB + # in size, cannot exceed 25 megapixels, and must be in one of PNG, JPEG, or GIF + # format. The provided URI can be at most 2 kB in length. The URI itself is + # saved with the image, and exposed via the ImageProperties.source_uri field. # Corresponds to the JSON property `uri` # @return [String] attr_accessor :uri @@ -3985,32 +3799,25 @@ module Google end end - # Replaces the contents of the specified - # NamedRange or - # NamedRanges with the given replacement - # content. - # Note that an individual NamedRange may - # consist of multiple discontinuous - # ranges. In this case, only the - # content in the first range will be replaced. The other ranges and their - # content will be deleted. - # In cases where replacing or deleting any ranges would result in an invalid + # Replaces the contents of the specified NamedRange or NamedRanges with the + # given replacement content. Note that an individual NamedRange may consist of + # multiple discontinuous ranges. In this case, only the content in the first + # range will be replaced. The other ranges and their content will be deleted. In + # cases where replacing or deleting any ranges would result in an invalid # document structure, a 400 bad request error is returned. class ReplaceNamedRangeContentRequest include Google::Apis::Core::Hashable - # The ID of the named range whose content will be replaced. - # If there is no named range with the given ID a 400 bad request error is - # returned. + # The ID of the named range whose content will be replaced. If there is no named + # range with the given ID a 400 bad request error is returned. # Corresponds to the JSON property `namedRangeId` # @return [String] attr_accessor :named_range_id - # The name of the NamedRanges whose - # content will be replaced. - # If there are multiple named ranges with the given name, then - # the content of each one will be replaced. If there are no named ranges - # with the given name, then the request will be a no-op. + # The name of the NamedRanges whose content will be replaced. If there are + # multiple named ranges with the given name, then the content of each one will + # be replaced. If there are no named ranges with the given name, then the + # request will be a no-op. # Corresponds to the JSON property `namedRangeName` # @return [String] attr_accessor :named_range_name @@ -4036,37 +3843,30 @@ module Google class Request include Google::Apis::Core::Hashable - # Creates a Footer. The new footer is applied to - # the SectionStyle at the location of the - # SectionBreak if specificed, otherwise - # it is applied to the DocumentStyle. - # If a footer of the specified type already exists, a 400 bad request error - # is returned. + # Creates a Footer. The new footer is applied to the SectionStyle at the + # location of the SectionBreak if specificed, otherwise it is applied to the + # DocumentStyle. If a footer of the specified type already exists, a 400 bad + # request error is returned. # Corresponds to the JSON property `createFooter` # @return [Google::Apis::DocsV1::CreateFooterRequest] attr_accessor :create_footer - # Creates a Footnote segment - # and inserts a new FootnoteReference - # to it at the given location. - # The new Footnote segment will contain a - # space followed by a newline character. + # Creates a Footnote segment and inserts a new FootnoteReference to it at the + # given location. The new Footnote segment will contain a space followed by a + # newline character. # Corresponds to the JSON property `createFootnote` # @return [Google::Apis::DocsV1::CreateFootnoteRequest] attr_accessor :create_footnote - # Creates a Header. The new header is applied to - # the SectionStyle at the location of the - # SectionBreak if specificed, otherwise - # it is applied to the DocumentStyle. - # If a header of the specified type already exists, a 400 bad request error - # is returned. + # Creates a Header. The new header is applied to the SectionStyle at the + # location of the SectionBreak if specificed, otherwise it is applied to the + # DocumentStyle. If a header of the specified type already exists, a 400 bad + # request error is returned. # Corresponds to the JSON property `createHeader` # @return [Google::Apis::DocsV1::CreateHeaderRequest] attr_accessor :create_header - # Creates a NamedRange referencing the given - # range. + # Creates a NamedRange referencing the given range. # Corresponds to the JSON property `createNamedRange` # @return [Google::Apis::DocsV1::CreateNamedRangeRequest] attr_accessor :create_named_range @@ -4075,10 +3875,9 @@ module Google # The nesting level of each paragraph will be determined by counting leading # tabs in front of each paragraph. To avoid excess space between the bullet and # the corresponding paragraph, these leading tabs are removed by this request. - # This may change the indices of parts of the text. - # If the paragraph immediately before paragraphs being updated is in a list - # with a matching preset, the paragraphs being updated are added to that - # preceding list. + # This may change the indices of parts of the text. If the paragraph immediately + # before paragraphs being updated is in a list with a matching preset, the + # paragraphs being updated are added to that preceding list. # Corresponds to the JSON property `createParagraphBullets` # @return [Google::Apis::DocsV1::CreateParagraphBulletsRequest] attr_accessor :create_paragraph_bullets @@ -4110,8 +3909,7 @@ module Google # @return [Google::Apis::DocsV1::DeleteParagraphBulletsRequest] attr_accessor :delete_paragraph_bullets - # Deletes a PositionedObject from the - # document. + # Deletes a PositionedObject from the document. # Corresponds to the JSON property `deletePositionedObject` # @return [Google::Apis::DocsV1::DeletePositionedObjectRequest] attr_accessor :delete_positioned_object @@ -4126,8 +3924,7 @@ module Google # @return [Google::Apis::DocsV1::DeleteTableRowRequest] attr_accessor :delete_table_row - # Inserts an InlineObject containing an - # image at the given location. + # Inserts an InlineObject containing an image at the given location. # Corresponds to the JSON property `insertInlineImage` # @return [Google::Apis::DocsV1::InsertInlineImageRequest] attr_accessor :insert_inline_image @@ -4137,14 +3934,14 @@ module Google # @return [Google::Apis::DocsV1::InsertPageBreakRequest] attr_accessor :insert_page_break - # Inserts a section break at the given location. - # A newline character will be inserted before the section break. + # Inserts a section break at the given location. A newline character will be + # inserted before the section break. # Corresponds to the JSON property `insertSectionBreak` # @return [Google::Apis::DocsV1::InsertSectionBreakRequest] attr_accessor :insert_section_break - # Inserts a table at the specified location. - # A newline character will be inserted before the inserted table. + # Inserts a table at the specified location. A newline character will be + # inserted before the inserted table. # Corresponds to the JSON property `insertTable` # @return [Google::Apis::DocsV1::InsertTableRequest] attr_accessor :insert_table @@ -4174,24 +3971,18 @@ module Google # @return [Google::Apis::DocsV1::ReplaceAllTextRequest] attr_accessor :replace_all_text - # Replaces an existing image with a new image. - # Replacing an image removes some image effects from the existing image in order - # to - # mirror the behavior of the Docs editor. + # Replaces an existing image with a new image. Replacing an image removes some + # image effects from the existing image in order to mirror the behavior of the + # Docs editor. # Corresponds to the JSON property `replaceImage` # @return [Google::Apis::DocsV1::ReplaceImageRequest] attr_accessor :replace_image - # Replaces the contents of the specified - # NamedRange or - # NamedRanges with the given replacement - # content. - # Note that an individual NamedRange may - # consist of multiple discontinuous - # ranges. In this case, only the - # content in the first range will be replaced. The other ranges and their - # content will be deleted. - # In cases where replacing or deleting any ranges would result in an invalid + # Replaces the contents of the specified NamedRange or NamedRanges with the + # given replacement content. Note that an individual NamedRange may consist of + # multiple discontinuous ranges. In this case, only the content in the first + # range will be replaced. The other ranges and their content will be deleted. In + # cases where replacing or deleting any ranges would result in an invalid # document structure, a 400 bad request error is returned. # Corresponds to the JSON property `replaceNamedRangeContent` # @return [Google::Apis::DocsV1::ReplaceNamedRangeContentRequest] @@ -4222,15 +4013,12 @@ module Google # @return [Google::Apis::DocsV1::UpdateTableCellStyleRequest] attr_accessor :update_table_cell_style - # Updates the - # TableColumnProperties of columns - # in a table. + # Updates the TableColumnProperties of columns in a table. # Corresponds to the JSON property `updateTableColumnProperties` # @return [Google::Apis::DocsV1::UpdateTableColumnPropertiesRequest] attr_accessor :update_table_column_properties - # Updates the TableRowStyle of rows in a - # table. + # Updates the TableRowStyle of rows in a table. # Corresponds to the JSON property `updateTableRowStyle` # @return [Google::Apis::DocsV1::UpdateTableRowStyleRequest] attr_accessor :update_table_row_style @@ -4367,12 +4155,10 @@ module Google end end - # A StructuralElement representing a - # section break. A section is a range of content which has the same - # SectionStyle. A section break represents - # the start of a new section, and the section style applies to the section - # after the section break. - # The document body always begins with a section break. + # A StructuralElement representing a section break. A section is a range of + # content which has the same SectionStyle. A section break represents the start + # of a new section, and the section style applies to the section after the + # section break. The document body always begins with a section break. class SectionBreak include Google::Apis::Core::Hashable @@ -4381,15 +4167,14 @@ module Google # @return [Google::Apis::DocsV1::SectionStyle] attr_accessor :section_style - # The suggested deletion IDs. If empty, then there are no suggested deletions - # of this content. + # The suggested deletion IDs. If empty, then there are no suggested deletions of + # this content. # Corresponds to the JSON property `suggestedDeletionIds` # @return [Array] attr_accessor :suggested_deletion_ids # The suggested insertion IDs. A SectionBreak may have multiple insertion IDs if - # it is - # a nested suggested change. If empty, then this is not a suggested + # it is a nested suggested change. If empty, then this is not a suggested # insertion. # Corresponds to the JSON property `suggestedInsertionIds` # @return [Array] @@ -4436,102 +4221,81 @@ module Google class SectionStyle include Google::Apis::Core::Hashable - # The section's columns properties. - # If empty, the section contains one column with the default properties in - # the Docs editor. - # A section can be updated to have no more than three columns. - # When updating this property, setting a concrete value is required. - # Unsetting this property will result in a 400 bad request error. + # The section's columns properties. If empty, the section contains one column + # with the default properties in the Docs editor. A section can be updated to + # have no more than three columns. When updating this property, setting a + # concrete value is required. Unsetting this property will result in a 400 bad + # request error. # Corresponds to the JSON property `columnProperties` # @return [Array] attr_accessor :column_properties - # The style of column separators. - # This style can be set even when there is one column in the section. - # When updating this property, setting a concrete value is required. - # Unsetting this property results in a 400 bad request error. + # The style of column separators. This style can be set even when there is one + # column in the section. When updating this property, setting a concrete value + # is required. Unsetting this property results in a 400 bad request error. # Corresponds to the JSON property `columnSeparatorStyle` # @return [String] attr_accessor :column_separator_style # The content direction of this section. If unset, the value defaults to - # LEFT_TO_RIGHT. - # When updating this property, setting a concrete value is required. - # Unsetting this property results in a 400 bad request error. + # LEFT_TO_RIGHT. When updating this property, setting a concrete value is + # required. Unsetting this property results in a 400 bad request error. # Corresponds to the JSON property `contentDirection` # @return [String] attr_accessor :content_direction - # The ID of the default footer. If unset, the value inherits from the - # previous SectionBreak's SectionStyle. - # If the value is unset in the first SectionBreak, it inherits from - # DocumentStyle's default_footer_id. - # This property is read-only. + # The ID of the default footer. If unset, the value inherits from the previous + # SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, + # it inherits from DocumentStyle's default_footer_id. This property is read-only. # Corresponds to the JSON property `defaultFooterId` # @return [String] attr_accessor :default_footer_id - # The ID of the default header. If unset, the value inherits from the - # previous SectionBreak's SectionStyle. - # If the value is unset in the first SectionBreak, it inherits from - # DocumentStyle's default_header_id. - # This property is read-only. + # The ID of the default header. If unset, the value inherits from the previous + # SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, + # it inherits from DocumentStyle's default_header_id. This property is read-only. # Corresponds to the JSON property `defaultHeaderId` # @return [String] attr_accessor :default_header_id - # The ID of the footer used only for even pages. If the value of - # DocumentStyle's use_even_page_header_footer is true, - # this value is used for the footers on even pages in the section. If it - # is false, the footers on even pages uses the default_footer_id. If unset, the - # value - # inherits from the previous SectionBreak's SectionStyle. If the value is unset - # in - # the first SectionBreak, it inherits from DocumentStyle's - # even_page_footer_id. - # This property is read-only. + # The ID of the footer used only for even pages. If the value of DocumentStyle's + # use_even_page_header_footer is true, this value is used for the footers on + # even pages in the section. If it is false, the footers on even pages uses the + # default_footer_id. If unset, the value inherits from the previous SectionBreak' + # s SectionStyle. If the value is unset in the first SectionBreak, it inherits + # from DocumentStyle's even_page_footer_id. This property is read-only. # Corresponds to the JSON property `evenPageFooterId` # @return [String] attr_accessor :even_page_footer_id - # The ID of the header used only for even pages. If the value of - # DocumentStyle's use_even_page_header_footer is true, - # this value is used for the headers on even pages in the section. If it - # is false, the headers on even pages uses the default_header_id. If unset, the - # value - # inherits from the previous SectionBreak's SectionStyle. If the value is unset - # in - # the first SectionBreak, it inherits from DocumentStyle's - # even_page_header_id. - # This property is read-only. + # The ID of the header used only for even pages. If the value of DocumentStyle's + # use_even_page_header_footer is true, this value is used for the headers on + # even pages in the section. If it is false, the headers on even pages uses the + # default_header_id. If unset, the value inherits from the previous SectionBreak' + # s SectionStyle. If the value is unset in the first SectionBreak, it inherits + # from DocumentStyle's even_page_header_id. This property is read-only. # Corresponds to the JSON property `evenPageHeaderId` # @return [String] attr_accessor :even_page_header_id - # The ID of the footer used only for the first page of the section. - # If use_first_page_header_footer is true, - # this value is used for the footer on the first page of the section. If - # it is false, the footer on the first page of the section uses the - # default_footer_id. - # If unset, the value inherits from the previous SectionBreak's SectionStyle. If - # the value is unset in - # the first SectionBreak, it inherits from DocumentStyle's - # first_page_footer_id. - # This property is read-only. + # The ID of the footer used only for the first page of the section. If + # use_first_page_header_footer is true, this value is used for the footer on the + # first page of the section. If it is false, the footer on the first page of the + # section uses the default_footer_id. If unset, the value inherits from the + # previous SectionBreak's SectionStyle. If the value is unset in the first + # SectionBreak, it inherits from DocumentStyle's first_page_footer_id. This + # property is read-only. # Corresponds to the JSON property `firstPageFooterId` # @return [String] attr_accessor :first_page_footer_id - # The ID of the header used only for the first page of the section. - # If use_first_page_header_footer is true, - # this value is used for the header on the first page of the section. If - # it is false, the header on the first page of the section uses the - # default_header_id. - # If unset, the value inherits from the previous SectionBreak's SectionStyle. If - # the value is unset in - # the first SectionBreak, it inherits from DocumentStyle's - # first_page_header_id. - # This property is read-only. + # The ID of the header used only for the first page of the section. If + # use_first_page_header_footer is true, this value is used for the header on the + # first page of the section. If it is false, the header on the first page of the + # section uses the default_header_id. If unset, the value inherits from the + # previous SectionBreak's SectionStyle. If the value is unset in the first + # SectionBreak, it inherits from DocumentStyle's first_page_header_id. This + # property is read-only. # Corresponds to the JSON property `firstPageHeaderId` # @return [String] attr_accessor :first_page_header_id @@ -4567,12 +4331,10 @@ module Google attr_accessor :margin_top # The page number from which to start counting the number of pages for this - # section. If unset, page numbering continues from the previous section. - # If the value is unset in the first - # SectionBreak, refer to DocumentStyle's - # page_number_start. - # When updating this property, setting a concrete value is required. - # Unsetting this property results in a 400 bad request error. + # section. If unset, page numbering continues from the previous section. If the + # value is unset in the first SectionBreak, refer to DocumentStyle's + # page_number_start. When updating this property, setting a concrete value is + # required. Unsetting this property results in a 400 bad request error. # Corresponds to the JSON property `pageNumberStart` # @return [Fixnum] attr_accessor :page_number_start @@ -4582,13 +4344,12 @@ module Google # @return [String] attr_accessor :section_type - # Indicates whether to use the first page header / footer IDs for the first - # page of the section. If unset, it inherits from DocumentStyle's - # use_first_page_header_footer for the - # first section. If the value is unset for subsequent sectors, it should be - # interpreted as false. - # When updating this property, setting a concrete value is required. - # Unsetting this property results in a 400 bad request error. + # Indicates whether to use the first page header / footer IDs for the first page + # of the section. If unset, it inherits from DocumentStyle's + # use_first_page_header_footer for the first section. If the value is unset for + # subsequent sectors, it should be interpreted as false. When updating this + # property, setting a concrete value is required. Unsetting this property + # results in a 400 bad request error. # Corresponds to the JSON property `useFirstPageHeaderFooter` # @return [Boolean] attr_accessor :use_first_page_header_footer @@ -4641,8 +4402,8 @@ module Google end # A mask that indicates which of the fields on the base Shading have been - # changed in this - # suggested change. For any field set to true, there is a new suggested value. + # changed in this suggested change. For any field set to true, there is a new + # suggested value. class ShadingSuggestionState include Google::Apis::Core::Hashable @@ -4666,8 +4427,7 @@ module Google class SheetsChartReference include Google::Apis::Core::Hashable - # The ID of the specific chart in the Google Sheets spreadsheet that is - # embedded. + # The ID of the specific chart in the Google Sheets spreadsheet that is embedded. # Corresponds to the JSON property `chartId` # @return [Fixnum] attr_accessor :chart_id @@ -4689,8 +4449,8 @@ module Google end # A mask that indicates which of the fields on the base SheetsChartReference - # have been changed in this - # suggestion. For any field set to true, there is a new suggested value. + # have been changed in this suggestion. For any field set to true, there is a + # new suggested value. class SheetsChartReferenceSuggestionState include Google::Apis::Core::Hashable @@ -4743,9 +4503,8 @@ module Google end # A mask that indicates which of the fields on the base Size have been changed - # in this suggestion. - # For any field set to true, the Size has - # a new suggested value. + # in this suggestion. For any field set to true, the Size has a new suggested + # value. class SizeSuggestionState include Google::Apis::Core::Hashable @@ -4772,48 +4531,41 @@ module Google end end - # A StructuralElement describes content that provides structure to the - # document. + # A StructuralElement describes content that provides structure to the document. class StructuralElement include Google::Apis::Core::Hashable - # The zero-based end index of this structural element, exclusive, in UTF-16 - # code units. + # The zero-based end index of this structural element, exclusive, in UTF-16 code + # units. # Corresponds to the JSON property `endIndex` # @return [Fixnum] attr_accessor :end_index - # A StructuralElement representing a - # paragraph. A paragraph is a range of content that is terminated with a - # newline character. + # A StructuralElement representing a paragraph. A paragraph is a range of + # content that is terminated with a newline character. # Corresponds to the JSON property `paragraph` # @return [Google::Apis::DocsV1::Paragraph] attr_accessor :paragraph - # A StructuralElement representing a - # section break. A section is a range of content which has the same - # SectionStyle. A section break represents - # the start of a new section, and the section style applies to the section - # after the section break. - # The document body always begins with a section break. + # A StructuralElement representing a section break. A section is a range of + # content which has the same SectionStyle. A section break represents the start + # of a new section, and the section style applies to the section after the + # section break. The document body always begins with a section break. # Corresponds to the JSON property `sectionBreak` # @return [Google::Apis::DocsV1::SectionBreak] attr_accessor :section_break - # The zero-based start index of this structural element, in UTF-16 code - # units. + # The zero-based start index of this structural element, in UTF-16 code units. # Corresponds to the JSON property `startIndex` # @return [Fixnum] attr_accessor :start_index - # A StructuralElement representing a - # table. + # A StructuralElement representing a table. # Corresponds to the JSON property `table` # @return [Google::Apis::DocsV1::Table] attr_accessor :table - # A StructuralElement representing - # a table of contents. + # A StructuralElement representing a table of contents. # Corresponds to the JSON property `tableOfContents` # @return [Google::Apis::DocsV1::TableOfContents] attr_accessor :table_of_contents @@ -4837,9 +4589,8 @@ module Google class SubstringMatchCriteria include Google::Apis::Core::Hashable - # Indicates whether the search should respect case: - # - `True`: the search is case sensitive. - # - `False`: the search is case insensitive. + # Indicates whether the search should respect case: - `True`: the search is case + # sensitive. - `False`: the search is case insensitive. # Corresponds to the JSON property `matchCase` # @return [Boolean] attr_accessor :match_case @@ -4870,9 +4621,8 @@ module Google # @return [Google::Apis::DocsV1::Bullet] attr_accessor :bullet - # A mask that indicates which of the fields on the base - # Bullet have been changed in this suggestion. - # For any field set to true, there is a new suggested value. + # A mask that indicates which of the fields on the base Bullet have been changed + # in this suggestion. For any field set to true, there is a new suggested value. # Corresponds to the JSON property `bulletSuggestionState` # @return [Google::Apis::DocsV1::BulletSuggestionState] attr_accessor :bullet_suggestion_state @@ -4898,8 +4648,8 @@ module Google attr_accessor :document_style # A mask that indicates which of the fields on the base DocumentStyle have been - # changed in this suggestion. - # For any field set to true, there is a new suggested value. + # changed in this suggestion. For any field set to true, there is a new + # suggested value. # Corresponds to the JSON property `documentStyleSuggestionState` # @return [Google::Apis::DocsV1::DocumentStyleSuggestionState] attr_accessor :document_style_suggestion_state @@ -4924,10 +4674,9 @@ module Google # @return [Google::Apis::DocsV1::InlineObjectProperties] attr_accessor :inline_object_properties - # A mask that indicates which of the fields on the base - # InlineObjectProperties have - # been changed in this suggestion. For any field set to true, there is a new - # suggested value. + # A mask that indicates which of the fields on the base InlineObjectProperties + # have been changed in this suggestion. For any field set to true, there is a + # new suggested value. # Corresponds to the JSON property `inlineObjectPropertiesSuggestionState` # @return [Google::Apis::DocsV1::InlineObjectPropertiesSuggestionState] attr_accessor :inline_object_properties_suggestion_state @@ -4947,15 +4696,15 @@ module Google class SuggestedListProperties include Google::Apis::Core::Hashable - # The properties of a list which describe the look - # and feel of bullets belonging to paragraphs associated with a list. + # The properties of a list which describe the look and feel of bullets belonging + # to paragraphs associated with a list. # Corresponds to the JSON property `listProperties` # @return [Google::Apis::DocsV1::ListProperties] attr_accessor :list_properties # A mask that indicates which of the fields on the base ListProperties have been - # changed in this suggestion. - # For any field set to true, there is a new suggested value. + # changed in this suggestion. For any field set to true, there is a new + # suggested value. # Corresponds to the JSON property `listPropertiesSuggestionState` # @return [Google::Apis::DocsV1::ListPropertiesSuggestionState] attr_accessor :list_properties_suggestion_state @@ -4975,15 +4724,13 @@ module Google class SuggestedNamedStyles include Google::Apis::Core::Hashable - # The named styles. Paragraphs in the document can inherit their - # TextStyle and + # The named styles. Paragraphs in the document can inherit their TextStyle and # ParagraphStyle from these named styles. # Corresponds to the JSON property `namedStyles` # @return [Google::Apis::DocsV1::NamedStyles] attr_accessor :named_styles - # The suggestion state of a NamedStyles - # message. + # The suggestion state of a NamedStyles message. # Corresponds to the JSON property `namedStylesSuggestionState` # @return [Google::Apis::DocsV1::NamedStylesSuggestionState] attr_accessor :named_styles_suggestion_state @@ -4999,32 +4746,28 @@ module Google end end - # A suggested change to a - # ParagraphStyle. + # A suggested change to a ParagraphStyle. class SuggestedParagraphStyle include Google::Apis::Core::Hashable - # Styles that apply to a whole paragraph. - # Inherited paragraph styles are represented as unset fields in this message. - # A paragraph style's parent depends on where the paragraph style is defined: - # * The ParagraphStyle on a Paragraph - # inherits from the paragraph's corresponding named style type. - # * The ParagraphStyle on a named style - # inherits from the normal text named style. - # * The ParagraphStyle of the normal text named style inherits - # from the default paragraph style in the Docs editor. - # * The ParagraphStyle on a Paragraph - # element that is contained in a table may inherit its paragraph style from - # the table style. - # If the paragraph style does not inherit from a parent, unsetting fields will - # revert the style to a value matching the defaults in the Docs editor. + # Styles that apply to a whole paragraph. Inherited paragraph styles are + # represented as unset fields in this message. A paragraph style's parent + # depends on where the paragraph style is defined: * The ParagraphStyle on a + # Paragraph inherits from the paragraph's corresponding named style type. * The + # ParagraphStyle on a named style inherits from the normal text named style. * + # The ParagraphStyle of the normal text named style inherits from the default + # paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph + # element that is contained in a table may inherit its paragraph style from the + # table style. If the paragraph style does not inherit from a parent, unsetting + # fields will revert the style to a value matching the defaults in the Docs + # editor. # Corresponds to the JSON property `paragraphStyle` # @return [Google::Apis::DocsV1::ParagraphStyle] attr_accessor :paragraph_style # A mask that indicates which of the fields on the base ParagraphStyle have been - # changed in this suggestion. - # For any field set to true, there is a new suggested value. + # changed in this suggestion. For any field set to true, there is a new + # suggested value. # Corresponds to the JSON property `paragraphStyleSuggestionState` # @return [Google::Apis::DocsV1::ParagraphStyleSuggestionState] attr_accessor :paragraph_style_suggestion_state @@ -5050,9 +4793,8 @@ module Google attr_accessor :positioned_object_properties # A mask that indicates which of the fields on the base - # PositionedObjectProperties - # have been changed in this suggestion. For any field set to true, there is a - # new suggested value. + # PositionedObjectProperties have been changed in this suggestion. For any field + # set to true, there is a new suggested value. # Corresponds to the JSON property `positionedObjectPropertiesSuggestionState` # @return [Google::Apis::DocsV1::PositionedObjectPropertiesSuggestionState] attr_accessor :positioned_object_properties_suggestion_state @@ -5072,16 +4814,15 @@ module Google class SuggestedTableCellStyle include Google::Apis::Core::Hashable - # The style of a TableCell. - # Inherited table cell styles are represented as unset fields in this message. - # A table cell style can inherit from the table's style. + # The style of a TableCell. Inherited table cell styles are represented as unset + # fields in this message. A table cell style can inherit from the table's style. # Corresponds to the JSON property `tableCellStyle` # @return [Google::Apis::DocsV1::TableCellStyle] attr_accessor :table_cell_style # A mask that indicates which of the fields on the base TableCellStyle have been - # changed in this suggestion. - # For any field set to true, there is a new suggested value. + # changed in this suggestion. For any field set to true, there is a new + # suggested value. # Corresponds to the JSON property `tableCellStyleSuggestionState` # @return [Google::Apis::DocsV1::TableCellStyleSuggestionState] attr_accessor :table_cell_style_suggestion_state @@ -5097,8 +4838,7 @@ module Google end end - # A suggested change to a - # TableRowStyle. + # A suggested change to a TableRowStyle. class SuggestedTableRowStyle include Google::Apis::Core::Hashable @@ -5108,8 +4848,8 @@ module Google attr_accessor :table_row_style # A mask that indicates which of the fields on the base TableRowStyle have been - # changed in this suggestion. - # For any field set to true, there is a new suggested value. + # changed in this suggestion. For any field set to true, there is a new + # suggested value. # Corresponds to the JSON property `tableRowStyleSuggestionState` # @return [Google::Apis::DocsV1::TableRowStyleSuggestionState] attr_accessor :table_row_style_suggestion_state @@ -5129,27 +4869,23 @@ module Google class SuggestedTextStyle include Google::Apis::Core::Hashable - # Represents the styling that can be applied to text. - # Inherited text styles are represented as unset fields in this message. A - # text style's parent depends on where the text style is defined: - # * The TextStyle of text in a Paragraph - # inherits from the paragraph's corresponding named style type. - # * The TextStyle on a named style - # inherits from the normal text named style. - # * The TextStyle of the normal text named style inherits - # from the default text style in the Docs editor. - # * The TextStyle on a Paragraph element - # that is contained in a table may inherit its text style from the table - # style. - # If the text style does not inherit from a parent, unsetting fields will - # revert the style to a value matching the defaults in the Docs editor. + # Represents the styling that can be applied to text. Inherited text styles are + # represented as unset fields in this message. A text style's parent depends on + # where the text style is defined: * The TextStyle of text in a Paragraph + # inherits from the paragraph's corresponding named style type. * The TextStyle + # on a named style inherits from the normal text named style. * The TextStyle of + # the normal text named style inherits from the default text style in the Docs + # editor. * The TextStyle on a Paragraph element that is contained in a table + # may inherit its text style from the table style. If the text style does not + # inherit from a parent, unsetting fields will revert the style to a value + # matching the defaults in the Docs editor. # Corresponds to the JSON property `textStyle` # @return [Google::Apis::DocsV1::TextStyle] attr_accessor :text_style # A mask that indicates which of the fields on the base TextStyle have been - # changed in this suggestion. - # For any field set to true, there is a new suggested value. + # changed in this suggestion. For any field set to true, there is a new + # suggested value. # Corresponds to the JSON property `textStyleSuggestionState` # @return [Google::Apis::DocsV1::TextStyleSuggestionState] attr_accessor :text_style_suggestion_state @@ -5190,14 +4926,12 @@ module Google end end - # A StructuralElement representing a - # table. + # A StructuralElement representing a table. class Table include Google::Apis::Core::Hashable - # Number of columns in the table. - # It is possible for a table to be non-rectangular, so some rows may have a - # different number of cells. + # Number of columns in the table. It is possible for a table to be non- + # rectangular, so some rows may have a different number of cells. # Corresponds to the JSON property `columns` # @return [Fixnum] attr_accessor :columns @@ -5207,15 +4941,14 @@ module Google # @return [Fixnum] attr_accessor :rows - # The suggested deletion IDs. If empty, then there are no suggested deletions - # of this content. + # The suggested deletion IDs. If empty, then there are no suggested deletions of + # this content. # Corresponds to the JSON property `suggestedDeletionIds` # @return [Array] attr_accessor :suggested_deletion_ids - # The suggested insertion IDs. A Table may have - # multiple insertion IDs if it is a nested suggested change. If empty, then - # this is not a suggested insertion. + # The suggested insertion IDs. A Table may have multiple insertion IDs if it is + # a nested suggested change. If empty, then this is not a suggested insertion. # Corresponds to the JSON property `suggestedInsertionIds` # @return [Array] attr_accessor :suggested_insertion_ids @@ -5264,15 +4997,14 @@ module Google # @return [Fixnum] attr_accessor :start_index - # The suggested deletion IDs. If empty, then there are no suggested deletions - # of this content. + # The suggested deletion IDs. If empty, then there are no suggested deletions of + # this content. # Corresponds to the JSON property `suggestedDeletionIds` # @return [Array] attr_accessor :suggested_deletion_ids - # The suggested insertion IDs. A TableCell - # may have multiple insertion IDs if it is a nested suggested change. If - # empty, then this is not a suggested insertion. + # The suggested insertion IDs. A TableCell may have multiple insertion IDs if it + # is a nested suggested change. If empty, then this is not a suggested insertion. # Corresponds to the JSON property `suggestedInsertionIds` # @return [Array] attr_accessor :suggested_insertion_ids @@ -5282,9 +5014,8 @@ module Google # @return [Hash] attr_accessor :suggested_table_cell_style_changes - # The style of a TableCell. - # Inherited table cell styles are represented as unset fields in this message. - # A table cell style can inherit from the table's style. + # The style of a TableCell. Inherited table cell styles are represented as unset + # fields in this message. A table cell style can inherit from the table's style. # Corresponds to the JSON property `tableCellStyle` # @return [Google::Apis::DocsV1::TableCellStyle] attr_accessor :table_cell_style @@ -5305,9 +5036,8 @@ module Google end end - # A border around a table cell. - # Table cell borders cannot be transparent. To hide a table cell border, make - # its width 0. + # A border around a table cell. Table cell borders cannot be transparent. To + # hide a table cell border, make its width 0. class TableCellBorder include Google::Apis::Core::Hashable @@ -5342,14 +5072,14 @@ module Google class TableCellLocation include Google::Apis::Core::Hashable - # The zero-based column index. For example, the second column in the table - # has a column index of 1. + # The zero-based column index. For example, the second column in the table has a + # column index of 1. # Corresponds to the JSON property `columnIndex` # @return [Fixnum] attr_accessor :column_index - # The zero-based row index. For example, the second row in the table has a - # row index of 1. + # The zero-based row index. For example, the second row in the table has a row + # index of 1. # Corresponds to the JSON property `rowIndex` # @return [Fixnum] attr_accessor :row_index @@ -5371,9 +5101,8 @@ module Google end end - # The style of a TableCell. - # Inherited table cell styles are represented as unset fields in this message. - # A table cell style can inherit from the table's style. + # The style of a TableCell. Inherited table cell styles are represented as unset + # fields in this message. A table cell style can inherit from the table's style. class TableCellStyle include Google::Apis::Core::Hashable @@ -5382,42 +5111,37 @@ module Google # @return [Google::Apis::DocsV1::OptionalColor] attr_accessor :background_color - # A border around a table cell. - # Table cell borders cannot be transparent. To hide a table cell border, make - # its width 0. + # A border around a table cell. Table cell borders cannot be transparent. To + # hide a table cell border, make its width 0. # Corresponds to the JSON property `borderBottom` # @return [Google::Apis::DocsV1::TableCellBorder] attr_accessor :border_bottom - # A border around a table cell. - # Table cell borders cannot be transparent. To hide a table cell border, make - # its width 0. + # A border around a table cell. Table cell borders cannot be transparent. To + # hide a table cell border, make its width 0. # Corresponds to the JSON property `borderLeft` # @return [Google::Apis::DocsV1::TableCellBorder] attr_accessor :border_left - # A border around a table cell. - # Table cell borders cannot be transparent. To hide a table cell border, make - # its width 0. + # A border around a table cell. Table cell borders cannot be transparent. To + # hide a table cell border, make its width 0. # Corresponds to the JSON property `borderRight` # @return [Google::Apis::DocsV1::TableCellBorder] attr_accessor :border_right - # A border around a table cell. - # Table cell borders cannot be transparent. To hide a table cell border, make - # its width 0. + # A border around a table cell. Table cell borders cannot be transparent. To + # hide a table cell border, make its width 0. # Corresponds to the JSON property `borderTop` # @return [Google::Apis::DocsV1::TableCellBorder] attr_accessor :border_top - # The column span of the cell. - # This property is read-only. + # The column span of the cell. This property is read-only. # Corresponds to the JSON property `columnSpan` # @return [Fixnum] attr_accessor :column_span - # The alignment of the content in the table cell. The default alignment - # matches the alignment for newly created table cells in the Docs editor. + # The alignment of the content in the table cell. The default alignment matches + # the alignment for newly created table cells in the Docs editor. # Corresponds to the JSON property `contentAlignment` # @return [String] attr_accessor :content_alignment @@ -5442,8 +5166,7 @@ module Google # @return [Google::Apis::DocsV1::Dimension] attr_accessor :padding_top - # The row span of the cell. - # This property is read-only. + # The row span of the cell. This property is read-only. # Corresponds to the JSON property `rowSpan` # @return [Fixnum] attr_accessor :row_span @@ -5470,8 +5193,8 @@ module Google end # A mask that indicates which of the fields on the base TableCellStyle have been - # changed in this suggestion. - # For any field set to true, there is a new suggested value. + # changed in this suggestion. For any field set to true, there is a new + # suggested value. class TableCellStyleSuggestionState include Google::Apis::Core::Hashable @@ -5593,8 +5316,7 @@ module Google end end - # A StructuralElement representing - # a table of contents. + # A StructuralElement representing a table of contents. class TableOfContents include Google::Apis::Core::Hashable @@ -5603,15 +5325,14 @@ module Google # @return [Array] attr_accessor :content - # The suggested deletion IDs. If empty, then there are no suggested deletions - # of this content. + # The suggested deletion IDs. If empty, then there are no suggested deletions of + # this content. # Corresponds to the JSON property `suggestedDeletionIds` # @return [Array] attr_accessor :suggested_deletion_ids # The suggested insertion IDs. A TableOfContents may have multiple insertion IDs - # if it - # is a nested suggested change. If empty, then this is not a suggested + # if it is a nested suggested change. If empty, then this is not a suggested # insertion. # Corresponds to the JSON property `suggestedInsertionIds` # @return [Array] @@ -5629,17 +5350,12 @@ module Google end end - # A table range represents a reference to a subset of a table. - # It's important to note that the cells specified by a table range do not - # necessarily form a rectangle. For example, let's say we have a 3 x 3 table - # where all the cells of the last row are merged together. The table looks - # like this: - # - # [ ] - # A table range with table cell location = (table_start_location, row = 0, - # column = 0), row span = 3 and column span = 2 specifies the following cells: - # x x - # [ x x x ] + # A table range represents a reference to a subset of a table. It's important to + # note that the cells specified by a table range do not necessarily form a + # rectangle. For example, let's say we have a 3 x 3 table where all the cells of + # the last row are merged together. The table looks like this: [ ] A table range + # with table cell location = (table_start_location, row = 0, column = 0), row + # span = 3 and column span = 2 specifies the following cells: x x [ x x x ] class TableRange include Google::Apis::Core::Hashable @@ -5684,15 +5400,14 @@ module Google # @return [Fixnum] attr_accessor :start_index - # The suggested deletion IDs. If empty, then there are no suggested deletions - # of this content. + # The suggested deletion IDs. If empty, then there are no suggested deletions of + # this content. # Corresponds to the JSON property `suggestedDeletionIds` # @return [Array] attr_accessor :suggested_deletion_ids - # The suggested insertion IDs. A TableRow - # may have multiple insertion IDs if it is a nested suggested change. If - # empty, then this is not a suggested insertion. + # The suggested insertion IDs. A TableRow may have multiple insertion IDs if it + # is a nested suggested change. If empty, then this is not a suggested insertion. # Corresponds to the JSON property `suggestedInsertionIds` # @return [Array] attr_accessor :suggested_insertion_ids @@ -5702,9 +5417,9 @@ module Google # @return [Hash] attr_accessor :suggested_table_row_style_changes - # The contents and style of each cell in this row. - # It is possible for a table to be non-rectangular, so some rows may have a - # different number of cells than other rows in the same table. + # The contents and style of each cell in this row. It is possible for a table to + # be non-rectangular, so some rows may have a different number of cells than + # other rows in the same table. # Corresponds to the JSON property `tableCells` # @return [Array] attr_accessor :table_cells @@ -5750,8 +5465,8 @@ module Google end # A mask that indicates which of the fields on the base TableRowStyle have been - # changed in this suggestion. - # For any field set to true, there is a new suggested value. + # changed in this suggestion. For any field set to true, there is a new + # suggested value. class TableRowStyleSuggestionState include Google::Apis::Core::Hashable @@ -5775,10 +5490,9 @@ module Google class TableStyle include Google::Apis::Core::Hashable - # The properties of each column. - # Note that in Docs, tables contain rows and rows contain cells, similar to - # HTML. So the properties for a row can be found on the row's - # table_row_style. + # The properties of each column. Note that in Docs, tables contain rows and rows + # contain cells, similar to HTML. So the properties for a row can be found on + # the row's table_row_style. # Corresponds to the JSON property `tableColumnProperties` # @return [Array] attr_accessor :table_column_properties @@ -5793,27 +5507,24 @@ module Google end end - # A ParagraphElement that represents a - # run of text that all has the same styling. + # A ParagraphElement that represents a run of text that all has the same styling. class TextRun include Google::Apis::Core::Hashable - # The text of this run. - # Any non-text elements in the run are replaced with the Unicode character - # U+E907. + # The text of this run. Any non-text elements in the run are replaced with the + # Unicode character U+E907. # Corresponds to the JSON property `content` # @return [String] attr_accessor :content - # The suggested deletion IDs. If empty, then there are no suggested deletions - # of this content. + # The suggested deletion IDs. If empty, then there are no suggested deletions of + # this content. # Corresponds to the JSON property `suggestedDeletionIds` # @return [Array] attr_accessor :suggested_deletion_ids - # The suggested insertion IDs. A TextRun may - # have multiple insertion IDs if it is a nested suggested change. If empty, - # then this is not a suggested insertion. + # The suggested insertion IDs. A TextRun may have multiple insertion IDs if it + # is a nested suggested change. If empty, then this is not a suggested insertion. # Corresponds to the JSON property `suggestedInsertionIds` # @return [Array] attr_accessor :suggested_insertion_ids @@ -5823,20 +5534,16 @@ module Google # @return [Hash] attr_accessor :suggested_text_style_changes - # Represents the styling that can be applied to text. - # Inherited text styles are represented as unset fields in this message. A - # text style's parent depends on where the text style is defined: - # * The TextStyle of text in a Paragraph - # inherits from the paragraph's corresponding named style type. - # * The TextStyle on a named style - # inherits from the normal text named style. - # * The TextStyle of the normal text named style inherits - # from the default text style in the Docs editor. - # * The TextStyle on a Paragraph element - # that is contained in a table may inherit its text style from the table - # style. - # If the text style does not inherit from a parent, unsetting fields will - # revert the style to a value matching the defaults in the Docs editor. + # Represents the styling that can be applied to text. Inherited text styles are + # represented as unset fields in this message. A text style's parent depends on + # where the text style is defined: * The TextStyle of text in a Paragraph + # inherits from the paragraph's corresponding named style type. * The TextStyle + # on a named style inherits from the normal text named style. * The TextStyle of + # the normal text named style inherits from the default text style in the Docs + # editor. * The TextStyle on a Paragraph element that is contained in a table + # may inherit its text style from the table style. If the text style does not + # inherit from a parent, unsetting fields will revert the style to a value + # matching the defaults in the Docs editor. # Corresponds to the JSON property `textStyle` # @return [Google::Apis::DocsV1::TextStyle] attr_accessor :text_style @@ -5855,20 +5562,16 @@ module Google end end - # Represents the styling that can be applied to text. - # Inherited text styles are represented as unset fields in this message. A - # text style's parent depends on where the text style is defined: - # * The TextStyle of text in a Paragraph - # inherits from the paragraph's corresponding named style type. - # * The TextStyle on a named style - # inherits from the normal text named style. - # * The TextStyle of the normal text named style inherits - # from the default text style in the Docs editor. - # * The TextStyle on a Paragraph element - # that is contained in a table may inherit its text style from the table - # style. - # If the text style does not inherit from a parent, unsetting fields will - # revert the style to a value matching the defaults in the Docs editor. + # Represents the styling that can be applied to text. Inherited text styles are + # represented as unset fields in this message. A text style's parent depends on + # where the text style is defined: * The TextStyle of text in a Paragraph + # inherits from the paragraph's corresponding named style type. * The TextStyle + # on a named style inherits from the normal text named style. * The TextStyle of + # the normal text named style inherits from the default text style in the Docs + # editor. * The TextStyle on a Paragraph element that is contained in a table + # may inherit its text style from the table style. If the text style does not + # inherit from a parent, unsetting fields will revert the style to a value + # matching the defaults in the Docs editor. class TextStyle include Google::Apis::Core::Hashable @@ -5877,10 +5580,10 @@ module Google # @return [Google::Apis::DocsV1::OptionalColor] attr_accessor :background_color - # The text's vertical offset from its normal position. - # Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically - # rendered in a smaller font size, computed based on the `font_size` field. - # The `font_size` itself is not affected by changes in this field. + # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` + # or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font + # size, computed based on the `font_size` field. The `font_size` itself is not + # affected by changes in this field. # Corresponds to the JSON property `baselineOffset` # @return [String] attr_accessor :baseline_offset @@ -5956,8 +5659,8 @@ module Google end # A mask that indicates which of the fields on the base TextStyle have been - # changed in this suggestion. - # For any field set to true, there is a new suggested value. + # changed in this suggestion. For any field set to true, there is a new + # suggested value. class TextStyleSuggestionState include Google::Apis::Core::Hashable @@ -6051,17 +5754,12 @@ module Google class UnmergeTableCellsRequest include Google::Apis::Core::Hashable - # A table range represents a reference to a subset of a table. - # It's important to note that the cells specified by a table range do not - # necessarily form a rectangle. For example, let's say we have a 3 x 3 table - # where all the cells of the last row are merged together. The table looks - # like this: - # - # [ ] - # A table range with table cell location = (table_start_location, row = 0, - # column = 0), row span = 3 and column span = 2 specifies the following cells: - # x x - # [ x x x ] + # A table range represents a reference to a subset of a table. It's important to + # note that the cells specified by a table range do not necessarily form a + # rectangle. For example, let's say we have a 3 x 3 table where all the cells of + # the last row are merged together. The table looks like this: [ ] A table range + # with table cell location = (table_start_location, row = 0, column = 0), row + # span = 3 and column span = 2 specifies the following cells: x x [ x x x ] # Corresponds to the JSON property `tableRange` # @return [Google::Apis::DocsV1::TableRange] attr_accessor :table_range @@ -6085,11 +5783,10 @@ module Google # @return [Google::Apis::DocsV1::DocumentStyle] attr_accessor :document_style - # The fields that should be updated. - # At least one field must be specified. The root `document_style` is - # implied and should not be specified. A single `"*"` can be used as - # short-hand for listing every field. - # For example to update the background, set `fields` to `"background"`. + # The fields that should be updated. At least one field must be specified. The + # root `document_style` is implied and should not be specified. A single `"*"` + # can be used as short-hand for listing every field. For example to update the + # background, set `fields` to `"background"`. # Corresponds to the JSON property `fields` # @return [String] attr_accessor :fields @@ -6109,31 +5806,26 @@ module Google class UpdateParagraphStyleRequest include Google::Apis::Core::Hashable - # The fields that should be updated. - # At least one field must be specified. The root `paragraph_style` is implied - # and should not be specified. - # For example, to update the paragraph style's alignment property, set - # `fields` to `"alignment"`. - # To reset a property to its default value, include its field name in the - # field mask but leave the field itself unset. + # The fields that should be updated. At least one field must be specified. The + # root `paragraph_style` is implied and should not be specified. For example, to + # update the paragraph style's alignment property, set `fields` to `"alignment"`. + # To reset a property to its default value, include its field name in the field + # mask but leave the field itself unset. # Corresponds to the JSON property `fields` # @return [String] attr_accessor :fields - # Styles that apply to a whole paragraph. - # Inherited paragraph styles are represented as unset fields in this message. - # A paragraph style's parent depends on where the paragraph style is defined: - # * The ParagraphStyle on a Paragraph - # inherits from the paragraph's corresponding named style type. - # * The ParagraphStyle on a named style - # inherits from the normal text named style. - # * The ParagraphStyle of the normal text named style inherits - # from the default paragraph style in the Docs editor. - # * The ParagraphStyle on a Paragraph - # element that is contained in a table may inherit its paragraph style from - # the table style. - # If the paragraph style does not inherit from a parent, unsetting fields will - # revert the style to a value matching the defaults in the Docs editor. + # Styles that apply to a whole paragraph. Inherited paragraph styles are + # represented as unset fields in this message. A paragraph style's parent + # depends on where the paragraph style is defined: * The ParagraphStyle on a + # Paragraph inherits from the paragraph's corresponding named style type. * The + # ParagraphStyle on a named style inherits from the normal text named style. * + # The ParagraphStyle of the normal text named style inherits from the default + # paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph + # element that is contained in a table may inherit its paragraph style from the + # table style. If the paragraph style does not inherit from a parent, unsetting + # fields will revert the style to a value matching the defaults in the Docs + # editor. # Corresponds to the JSON property `paragraphStyle` # @return [Google::Apis::DocsV1::ParagraphStyle] attr_accessor :paragraph_style @@ -6159,11 +5851,10 @@ module Google class UpdateSectionStyleRequest include Google::Apis::Core::Hashable - # The fields that should be updated. - # At least one field must be specified. The root `section_style` is - # implied and must not be specified. A single `"*"` can be used as - # short-hand for listing every field. - # For example to update the left margin, set `fields` to `"margin_left"`. + # The fields that should be updated. At least one field must be specified. The + # root `section_style` is implied and must not be specified. A single `"*"` can + # be used as short-hand for listing every field. For example to update the left + # margin, set `fields` to `"margin_left"`. # Corresponds to the JSON property `fields` # @return [String] attr_accessor :fields @@ -6194,36 +5885,28 @@ module Google class UpdateTableCellStyleRequest include Google::Apis::Core::Hashable - # The fields that should be updated. - # At least one field must be specified. The root `tableCellStyle` is implied - # and should not be specified. A single `"*"` can be used as short-hand for - # listing every field. - # For example to update the table cell background color, set `fields` to - # `"backgroundColor"`. - # To reset a property to its default value, include its field name in the - # field mask but leave the field itself unset. + # The fields that should be updated. At least one field must be specified. The + # root `tableCellStyle` is implied and should not be specified. A single `"*"` + # can be used as short-hand for listing every field. For example to update the + # table cell background color, set `fields` to `"backgroundColor"`. To reset a + # property to its default value, include its field name in the field mask but + # leave the field itself unset. # Corresponds to the JSON property `fields` # @return [String] attr_accessor :fields - # The style of a TableCell. - # Inherited table cell styles are represented as unset fields in this message. - # A table cell style can inherit from the table's style. + # The style of a TableCell. Inherited table cell styles are represented as unset + # fields in this message. A table cell style can inherit from the table's style. # Corresponds to the JSON property `tableCellStyle` # @return [Google::Apis::DocsV1::TableCellStyle] attr_accessor :table_cell_style - # A table range represents a reference to a subset of a table. - # It's important to note that the cells specified by a table range do not - # necessarily form a rectangle. For example, let's say we have a 3 x 3 table - # where all the cells of the last row are merged together. The table looks - # like this: - # - # [ ] - # A table range with table cell location = (table_start_location, row = 0, - # column = 0), row span = 3 and column span = 2 specifies the following cells: - # x x - # [ x x x ] + # A table range represents a reference to a subset of a table. It's important to + # note that the cells specified by a table range do not necessarily form a + # rectangle. For example, let's say we have a 3 x 3 table where all the cells of + # the last row are merged together. The table looks like this: [ ] A table range + # with table cell location = (table_start_location, row = 0, column = 0), row + # span = 3 and column span = 2 specifies the following cells: x x [ x x x ] # Corresponds to the JSON property `tableRange` # @return [Google::Apis::DocsV1::TableRange] attr_accessor :table_range @@ -6246,23 +5929,20 @@ module Google end end - # Updates the - # TableColumnProperties of columns - # in a table. + # Updates the TableColumnProperties of columns in a table. class UpdateTableColumnPropertiesRequest include Google::Apis::Core::Hashable - # The list of zero-based column indices whose property should be updated. If - # no indices are specified, all columns will be updated. + # The list of zero-based column indices whose property should be updated. If no + # indices are specified, all columns will be updated. # Corresponds to the JSON property `columnIndices` # @return [Array] attr_accessor :column_indices - # The fields that should be updated. - # At least one field must be specified. The root `tableColumnProperties` is - # implied and should not be specified. A single `"*"` can be used as - # short-hand for listing every field. - # For example to update the column width, set `fields` to `"width"`. + # The fields that should be updated. At least one field must be specified. The + # root `tableColumnProperties` is implied and should not be specified. A single ` + # "*"` can be used as short-hand for listing every field. For example to update + # the column width, set `fields` to `"width"`. # Corresponds to the JSON property `fields` # @return [String] attr_accessor :fields @@ -6290,17 +5970,14 @@ module Google end end - # Updates the TableRowStyle of rows in a - # table. + # Updates the TableRowStyle of rows in a table. class UpdateTableRowStyleRequest include Google::Apis::Core::Hashable - # The fields that should be updated. - # At least one field must be specified. The root `tableRowStyle` is implied - # and should not be specified. A single `"*"` can be used as short-hand for - # listing every field. - # For example to update the minimum row height, set `fields` to - # `"min_row_height"`. + # The fields that should be updated. At least one field must be specified. The + # root `tableRowStyle` is implied and should not be specified. A single `"*"` + # can be used as short-hand for listing every field. For example to update the + # minimum row height, set `fields` to `"min_row_height"`. # Corresponds to the JSON property `fields` # @return [String] attr_accessor :fields @@ -6338,13 +6015,12 @@ module Google class UpdateTextStyleRequest include Google::Apis::Core::Hashable - # The fields that should be updated. - # At least one field must be specified. The root `text_style` is implied and - # should not be specified. A single `"*"` can be used as short-hand for - # listing every field. - # For example, to update the text style to bold, set `fields` to `"bold"`. - # To reset a property to its default value, include its field name in the - # field mask but leave the field itself unset. + # The fields that should be updated. At least one field must be specified. The + # root `text_style` is implied and should not be specified. A single `"*"` can + # be used as short-hand for listing every field. For example, to update the text + # style to bold, set `fields` to `"bold"`. To reset a property to its default + # value, include its field name in the field mask but leave the field itself + # unset. # Corresponds to the JSON property `fields` # @return [String] attr_accessor :fields @@ -6354,20 +6030,16 @@ module Google # @return [Google::Apis::DocsV1::Range] attr_accessor :range - # Represents the styling that can be applied to text. - # Inherited text styles are represented as unset fields in this message. A - # text style's parent depends on where the text style is defined: - # * The TextStyle of text in a Paragraph - # inherits from the paragraph's corresponding named style type. - # * The TextStyle on a named style - # inherits from the normal text named style. - # * The TextStyle of the normal text named style inherits - # from the default text style in the Docs editor. - # * The TextStyle on a Paragraph element - # that is contained in a table may inherit its text style from the table - # style. - # If the text style does not inherit from a parent, unsetting fields will - # revert the style to a value matching the defaults in the Docs editor. + # Represents the styling that can be applied to text. Inherited text styles are + # represented as unset fields in this message. A text style's parent depends on + # where the text style is defined: * The TextStyle of text in a Paragraph + # inherits from the paragraph's corresponding named style type. * The TextStyle + # on a named style inherits from the normal text named style. * The TextStyle of + # the normal text named style inherits from the default text style in the Docs + # editor. * The TextStyle on a Paragraph element that is contained in a table + # may inherit its text style from the table style. If the text style does not + # inherit from a parent, unsetting fields will revert the style to a value + # matching the defaults in the Docs editor. # Corresponds to the JSON property `textStyle` # @return [Google::Apis::DocsV1::TextStyle] attr_accessor :text_style @@ -6388,30 +6060,26 @@ module Google class WeightedFontFamily include Google::Apis::Core::Hashable - # The font family of the text. - # The font family can be any font from the Font menu in Docs or from - # [Google Fonts] (https://fonts.google.com/). If the font name is - # unrecognized, the text is rendered in `Arial`. + # The font family of the text. The font family can be any font from the Font + # menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font + # name is unrecognized, the text is rendered in `Arial`. # Corresponds to the JSON property `fontFamily` # @return [String] attr_accessor :font_family - # The weight of the font. This field can have any value that is a multiple of - # `100` between `100` and `900`, inclusive. This range corresponds to the - # numerical values described in the CSS 2.1 Specification, - # [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with - # non-numerical values disallowed. - # The default value is `400` ("normal"). - # The font weight makes up just one component of the rendered font weight. - # The rendered weight is determined by a combination of the `weight` and the - # text style's resolved `bold` value, after accounting for inheritance: - # * If the text is bold and the weight is less than `400`, the rendered - # weight is 400. - # * If the text is bold and the weight is greater than or equal to `400` but - # is less than `700`, the rendered weight is `700`. - # * If the weight is greater than or equal to `700`, the rendered weight is - # equal to the weight. - # * If the text is not bold, the rendered weight is equal to the weight. + # The weight of the font. This field can have any value that is a multiple of ` + # 100` between `100` and `900`, inclusive. This range corresponds to the + # numerical values described in the CSS 2.1 Specification, [section 15.6](https:/ + # /www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values + # disallowed. The default value is `400` ("normal"). The font weight makes up + # just one component of the rendered font weight. The rendered weight is + # determined by a combination of the `weight` and the text style's resolved ` + # bold` value, after accounting for inheritance: * If the text is bold and the + # weight is less than `400`, the rendered weight is 400. * If the text is bold + # and the weight is greater than or equal to `400` but is less than `700`, the + # rendered weight is `700`. * If the weight is greater than or equal to `700`, + # the rendered weight is equal to the weight. * If the text is not bold, the + # rendered weight is equal to the weight. # Corresponds to the JSON property `weight` # @return [Fixnum] attr_accessor :weight @@ -6431,31 +6099,28 @@ module Google class WriteControl include Google::Apis::Core::Hashable - # The revision ID of the - # document that the write request will be applied to. If this is not the - # latest revision of the document, the request will not be processed and - # will return a 400 bad request error. - # When a required revision ID is returned in a response, it indicates the - # revision ID of the document after the request was applied. + # The revision ID of the document that the write request will be applied to. If + # this is not the latest revision of the document, the request will not be + # processed and will return a 400 bad request error. When a required revision ID + # is returned in a response, it indicates the revision ID of the document after + # the request was applied. # Corresponds to the JSON property `requiredRevisionId` # @return [String] attr_accessor :required_revision_id - # The target revision ID of the - # document that the write request will be applied to. - # If collaborator changes have occurred after the document was read using + # The target revision ID of the document that the write request will be applied + # to. If collaborator changes have occurred after the document was read using # the API, the changes produced by this write request will be transformed # against the collaborator changes. This results in a new revision of the # document which incorporates both the changes in the request and the - # collaborator changes, and the Docs server will resolve conflicting - # changes. When using `target_revision_id`, the API client can be thought - # of as another collaborator of the document. - # The target revision ID may only be used to write to recent versions of a - # document. If the target revision is too far behind the latest revision, - # the request will not be processed and will return a 400 bad request error - # and the request should be retried after reading the latest version of the - # document. In most cases a `revision_id` will remain valid for use as a - # target revision for several minutes after it is read, but for + # collaborator changes, and the Docs server will resolve conflicting changes. + # When using `target_revision_id`, the API client can be thought of as another + # collaborator of the document. The target revision ID may only be used to write + # to recent versions of a document. If the target revision is too far behind the + # latest revision, the request will not be processed and will return a 400 bad + # request error and the request should be retried after reading the latest + # version of the document. In most cases a `revision_id` will remain valid for + # use as a target revision for several minutes after it is read, but for # frequently-edited documents this window may be shorter. # Corresponds to the JSON property `targetRevisionId` # @return [String] diff --git a/generated/google/apis/docs_v1/service.rb b/generated/google/apis/docs_v1/service.rb index 340fb7786..2d75e31a2 100644 --- a/generated/google/apis/docs_v1/service.rb +++ b/generated/google/apis/docs_v1/service.rb @@ -47,23 +47,19 @@ module Google @batch_path = 'batch' end - # Applies one or more updates to the document. - # Each request is validated before - # being applied. If any request is not valid, then the entire request will - # fail and nothing will be applied. - # Some requests have replies to - # give you some information about how they are applied. Other requests do - # not need to return information; these each return an empty reply. - # The order of replies matches that of the requests. - # For example, suppose you call batchUpdate with four updates, and only the - # third one returns information. The response would have two empty replies, - # the reply to the third request, and another empty reply, in that order. - # Because other users may be editing the document, the document - # might not exactly reflect your changes: your changes may - # 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. + # Applies one or more updates to the document. Each request is validated before + # being applied. If any request is not valid, then the entire request will fail + # and nothing will be applied. Some requests have replies to give you some + # information about how they are applied. Other requests do not need to return + # information; these each return an empty reply. The order of replies matches + # that of the requests. For example, suppose you call batchUpdate with four + # updates, and only the third one returns information. The response would have + # two empty replies, the reply to the third request, and another empty reply, in + # that order. Because other users may be editing the document, the document + # might not exactly reflect your changes: your changes may 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 # The ID of the document to update. # @param [Google::Apis::DocsV1::BatchUpdateDocumentRequest] batch_update_document_request_object @@ -96,9 +92,9 @@ module Google execute_or_queue_command(command, &block) end - # Creates a blank document using the title given in the request. Other fields - # in the request, including any provided content, are ignored. - # Returns the created document. + # Creates a blank document using the title given in the request. Other fields in + # the request, including any provided content, are ignored. Returns the created + # document. # @param [Google::Apis::DocsV1::Document] document_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -134,8 +130,7 @@ module Google # @param [String] suggestions_view_mode # 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 - # specified, DEFAULT_FOR_CURRENT_ACCESS is - # used. + # specified, DEFAULT_FOR_CURRENT_ACCESS is used. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user diff --git a/generated/google/apis/indexing_v3.rb b/generated/google/apis/indexing_v3.rb index 238d0f4b3..2c0119cf7 100644 --- a/generated/google/apis/indexing_v3.rb +++ b/generated/google/apis/indexing_v3.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/search/apis/indexing-api/ module IndexingV3 VERSION = 'V3' - REVISION = '20200214' + REVISION = '20200804' # Submit data to Google for indexing AUTH_INDEXING = 'https://www.googleapis.com/auth/indexing' diff --git a/generated/google/apis/indexing_v3/classes.rb b/generated/google/apis/indexing_v3/classes.rb index 45443ae52..01993748f 100644 --- a/generated/google/apis/indexing_v3/classes.rb +++ b/generated/google/apis/indexing_v3/classes.rb @@ -42,13 +42,13 @@ module Google end end - # `UrlNotification` is the resource used in all Indexing API calls. - # It describes one event in the life cycle of a Web Document. + # `UrlNotification` is the resource used in all Indexing API calls. It describes + # one event in the life cycle of a Web Document. class UrlNotification include Google::Apis::Core::Hashable - # Creation timestamp for this notification. - # Users should _not_ specify it, the field is ignored at the request time. + # Creation timestamp for this notification. Users should _not_ specify it, the + # field is ignored at the request time. # Corresponds to the JSON property `notifyTime` # @return [String] attr_accessor :notify_time @@ -58,9 +58,9 @@ module Google # @return [String] attr_accessor :type - # The object of this notification. The URL must be owned by the publisher - # of this notification and, in case of `URL_UPDATED` notifications, it _must_ - # be crawlable by Google. + # The object of this notification. The URL must be owned by the publisher of + # this notification and, in case of `URL_UPDATED` notifications, it _must_ be + # crawlable by Google. # Corresponds to the JSON property `url` # @return [String] attr_accessor :url @@ -82,14 +82,14 @@ module Google class UrlNotificationMetadata include Google::Apis::Core::Hashable - # `UrlNotification` is the resource used in all Indexing API calls. - # It describes one event in the life cycle of a Web Document. + # `UrlNotification` is the resource used in all Indexing API calls. It describes + # one event in the life cycle of a Web Document. # Corresponds to the JSON property `latestRemove` # @return [Google::Apis::IndexingV3::UrlNotification] attr_accessor :latest_remove - # `UrlNotification` is the resource used in all Indexing API calls. - # It describes one event in the life cycle of a Web Document. + # `UrlNotification` is the resource used in all Indexing API calls. It describes + # one event in the life cycle of a Web Document. # Corresponds to the JSON property `latestUpdate` # @return [Google::Apis::IndexingV3::UrlNotification] attr_accessor :latest_update diff --git a/generated/google/apis/manufacturers_v1.rb b/generated/google/apis/manufacturers_v1.rb index efa5ac786..dc43b6b19 100644 --- a/generated/google/apis/manufacturers_v1.rb +++ b/generated/google/apis/manufacturers_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/manufacturers/ module ManufacturersV1 VERSION = 'V1' - REVISION = '20200317' + REVISION = '20200805' # Manage your product listings for Google Manufacturer Center AUTH_MANUFACTURERCENTER = 'https://www.googleapis.com/auth/manufacturercenter' diff --git a/generated/google/apis/manufacturers_v1/classes.rb b/generated/google/apis/manufacturers_v1/classes.rb index e62d4f8f8..8008b3ddc 100644 --- a/generated/google/apis/manufacturers_v1/classes.rb +++ b/generated/google/apis/manufacturers_v1/classes.rb @@ -22,55 +22,55 @@ module Google module Apis module ManufacturersV1 - # Attributes of the product. For more information, see - # https://support.google.com/manufacturers/answer/6124116. + # Attributes of the product. For more information, see https://support.google. + # com/manufacturers/answer/6124116. class Attributes include Google::Apis::Core::Hashable - # The additional images of the product. For more information, see - # https://support.google.com/manufacturers/answer/6124116#addlimage. + # The additional images of the product. For more information, see https:// + # support.google.com/manufacturers/answer/6124116#addlimage. # Corresponds to the JSON property `additionalImageLink` # @return [Array] attr_accessor :additional_image_link - # The target age group of the product. For more information, see - # https://support.google.com/manufacturers/answer/6124116#agegroup. + # The target age group of the product. For more information, see https://support. + # google.com/manufacturers/answer/6124116#agegroup. # Corresponds to the JSON property `ageGroup` # @return [String] attr_accessor :age_group - # The brand name of the product. For more information, see - # https://support.google.com/manufacturers/answer/6124116#brand. + # The brand name of the product. For more information, see https://support. + # google.com/manufacturers/answer/6124116#brand. # Corresponds to the JSON property `brand` # @return [String] attr_accessor :brand - # The capacity of a product. For more information, see - # https://support.google.com/manufacturers/answer/6124116#capacity. + # The capacity of a product. For more information, see https://support.google. + # com/manufacturers/answer/6124116#capacity. # Corresponds to the JSON property `capacity` # @return [Google::Apis::ManufacturersV1::Capacity] attr_accessor :capacity - # The color of the product. For more information, see - # https://support.google.com/manufacturers/answer/6124116#color. + # The color of the product. For more information, see https://support.google.com/ + # manufacturers/answer/6124116#color. # Corresponds to the JSON property `color` # @return [String] attr_accessor :color - # The number of products in a single package. For more information, see - # https://support.google.com/manufacturers/answer/6124116#count. + # The number of products in a single package. For more information, see https:// + # support.google.com/manufacturers/answer/6124116#count. # Corresponds to the JSON property `count` # @return [Google::Apis::ManufacturersV1::Count] attr_accessor :count - # The description of the product. For more information, see - # https://support.google.com/manufacturers/answer/6124116#description. + # The description of the product. For more information, see https://support. + # google.com/manufacturers/answer/6124116#description. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description - # The disclosure date of the product. For more information, see - # https://support.google.com/manufacturers/answer/6124116#disclosure. + # The disclosure date of the product. For more information, see https://support. + # google.com/manufacturers/answer/6124116#disclosure. # Corresponds to the JSON property `disclosureDate` # @return [String] attr_accessor :disclosure_date @@ -80,32 +80,32 @@ module Google # @return [Array] attr_accessor :excluded_destination - # The rich format description of the product. For more information, see - # https://support.google.com/manufacturers/answer/6124116#featuredesc. + # The rich format description of the product. For more information, see https:// + # support.google.com/manufacturers/answer/6124116#featuredesc. # Corresponds to the JSON property `featureDescription` # @return [Array] attr_accessor :feature_description - # The flavor of the product. For more information, see - # https://support.google.com/manufacturers/answer/6124116#flavor. + # The flavor of the product. For more information, see https://support.google. + # com/manufacturers/answer/6124116#flavor. # Corresponds to the JSON property `flavor` # @return [String] attr_accessor :flavor - # The format of the product. For more information, see - # https://support.google.com/manufacturers/answer/6124116#format. + # The format of the product. For more information, see https://support.google. + # com/manufacturers/answer/6124116#format. # Corresponds to the JSON property `format` # @return [String] attr_accessor :format - # The target gender of the product. For more information, see - # https://support.google.com/manufacturers/answer/6124116#gender. + # The target gender of the product. For more information, see https://support. + # google.com/manufacturers/answer/6124116#gender. # Corresponds to the JSON property `gender` # @return [String] attr_accessor :gender - # The Global Trade Item Number (GTIN) of the product. For more information, - # see https://support.google.com/manufacturers/answer/6124116#gtin. + # The Global Trade Item Number (GTIN) of the product. For more information, see + # https://support.google.com/manufacturers/answer/6124116#gtin. # Corresponds to the JSON property `gtin` # @return [Array] attr_accessor :gtin @@ -120,93 +120,92 @@ module Google # @return [Array] attr_accessor :included_destination - # The item group id of the product. For more information, see - # https://support.google.com/manufacturers/answer/6124116#itemgroupid. + # The item group id of the product. For more information, see https://support. + # google.com/manufacturers/answer/6124116#itemgroupid. # Corresponds to the JSON property `itemGroupId` # @return [String] attr_accessor :item_group_id - # The material of the product. For more information, see - # https://support.google.com/manufacturers/answer/6124116#material. + # The material of the product. For more information, see https://support.google. + # com/manufacturers/answer/6124116#material. # Corresponds to the JSON property `material` # @return [String] attr_accessor :material - # The Manufacturer Part Number (MPN) of the product. For more information, - # see https://support.google.com/manufacturers/answer/6124116#mpn. + # The Manufacturer Part Number (MPN) of the product. For more information, see + # https://support.google.com/manufacturers/answer/6124116#mpn. # Corresponds to the JSON property `mpn` # @return [String] attr_accessor :mpn - # The pattern of the product. For more information, see - # https://support.google.com/manufacturers/answer/6124116#pattern. + # The pattern of the product. For more information, see https://support.google. + # com/manufacturers/answer/6124116#pattern. # Corresponds to the JSON property `pattern` # @return [String] attr_accessor :pattern - # The details of the product. For more information, see - # https://support.google.com/manufacturers/answer/6124116#productdetail. + # The details of the product. For more information, see https://support.google. + # com/manufacturers/answer/6124116#productdetail. # Corresponds to the JSON property `productDetail` # @return [Array] attr_accessor :product_detail - # The name of the group of products related to the product. For more - # information, see - # https://support.google.com/manufacturers/answer/6124116#productline. + # The name of the group of products related to the product. For more information, + # see https://support.google.com/manufacturers/answer/6124116#productline. # Corresponds to the JSON property `productLine` # @return [String] attr_accessor :product_line - # The canonical name of the product. For more information, see - # https://support.google.com/manufacturers/answer/6124116#productname. + # The canonical name of the product. For more information, see https://support. + # google.com/manufacturers/answer/6124116#productname. # Corresponds to the JSON property `productName` # @return [String] attr_accessor :product_name - # The URL of the detail page of the product. For more information, see - # https://support.google.com/manufacturers/answer/6124116#productpage. + # The URL of the detail page of the product. For more information, see https:// + # support.google.com/manufacturers/answer/6124116#productpage. # Corresponds to the JSON property `productPageUrl` # @return [String] attr_accessor :product_page_url - # The type or category of the product. For more information, see - # https://support.google.com/manufacturers/answer/6124116#producttype. + # The type or category of the product. For more information, see https://support. + # google.com/manufacturers/answer/6124116#producttype. # Corresponds to the JSON property `productType` # @return [Array] attr_accessor :product_type - # The release date of the product. For more information, see - # https://support.google.com/manufacturers/answer/6124116#release. + # The release date of the product. For more information, see https://support. + # google.com/manufacturers/answer/6124116#release. # Corresponds to the JSON property `releaseDate` # @return [String] attr_accessor :release_date - # Rich product content. For more information, see - # https://support.google.com/manufacturers/answer/9389865 + # Rich product content. For more information, see https://support.google.com/ + # manufacturers/answer/9389865 # Corresponds to the JSON property `richProductContent` # @return [Array] attr_accessor :rich_product_content - # The scent of the product. For more information, see - # https://support.google.com/manufacturers/answer/6124116#scent. + # The scent of the product. For more information, see https://support.google.com/ + # manufacturers/answer/6124116#scent. # Corresponds to the JSON property `scent` # @return [String] attr_accessor :scent - # The size of the product. For more information, see - # https://support.google.com/manufacturers/answer/6124116#size. + # The size of the product. For more information, see https://support.google.com/ + # manufacturers/answer/6124116#size. # Corresponds to the JSON property `size` # @return [String] attr_accessor :size - # The size system of the product. For more information, see - # https://support.google.com/manufacturers/answer/6124116#sizesystem. + # The size system of the product. For more information, see https://support. + # google.com/manufacturers/answer/6124116#sizesystem. # Corresponds to the JSON property `sizeSystem` # @return [String] attr_accessor :size_system - # The size type of the product. For more information, see - # https://support.google.com/manufacturers/answer/6124116#sizetype. + # The size type of the product. For more information, see https://support.google. + # com/manufacturers/answer/6124116#sizetype. # Corresponds to the JSON property `sizeType` # @return [String] attr_accessor :size_type @@ -216,26 +215,25 @@ module Google # @return [Google::Apis::ManufacturersV1::Price] attr_accessor :suggested_retail_price - # The target client id. Should only be used in the accounts of the data - # partners. + # The target client id. Should only be used in the accounts of the data partners. # Corresponds to the JSON property `targetClientId` # @return [String] attr_accessor :target_client_id - # The theme of the product. For more information, see - # https://support.google.com/manufacturers/answer/6124116#theme. + # The theme of the product. For more information, see https://support.google.com/ + # manufacturers/answer/6124116#theme. # Corresponds to the JSON property `theme` # @return [String] attr_accessor :theme - # The title of the product. For more information, see - # https://support.google.com/manufacturers/answer/6124116#title. + # The title of the product. For more information, see https://support.google.com/ + # manufacturers/answer/6124116#title. # Corresponds to the JSON property `title` # @return [String] attr_accessor :title - # The videos of the product. For more information, see - # https://support.google.com/manufacturers/answer/6124116#video. + # The videos of the product. For more information, see https://support.google. + # com/manufacturers/answer/6124116#video. # Corresponds to the JSON property `videoLink` # @return [Array] attr_accessor :video_link @@ -285,8 +283,8 @@ module Google end end - # The capacity of a product. For more information, see - # https://support.google.com/manufacturers/answer/6124116#capacity. + # The capacity of a product. For more information, see https://support.google. + # com/manufacturers/answer/6124116#capacity. class Capacity include Google::Apis::Core::Hashable @@ -311,8 +309,8 @@ module Google end end - # The number of products in a single package. For more information, see - # https://support.google.com/manufacturers/answer/6124116#count. + # The number of products in a single package. For more information, see https:// + # support.google.com/manufacturers/answer/6124116#count. class Count include Google::Apis::Core::Hashable @@ -362,13 +360,11 @@ module Google end end - # A generic empty message that you can re-use to avoid defining duplicated - # empty messages in your APIs. A typical example is to use it as the request - # or the response type of an API method. For instance: - # service Foo ` - # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); - # ` - # The JSON representation for `Empty` is empty JSON object ````. + # A generic empty message that you can re-use to avoid defining duplicated empty + # messages in your APIs. A typical example is to use it as the request or the + # response type of an API method. For instance: service Foo ` rpc Bar(google. + # protobuf.Empty) returns (google.protobuf.Empty); ` The JSON representation for + # `Empty` is empty JSON object ````. class Empty include Google::Apis::Core::Hashable @@ -381,8 +377,8 @@ module Google end end - # A feature description of the product. For more information, see - # https://support.google.com/manufacturers/answer/6124116#featuredesc. + # A feature description of the product. For more information, see https:// + # support.google.com/manufacturers/answer/6124116#featuredesc. class FeatureDescription include Google::Apis::Core::Hashable @@ -424,14 +420,12 @@ module Google # @return [String] attr_accessor :image_url - # The status of the image. - # @OutputOnly + # The status of the image. @OutputOnly # Corresponds to the JSON property `status` # @return [String] attr_accessor :status - # The type of the image, i.e., crawled or uploaded. - # @OutputOnly + # The type of the image, i.e., crawled or uploaded. @OutputOnly # Corresponds to the JSON property `type` # @return [String] attr_accessor :type @@ -452,9 +446,8 @@ module Google class Issue include Google::Apis::Core::Hashable - # If present, the attribute that triggered the issue. For more information - # about attributes, see - # https://support.google.com/manufacturers/answer/6124116. + # If present, the attribute that triggered the issue. For more information about + # attributes, see https://support.google.com/manufacturers/answer/6124116. # Corresponds to the JSON property `attribute` # @return [String] attr_accessor :attribute @@ -489,8 +482,8 @@ module Google # @return [String] attr_accessor :title - # The server-generated type of the issue, for example, - # “INCORRECT_TEXT_FORMATTING”, “IMAGE_NOT_SERVEABLE”, etc. + # The server-generated type of the issue, for example, “ + # INCORRECT_TEXT_FORMATTING”, “IMAGE_NOT_SERVEABLE”, etc. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type @@ -566,14 +559,14 @@ module Google class Product include Google::Apis::Core::Hashable - # Attributes of the product. For more information, see - # https://support.google.com/manufacturers/answer/6124116. + # Attributes of the product. For more information, see https://support.google. + # com/manufacturers/answer/6124116. # Corresponds to the JSON property `attributes` # @return [Google::Apis::ManufacturersV1::Attributes] attr_accessor :attributes - # The content language of the product as a two-letter ISO 639-1 language code - # (for example, en). + # The content language of the product as a two-letter ISO 639-1 language code ( + # for example, en). # Corresponds to the JSON property `contentLanguage` # @return [String] attr_accessor :content_language @@ -588,32 +581,29 @@ module Google # @return [Array] attr_accessor :issues - # Name in the format ``target_country`:`content_language`:`product_id``. - # `target_country` - The target country of the product as a CLDR territory - # code (for example, US). - # `content_language` - The content language of the product as a two-letter - # ISO 639-1 language code (for example, en). - # `product_id` - The ID of the product. For more information, see - # https://support.google.com/manufacturers/answer/6124116# - # id. + # Name in the format ``target_country`:`content_language`:`product_id``. ` + # target_country` - The target country of the product as a CLDR territory code ( + # for example, US). `content_language` - The content language of the product as + # a two-letter ISO 639-1 language code (for example, en). `product_id` - The ID + # of the product. For more information, see https://support.google.com/ + # manufacturers/answer/6124116#id. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Parent ID in the format `accounts/`account_id``. - # `account_id` - The ID of the Manufacturer Center account. + # Parent ID in the format `accounts/`account_id``. `account_id` - The ID of the + # Manufacturer Center account. # Corresponds to the JSON property `parent` # @return [String] attr_accessor :parent - # The ID of the product. For more information, see - # https://support.google.com/manufacturers/answer/6124116#id. + # The ID of the product. For more information, see https://support.google.com/ + # manufacturers/answer/6124116#id. # Corresponds to the JSON property `productId` # @return [String] attr_accessor :product_id - # The target country of the product as a CLDR territory code (for example, - # US). + # The target country of the product as a CLDR territory code (for example, US). # Corresponds to the JSON property `targetCountry` # @return [String] attr_accessor :target_country @@ -635,8 +625,8 @@ module Google end end - # A product detail of the product. For more information, see - # https://support.google.com/manufacturers/answer/6124116#productdetail. + # A product detail of the product. For more information, see https://support. + # google.com/manufacturers/answer/6124116#productdetail. class ProductDetail include Google::Apis::Core::Hashable diff --git a/generated/google/apis/manufacturers_v1/service.rb b/generated/google/apis/manufacturers_v1/service.rb index aba7cb6d3..46abf9855 100644 --- a/generated/google/apis/manufacturers_v1/service.rb +++ b/generated/google/apis/manufacturers_v1/service.rb @@ -49,17 +49,15 @@ module Google # Deletes the product from a Manufacturer Center account. # @param [String] parent - # Parent ID in the format `accounts/`account_id``. - # `account_id` - The ID of the Manufacturer Center account. + # Parent ID in the format `accounts/`account_id``. `account_id` - The ID of the + # Manufacturer Center account. # @param [String] name - # Name in the format ``target_country`:`content_language`:`product_id``. - # `target_country` - The target country of the product as a CLDR territory - # code (for example, US). - # `content_language` - The content language of the product as a two-letter - # ISO 639-1 language code (for example, en). - # `product_id` - The ID of the product. For more information, see - # https://support.google.com/manufacturers/answer/6124116# - # id. + # Name in the format ``target_country`:`content_language`:`product_id``. ` + # target_country` - The target country of the product as a CLDR territory code ( + # for example, US). `content_language` - The content language of the product as + # a two-letter ISO 639-1 language code (for example, en). `product_id` - The ID + # of the product. For more information, see https://support.google.com/ + # manufacturers/answer/6124116#id. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -88,27 +86,23 @@ module Google execute_or_queue_command(command, &block) end - # Gets the product from a Manufacturer Center account, including product - # issues. + # Gets the product from a Manufacturer Center account, including product issues. # A recently updated product takes around 15 minutes to process. Changes are - # only visible after it has been processed. While some issues may be - # available once the product has been processed, other issues may take days - # to appear. + # only visible after it has been processed. While some issues may be available + # once the product has been processed, other issues may take days to appear. # @param [String] parent - # Parent ID in the format `accounts/`account_id``. - # `account_id` - The ID of the Manufacturer Center account. + # Parent ID in the format `accounts/`account_id``. `account_id` - The ID of the + # Manufacturer Center account. # @param [String] name - # Name in the format ``target_country`:`content_language`:`product_id``. - # `target_country` - The target country of the product as a CLDR territory - # code (for example, US). - # `content_language` - The content language of the product as a two-letter - # ISO 639-1 language code (for example, en). - # `product_id` - The ID of the product. For more information, see - # https://support.google.com/manufacturers/answer/6124116# - # id. + # Name in the format ``target_country`:`content_language`:`product_id``. ` + # target_country` - The target country of the product as a CLDR territory code ( + # for example, US). `content_language` - The content language of the product as + # a two-letter ISO 639-1 language code (for example, en). `product_id` - The ID + # of the product. For more information, see https://support.google.com/ + # manufacturers/answer/6124116#id. # @param [Array, String] include - # The information to be included in the response. Only sections listed here - # will be returned. + # The information to be included in the response. Only sections listed here will + # be returned. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -140,14 +134,13 @@ module Google # Lists all the products in a Manufacturer Center account. # @param [String] parent - # Parent ID in the format `accounts/`account_id``. - # `account_id` - The ID of the Manufacturer Center account. + # Parent ID in the format `accounts/`account_id``. `account_id` - The ID of the + # Manufacturer Center account. # @param [Array, String] include - # The information to be included in the response. Only sections listed here - # will be returned. + # The information to be included in the response. Only sections listed here will + # be returned. # @param [Fixnum] page_size - # Maximum number of product statuses to return in the response, used for - # paging. + # Maximum number of product statuses to return in the response, used for paging. # @param [String] page_token # The token returned by the previous request. # @param [String] fields @@ -181,30 +174,26 @@ module Google end # Inserts or updates the attributes of the product in a Manufacturer Center - # account. - # Creates a product with the provided attributes. If the product already - # exists, then all attributes are replaced with the new ones. The checks at - # 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 upload for a product and it is possible to overwrite an existing valid - # product with an invalid product. To detect this, you should retrieve the - # product and check it for issues once the new version is available. - # Uploaded attributes first need to be processed before they can be - # retrieved. Until then, new products will be unavailable, and retrieval - # of previously uploaded products will return the original state of the - # product. + # account. Creates a product with the provided attributes. If the product + # already exists, then all attributes are replaced with the new ones. The checks + # at 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 + # upload for a product and it is possible to overwrite an existing valid product + # with an invalid product. To detect this, you should retrieve the product and + # check it for issues once the new version is available. Uploaded attributes + # first need to be processed before they can be retrieved. Until then, new + # products will be unavailable, and retrieval of previously uploaded products + # will return the original state of the product. # @param [String] parent - # Parent ID in the format `accounts/`account_id``. - # `account_id` - The ID of the Manufacturer Center account. + # Parent ID in the format `accounts/`account_id``. `account_id` - The ID of the + # Manufacturer Center account. # @param [String] name - # Name in the format ``target_country`:`content_language`:`product_id``. - # `target_country` - The target country of the product as a CLDR territory - # code (for example, US). - # `content_language` - The content language of the product as a two-letter - # ISO 639-1 language code (for example, en). - # `product_id` - The ID of the product. For more information, see - # https://support.google.com/manufacturers/answer/6124116# - # id. + # Name in the format ``target_country`:`content_language`:`product_id``. ` + # target_country` - The target country of the product as a CLDR territory code ( + # for example, US). `content_language` - The content language of the product as + # a two-letter ISO 639-1 language code (for example, en). `product_id` - The ID + # of the product. For more information, see https://support.google.com/ + # manufacturers/answer/6124116#id. # @param [Google::Apis::ManufacturersV1::Attributes] attributes_object # @param [String] fields # Selector specifying which fields to include in a partial response. diff --git a/generated/google/apis/playablelocations_v3.rb b/generated/google/apis/playablelocations_v3.rb index 17e81764f..a0378e867 100644 --- a/generated/google/apis/playablelocations_v3.rb +++ b/generated/google/apis/playablelocations_v3.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/maps/contact-sales/ module PlayablelocationsV3 VERSION = 'V3' - REVISION = '20200622' + REVISION = '20200808' end end end diff --git a/generated/google/apis/playablelocations_v3/classes.rb b/generated/google/apis/playablelocations_v3/classes.rb index a83bc498a..287faf787 100644 --- a/generated/google/apis/playablelocations_v3/classes.rb +++ b/generated/google/apis/playablelocations_v3/classes.rb @@ -26,13 +26,12 @@ module Google class GoogleMapsPlayablelocationsV3Impression include Google::Apis::Core::Hashable - # An arbitrary, developer-defined type identifier for each type of game - # object used in your game. - # Since players interact with differ types of game objects in different ways, - # this field allows you to segregate impression data by type for analysis. - # You should assign a unique `game_object_type` ID to represent a distinct - # type of game object in your game. - # For example, 1=monster location, 2=powerup location. + # An arbitrary, developer-defined type identifier for each type of game object + # used in your game. Since players interact with differ types of game objects in + # different ways, this field allows you to segregate impression data by type for + # analysis. You should assign a unique `game_object_type` ID to represent a + # distinct type of game object in your game. For example, 1=monster location, 2= + # powerup location. # Corresponds to the JSON property `gameObjectType` # @return [Fixnum] attr_accessor :game_object_type @@ -69,19 +68,16 @@ module Google attr_accessor :client_info # Required. Impression event details. The maximum number of impression reports - # that you - # can log at once is 50. + # that you can log at once is 50. # Corresponds to the JSON property `impressions` # @return [Array] attr_accessor :impressions # Required. A string that uniquely identifies the log impressions request. This - # 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 `request_id` only when retrying a request in case of - # failure. In this case, the request must be identical to the one that - # failed. + # 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 ` + # request_id` only when retrying a request in case of failure. In this case, the + # request must be identical to the one that failed. # Corresponds to the JSON property `requestId` # @return [String] attr_accessor :request_id @@ -98,8 +94,8 @@ module Google end end - # A response for the LogImpressions method. - # This method returns no data upon success. + # A response for the LogImpressions method. This method returns no data upon + # success. class GoogleMapsPlayablelocationsV3LogImpressionsResponse include Google::Apis::Core::Hashable @@ -122,19 +118,16 @@ module Google attr_accessor :client_info # Required. Player reports. The maximum number of player reports that you can - # log at - # once is 50. + # log at once is 50. # Corresponds to the JSON property `playerReports` # @return [Array] attr_accessor :player_reports # Required. A string that uniquely identifies the log player reports request. - # This - # 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 `request_id` only when retrying a request in the case - # of a failure. In that case, the request must be identical to the one that - # failed. + # This 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 ` + # request_id` only when retrying a request in the case of a failure. In that + # case, the request must be identical to the one that failed. # Corresponds to the JSON property `requestId` # @return [String] attr_accessor :request_id @@ -151,9 +144,8 @@ module Google end end - # A response for the LogPlayerReports - # method. - # This method returns no data upon success. + # A response for the LogPlayerReports method. This method returns no data upon + # success. class GoogleMapsPlayablelocationsV3LogPlayerReportsResponse include Google::Apis::Core::Hashable @@ -172,9 +164,9 @@ module Google include Google::Apis::Core::Hashable # Language code (in BCP-47 format) indicating the language of the freeform - # description provided in `reason_details`. Examples are "en", "en-US" or - # "ja-Latn". For more information, see - # http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + # description provided in `reason_details`. Examples are "en", "en-US" or "ja- + # Latn". For more information, see http://www.unicode.org/reports/tr35/# + # Unicode_locale_identifier. # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code @@ -213,15 +205,12 @@ module Google include Google::Apis::Core::Hashable # Required. The S2 cell ID of the area you want. This must be between cell level - # 11 and - # 14 (inclusive). - # S2 cells are 64-bit integers that identify areas on the Earth. They are - # hierarchical, and can therefore be used for spatial indexing. - # The S2 geometry library is available in a number of languages: - # * [C++](https://github.com/google/s2geometry) - # * [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) + # 11 and 14 (inclusive). S2 cells are 64-bit integers that identify areas on the + # Earth. They are hierarchical, and can therefore be used for spatial indexing. + # The S2 geometry library is available in a number of languages: * [C++](https:// + # github.com/google/s2geometry) * [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` # @return [Fixnum] attr_accessor :s2_cell_id @@ -236,19 +225,15 @@ module Google end end - # Encapsulates a filter criterion for searching for a set of playable - # locations. + # Encapsulates a filter criterion for searching for a set of playable locations. class GoogleMapsPlayablelocationsV3SampleCriterion include Google::Apis::Core::Hashable - # Specifies which `PlayableLocation` fields are returned. - # `name` (which is used for logging impressions), `center_point` and - # `place_id` (or `plus_code`) are always returned. - # The following fields are omitted unless you specify them here: - # * snapped_point - # * types - # Note: The more fields you include, the more expensive in terms of data and - # associated latency your query will be. + # Specifies which `PlayableLocation` fields are returned. `name` (which is used + # for logging impressions), `center_point` and `place_id` (or `plus_code`) are + # always returned. The following fields are omitted unless you specify them here: + # * snapped_point * 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` # @return [String] attr_accessor :fields_to_return @@ -259,13 +244,11 @@ module Google attr_accessor :filter # Required. An arbitrary, developer-defined identifier of the type of game - # object that - # the playable location is used for. This field allows you to specify - # criteria per game object type when searching for playable locations. - # You should assign a unique `game_object_type` ID across all - # `request_criteria` to represent a distinct type of game object. For - # example, 1=monster location, 2=powerup location. - # The response contains a map. + # object that the playable location is used for. This field allows you to + # specify criteria per game object type when searching for playable locations. + # You should assign a unique `game_object_type` ID across all `request_criteria` + # to represent a distinct type of game object. For example, 1=monster location, + # 2=powerup location. The response contains a map. # Corresponds to the JSON property `gameObjectType` # @return [Fixnum] attr_accessor :game_object_type @@ -286,15 +269,15 @@ module Google class GoogleMapsPlayablelocationsV3SampleFilter include Google::Apis::Core::Hashable - # Restricts the set of playable locations to just the - # [types](/maps/documentation/gaming/tt/types) that you want. + # Restricts the set of playable locations to just the [types](/maps/ + # documentation/gaming/tt/types) that you want. # Corresponds to the JSON property `includedTypes` # @return [Array] attr_accessor :included_types - # Specifies the maximum number of playable locations to return. This value - # must not be greater than 1000. The default value is 100. - # Only the top-ranking playable locations are returned. + # Specifies the maximum number of playable locations to return. This value must + # not be greater than 1000. The default value is 100. Only the top-ranking + # playable locations are returned. # Corresponds to the JSON property `maxLocationCount` # @return [Fixnum] attr_accessor :max_location_count @@ -316,16 +299,14 @@ module Google end end - # A geographical point suitable for placing game objects in location-based - # games. + # A geographical point suitable for placing game objects in location-based games. class GoogleMapsPlayablelocationsV3SamplePlayableLocation include Google::Apis::Core::Hashable # An object representing a latitude/longitude pair. This is expressed as a pair # of doubles representing degrees latitude and degrees longitude. Unless - # specified otherwise, this must conform to the - # WGS84 - # standard. Values must be within normalized ranges. + # specified otherwise, this must conform to the WGS84 standard. Values must be + # within normalized ranges. # Corresponds to the JSON property `centerPoint` # @return [Google::Apis::PlayablelocationsV3::GoogleTypeLatLng] attr_accessor :center_point @@ -347,17 +328,15 @@ module Google # An object representing a latitude/longitude pair. This is expressed as a pair # of doubles representing degrees latitude and degrees longitude. Unless - # specified otherwise, this must conform to the - # WGS84 - # standard. Values must be within normalized ranges. + # specified otherwise, this must conform to the WGS84 standard. Values must be + # within normalized ranges. # Corresponds to the JSON property `snappedPoint` # @return [Google::Apis::PlayablelocationsV3::GoogleTypeLatLng] attr_accessor :snapped_point - # A collection of [Playable Location - # Types](/maps/documentation/gaming/tt/types) for this playable location. The - # first type in the collection is the primary type. - # Type information might not be available for all playable locations. + # A collection of [Playable Location Types](/maps/documentation/gaming/tt/types) + # for this playable location. The first type in the collection is the primary + # type. Type information might not be available for all playable locations. # Corresponds to the JSON property `types` # @return [Array] attr_accessor :types @@ -396,24 +375,19 @@ module Google end end - # Life of a query: - # - When a game starts in a new location, your game server issues a - # SamplePlayableLocations - # request. The request specifies the S2 cell, and contains one or more - # "criteria" for filtering: - # - Criterion 0: i locations for long-lived bases, or level 0 monsters, or... - # - Criterion 1: j locations for short-lived bases, or level 1 monsters, ... - # - Criterion 2: k locations for random objects. - # - etc (up to 5 criterion may be specified). - # `PlayableLocationList` will then contain mutually - # exclusive lists of `PlayableLocation` objects that satisfy each of - # the criteria. Think of it as a collection of real-world locations that you - # can then associate with your game state. - # 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. + # Life of a query: - When a game starts in a new location, your game server + # issues a SamplePlayableLocations request. The request specifies the S2 cell, + # and contains one or more "criteria" for filtering: - Criterion 0: i locations + # for long-lived bases, or level 0 monsters, or... - Criterion 1: j locations + # for short-lived bases, or level 1 monsters, ... - Criterion 2: k locations for + # random objects. - etc (up to 5 criterion may be specified). ` + # PlayableLocationList` will then contain mutually exclusive lists of ` + # PlayableLocation` objects that satisfy each of the criteria. Think of it as a + # collection of real-world locations that you can then associate with your game + # state. 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 include Google::Apis::Core::Hashable @@ -422,8 +396,8 @@ module Google # @return [Google::Apis::PlayablelocationsV3::GoogleMapsPlayablelocationsV3SampleAreaFilter] attr_accessor :area_filter - # Required. Specifies one or more (up to 5) criteria for filtering the - # returned playable locations. + # Required. Specifies one or more (up to 5) criteria for filtering the returned + # playable locations. # Corresponds to the JSON property `criteria` # @return [Array] attr_accessor :criteria @@ -439,26 +413,22 @@ module Google end end - # Response for the - # SamplePlayableLocations - # method. + # Response for the SamplePlayableLocations method. class GoogleMapsPlayablelocationsV3SamplePlayableLocationsResponse include Google::Apis::Core::Hashable - # Each PlayableLocation object corresponds to a game_object_type specified - # in the request. + # Each PlayableLocation object corresponds to a game_object_type specified in + # the request. # Corresponds to the JSON property `locationsPerGameObjectType` # @return [Hash] attr_accessor :locations_per_game_object_type # Required. Specifies the "time-to-live" for the set of playable locations. You - # can use - # this value to determine how long to cache the set of playable locations. - # After this length of time, your back-end game server should issue a new - # SamplePlayableLocations - # request to get a fresh set of playable locations (because for example, they - # might have been removed, a park might have closed for the day, a - # business might have closed permanently). + # can use this value to determine how long to cache the set of playable + # locations. After this length of time, your back-end game server should issue a + # new SamplePlayableLocations request to get a fresh set of playable locations ( + # because for example, they might have been removed, a park might have closed + # for the day, a business might have closed permanently). # Corresponds to the JSON property `ttl` # @return [String] attr_accessor :ttl @@ -479,42 +449,28 @@ module Google include Google::Apis::Core::Hashable # Required. The minimum spacing between any two playable locations, measured in - # meters. - # The minimum value is 30. - # The maximum value is 1000. - # Inputs will be rounded up to the next 10 meter interval. - # The default value is 200m. - # Set this field to remove tight clusters of playable locations. - # 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: + # meters. The minimum value is 30. The maximum value is 1000. Inputs will be + # rounded up to the next 10 meter interval. The default value is 200m. Set this + # field to remove tight clusters of playable locations. 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 - # ones. - # Suppose three game object types, each with the following spacing: - # * X: 400m, Y: undefined, Z: 200m. - # 1. Add locations for X, within 400m of each other. - # 2. Add locations for Y, without any spacing. - # 3. Finally, add locations for Z within 200m of each other as well X and Y. - # 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. + # ones. Suppose three game object types, each with the following spacing: * X: + # 400m, Y: undefined, Z: 200m. 1. Add locations for X, within 400m of each other. + # 2. Add locations for Y, without any spacing. 3. Finally, add locations for Z + # within 200m of each other as well X and Y. 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` # @return [Float] attr_accessor :min_spacing_meters - # Specifies whether the minimum spacing constraint applies to the - # center-point or to the snapped point of playable locations. The default - # value is `CENTER_POINT`. - # If a snapped point is not available for a playable location, its - # center-point is used instead. - # Set this to the point type used in your game. + # Specifies whether the minimum spacing constraint applies to the center-point + # or to the snapped point of playable locations. The default value is ` + # CENTER_POINT`. If a snapped point is not available for a playable location, + # its center-point is used instead. Set this to the point type used in your game. # Corresponds to the JSON property `pointType` # @return [String] attr_accessor :point_type @@ -534,46 +490,44 @@ module Google class GoogleMapsUnityClientInfo include Google::Apis::Core::Hashable - # API client name and version. For example, the SDK calling the API. The - # exact format is up to the client. + # API client name and version. For example, the SDK calling the API. The exact + # format is up to the client. # Corresponds to the JSON property `apiClient` # @return [String] attr_accessor :api_client - # Application ID, such as the package name on Android and the bundle - # identifier on iOS platforms. + # Application ID, such as the package name on Android and the bundle identifier + # on iOS platforms. # Corresponds to the JSON property `applicationId` # @return [String] attr_accessor :application_id - # Application version number, such as "1.2.3". The exact format is - # application-dependent. + # Application version number, such as "1.2.3". The exact format is application- + # dependent. # Corresponds to the JSON property `applicationVersion` # @return [String] attr_accessor :application_version - # Device model as reported by the device. The exact format is - # platform-dependent. + # Device model as reported by the device. The exact format is platform-dependent. # Corresponds to the JSON property `deviceModel` # @return [String] attr_accessor :device_model # 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 - # http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + # Examples are "en", "en-US" or "ja-Latn". For more information, see http://www. + # unicode.org/reports/tr35/#Unicode_locale_identifier. # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code - # Operating system name and version as reported by the OS. For example, - # "Mac OS X 10.10.4". The exact format is platform-dependent. + # Operating system name and version as reported by the OS. For example, "Mac OS + # X 10.10.4". The exact format is platform-dependent. # Corresponds to the JSON property `operatingSystem` # @return [String] attr_accessor :operating_system - # Build number/version of the operating system. e.g., the contents of - # android.os.Build.ID in Android, or the contents of sysctl "kern.osversion" - # in iOS. + # Build number/version of the operating system. e.g., the contents of android.os. + # Build.ID in Android, or the contents of sysctl "kern.osversion" in iOS. # Corresponds to the JSON property `operatingSystemBuild` # @return [String] attr_accessor :operating_system_build @@ -602,9 +556,8 @@ module Google # An object representing a latitude/longitude pair. This is expressed as a pair # of doubles representing degrees latitude and degrees longitude. Unless - # specified otherwise, this must conform to the - # WGS84 - # standard. Values must be within normalized ranges. + # specified otherwise, this must conform to the WGS84 standard. Values must be + # within normalized ranges. class GoogleTypeLatLng include Google::Apis::Core::Hashable diff --git a/generated/google/apis/playablelocations_v3/service.rb b/generated/google/apis/playablelocations_v3/service.rb index f45fe1a8a..5997a5cdc 100644 --- a/generated/google/apis/playablelocations_v3/service.rb +++ b/generated/google/apis/playablelocations_v3/service.rb @@ -48,9 +48,9 @@ module Google end # Logs new events when playable locations are displayed, and when they are - # interacted with. - # Impressions are not partially saved; either all impressions are saved and - # this request succeeds, or no impressions are saved, and this request fails. + # interacted with. Impressions are not partially saved; either all impressions + # are saved and this request succeeds, or no impressions are saved, and this + # request fails. # @param [Google::Apis::PlayablelocationsV3::GoogleMapsPlayablelocationsV3LogImpressionsRequest] google_maps_playablelocations_v3_log_impressions_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -80,9 +80,9 @@ module Google execute_or_queue_command(command, &block) end - # Logs bad playable location reports submitted by players. - # Reports are not partially saved; either all reports are saved and this - # request succeeds, or no reports are saved, and this request fails. + # Logs bad playable location reports submitted by players. Reports are not + # partially saved; either all reports are saved and this request succeeds, or no + # reports are saved, and this request fails. # @param [Google::Apis::PlayablelocationsV3::GoogleMapsPlayablelocationsV3LogPlayerReportsRequest] google_maps_playablelocations_v3_log_player_reports_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -112,10 +112,10 @@ module Google execute_or_queue_command(command, &block) end - # Returns a set of playable locations that lie within a specified area, - # that satisfy optional filter criteria. - # Note: Identical `SamplePlayableLocations` requests can return different - # results as the state of the world changes over time. + # Returns a set of playable locations that lie within a specified area, that + # satisfy optional filter criteria. Note: Identical `SamplePlayableLocations` + # requests can return different results as the state of the world changes over + # time. # @param [Google::Apis::PlayablelocationsV3::GoogleMapsPlayablelocationsV3SamplePlayableLocationsRequest] google_maps_playablelocations_v3_sample_playable_locations_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. diff --git a/generated/google/apis/securitycenter_v1.rb b/generated/google/apis/securitycenter_v1.rb index 4183cb22a..bd6bb4f8d 100644 --- a/generated/google/apis/securitycenter_v1.rb +++ b/generated/google/apis/securitycenter_v1.rb @@ -26,7 +26,7 @@ module Google # @see https://console.cloud.google.com/apis/api/securitycenter.googleapis.com/overview module SecuritycenterV1 VERSION = 'V1' - REVISION = '20200731' + REVISION = '20200806' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/securitycenter_v1/classes.rb b/generated/google/apis/securitycenter_v1/classes.rb index d66374372..6177cd580 100644 --- a/generated/google/apis/securitycenter_v1/classes.rb +++ b/generated/google/apis/securitycenter_v1/classes.rb @@ -731,6 +731,11 @@ module Google # @return [Google::Apis::SecuritycenterV1::GoogleCloudSecuritycenterV1p1beta1SecurityMarks] 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 # 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 @@ -758,6 +763,7 @@ module Google @parent = args[:parent] if args.key?(:parent) @resource_name = args[:resource_name] if args.key?(:resource_name) @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) @state = args[:state] if args.key?(:state) end diff --git a/generated/google/apis/securitycenter_v1/representations.rb b/generated/google/apis/securitycenter_v1/representations.rb index af3e6eaff..0d737c698 100644 --- a/generated/google/apis/securitycenter_v1/representations.rb +++ b/generated/google/apis/securitycenter_v1/representations.rb @@ -493,6 +493,7 @@ module Google property :resource_name, as: 'resourceName' 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' property :state, as: 'state' end diff --git a/generated/google/apis/securitycenter_v1beta1.rb b/generated/google/apis/securitycenter_v1beta1.rb index 3125323ce..620c27038 100644 --- a/generated/google/apis/securitycenter_v1beta1.rb +++ b/generated/google/apis/securitycenter_v1beta1.rb @@ -26,7 +26,7 @@ module Google # @see https://console.cloud.google.com/apis/api/securitycenter.googleapis.com/overview module SecuritycenterV1beta1 VERSION = 'V1beta1' - REVISION = '20200731' + REVISION = '20200806' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/securitycenter_v1beta1/classes.rb b/generated/google/apis/securitycenter_v1beta1/classes.rb index 5045fa01f..341814cf4 100644 --- a/generated/google/apis/securitycenter_v1beta1/classes.rb +++ b/generated/google/apis/securitycenter_v1beta1/classes.rb @@ -867,6 +867,11 @@ module Google # @return [Google::Apis::SecuritycenterV1beta1::GoogleCloudSecuritycenterV1p1beta1SecurityMarks] 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 # 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 @@ -894,6 +899,7 @@ module Google @parent = args[:parent] if args.key?(:parent) @resource_name = args[:resource_name] if args.key?(:resource_name) @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) @state = args[:state] if args.key?(:state) end diff --git a/generated/google/apis/securitycenter_v1beta1/representations.rb b/generated/google/apis/securitycenter_v1beta1/representations.rb index 3c52b723a..1c1c5e1a1 100644 --- a/generated/google/apis/securitycenter_v1beta1/representations.rb +++ b/generated/google/apis/securitycenter_v1beta1/representations.rb @@ -504,6 +504,7 @@ module Google property :resource_name, as: 'resourceName' 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' property :state, as: 'state' end diff --git a/generated/google/apis/securitycenter_v1p1alpha1.rb b/generated/google/apis/securitycenter_v1p1alpha1.rb index c7030ce3a..22f8a54c9 100644 --- a/generated/google/apis/securitycenter_v1p1alpha1.rb +++ b/generated/google/apis/securitycenter_v1p1alpha1.rb @@ -26,7 +26,7 @@ module Google # @see https://console.cloud.google.com/apis/api/securitycenter.googleapis.com/overview module SecuritycenterV1p1alpha1 VERSION = 'V1p1alpha1' - REVISION = '20200731' + REVISION = '20200806' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/securitycenter_v1p1alpha1/classes.rb b/generated/google/apis/securitycenter_v1p1alpha1/classes.rb index 1f57cbae6..8fb284c18 100644 --- a/generated/google/apis/securitycenter_v1p1alpha1/classes.rb +++ b/generated/google/apis/securitycenter_v1p1alpha1/classes.rb @@ -397,6 +397,11 @@ module Google # @return [Google::Apis::SecuritycenterV1p1alpha1::GoogleCloudSecuritycenterV1p1beta1SecurityMarks] 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 # 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 @@ -424,6 +429,7 @@ module Google @parent = args[:parent] if args.key?(:parent) @resource_name = args[:resource_name] if args.key?(:resource_name) @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) @state = args[:state] if args.key?(:state) end diff --git a/generated/google/apis/securitycenter_v1p1alpha1/representations.rb b/generated/google/apis/securitycenter_v1p1alpha1/representations.rb index 40564f165..5c13701cb 100644 --- a/generated/google/apis/securitycenter_v1p1alpha1/representations.rb +++ b/generated/google/apis/securitycenter_v1p1alpha1/representations.rb @@ -225,6 +225,7 @@ module Google property :resource_name, as: 'resourceName' 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' property :state, as: 'state' end diff --git a/generated/google/apis/securitycenter_v1p1beta1.rb b/generated/google/apis/securitycenter_v1p1beta1.rb index f2109cf11..5a6300ea0 100644 --- a/generated/google/apis/securitycenter_v1p1beta1.rb +++ b/generated/google/apis/securitycenter_v1p1beta1.rb @@ -26,7 +26,7 @@ module Google # @see https://console.cloud.google.com/apis/api/securitycenter.googleapis.com/overview module SecuritycenterV1p1beta1 VERSION = 'V1p1beta1' - REVISION = '20200731' + REVISION = '20200806' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/securitycenter_v1p1beta1/classes.rb b/generated/google/apis/securitycenter_v1p1beta1/classes.rb index 1779617da..0045d0355 100644 --- a/generated/google/apis/securitycenter_v1p1beta1/classes.rb +++ b/generated/google/apis/securitycenter_v1p1beta1/classes.rb @@ -662,6 +662,11 @@ module Google # @return [Google::Apis::SecuritycenterV1p1beta1::GoogleCloudSecuritycenterV1p1beta1SecurityMarks] 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 # 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 @@ -689,6 +694,7 @@ module Google @parent = args[:parent] if args.key?(:parent) @resource_name = args[:resource_name] if args.key?(:resource_name) @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) @state = args[:state] if args.key?(:state) end diff --git a/generated/google/apis/securitycenter_v1p1beta1/representations.rb b/generated/google/apis/securitycenter_v1p1beta1/representations.rb index f76b38871..6a9a332d2 100644 --- a/generated/google/apis/securitycenter_v1p1beta1/representations.rb +++ b/generated/google/apis/securitycenter_v1p1beta1/representations.rb @@ -459,6 +459,7 @@ module Google property :resource_name, as: 'resourceName' 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' property :state, as: 'state' end diff --git a/generated/google/apis/slides_v1.rb b/generated/google/apis/slides_v1.rb index 4e1e91c64..f435e6502 100644 --- a/generated/google/apis/slides_v1.rb +++ b/generated/google/apis/slides_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/slides/ module SlidesV1 VERSION = 'V1' - REVISION = '20200611' + REVISION = '20200803' # See, edit, create, and delete all of your Google Drive files AUTH_DRIVE = 'https://www.googleapis.com/auth/drive' diff --git a/generated/google/apis/slides_v1/classes.rb b/generated/google/apis/slides_v1/classes.rb index 8d3497042..cc014845c 100644 --- a/generated/google/apis/slides_v1/classes.rb +++ b/generated/google/apis/slides_v1/classes.rb @@ -22,15 +22,11 @@ module Google module Apis module SlidesV1 - # AffineTransform uses a 3x3 matrix with an implied last row of [ 0 0 1 ] - # to transform source coordinates (x,y) into destination coordinates (x', y') - # according to: - # x' x = shear_y scale_y translate_y - # 1 [ 1 ] - # After transformation, - # x' = scale_x * x + shear_x * y + translate_x; - # y' = scale_y * y + shear_y * x + translate_y; - # This message is therefore composed of these six matrix elements. + # AffineTransform uses a 3x3 matrix with an implied last row of [ 0 0 1 ] to + # transform source coordinates (x,y) into destination coordinates (x', y') + # according to: x' x = shear_y scale_y translate_y 1 [ 1 ] After transformation, + # x' = scale_x * x + shear_x * y + translate_x; y' = scale_y * y + shear_y * x + + # translate_y; This message is therefore composed of these six matrix elements. class AffineTransform include Google::Apis::Core::Hashable @@ -94,21 +90,18 @@ module Google # @return [String] attr_accessor :content - # Represents the styling that can be applied to a TextRun. - # If this text is contained in a shape with a parent placeholder, then these - # text styles may be + # Represents the styling that can be applied to a TextRun. If this text is + # contained in a shape with a parent placeholder, then these text styles may be # inherited from the parent. Which text styles are inherited depend on the - # nesting level of lists: - # * A text run in a paragraph that is not in a list will inherit its text style - # from the the newline character in the paragraph at the 0 nesting level of - # the list inside the parent placeholder. - # * A text run in a paragraph that is in a list will inherit its text style - # from the newline character in the paragraph at its corresponding nesting - # level of the list inside the parent placeholder. - # Inherited text styles are represented as unset fields in this message. If - # text is contained in a shape without a parent placeholder, unsetting these - # fields will revert the style to a value matching the defaults in the Slides - # editor. + # nesting level of lists: * A text run in a paragraph that is not in a list will + # inherit its text style from the the newline character in the paragraph at the + # 0 nesting level of the list inside the parent placeholder. * A text run in a + # paragraph that is in a list will inherit its text style from the newline + # character in the paragraph at its corresponding nesting level of the list + # inside the parent placeholder. Inherited text styles are represented as unset + # fields in this message. If text is contained in a shape without a parent + # placeholder, unsetting these fields will revert the style to a value matching + # the defaults in the Slides editor. # Corresponds to the JSON property `style` # @return [Google::Apis::SlidesV1::TextStyle] attr_accessor :style @@ -164,8 +157,8 @@ module Google # @return [String] attr_accessor :presentation_id - # The reply of the updates. This maps 1:1 with the updates, although - # replies to some requests may be empty. + # The reply of the updates. This maps 1:1 with the updates, although replies to + # some requests may be empty. # Corresponds to the JSON property `replies` # @return [Array] attr_accessor :replies @@ -191,21 +184,18 @@ module Google class Bullet include Google::Apis::Core::Hashable - # Represents the styling that can be applied to a TextRun. - # If this text is contained in a shape with a parent placeholder, then these - # text styles may be + # Represents the styling that can be applied to a TextRun. If this text is + # contained in a shape with a parent placeholder, then these text styles may be # inherited from the parent. Which text styles are inherited depend on the - # nesting level of lists: - # * A text run in a paragraph that is not in a list will inherit its text style - # from the the newline character in the paragraph at the 0 nesting level of - # the list inside the parent placeholder. - # * A text run in a paragraph that is in a list will inherit its text style - # from the newline character in the paragraph at its corresponding nesting - # level of the list inside the parent placeholder. - # Inherited text styles are represented as unset fields in this message. If - # text is contained in a shape without a parent placeholder, unsetting these - # fields will revert the style to a value matching the defaults in the Slides - # editor. + # nesting level of lists: * A text run in a paragraph that is not in a list will + # inherit its text style from the the newline character in the paragraph at the + # 0 nesting level of the list inside the parent placeholder. * A text run in a + # paragraph that is in a list will inherit its text style from the newline + # character in the paragraph at its corresponding nesting level of the list + # inside the parent placeholder. Inherited text styles are represented as unset + # fields in this message. If text is contained in a shape without a parent + # placeholder, unsetting these fields will revert the style to a value matching + # the defaults in the Slides editor. # Corresponds to the JSON property `bulletStyle` # @return [Google::Apis::SlidesV1::TextStyle] attr_accessor :bullet_style @@ -261,8 +251,8 @@ module Google class ColorStop include Google::Apis::Core::Hashable - # The alpha value of this color in the gradient band. Defaults to 1.0, - # fully opaque. + # The alpha value of this color in the gradient band. Defaults to 1.0, fully + # opaque. # Corresponds to the JSON property `alpha` # @return [Float] attr_accessor :alpha @@ -272,8 +262,8 @@ module Google # @return [Google::Apis::SlidesV1::OpaqueColor] attr_accessor :color - # The relative position of the color stop in the gradient band measured - # in percentage. The value should be in the interval [0.0, 1.0]. + # The relative position of the color stop in the gradient band measured in + # percentage. The value should be in the interval [0.0, 1.0]. # Corresponds to the JSON property `position` # @return [Float] attr_accessor :position @@ -294,34 +284,28 @@ module Google class CreateImageRequest include Google::Apis::Core::Hashable - # Common properties for a page element. - # Note: When you initially create a - # PageElement, the API may modify - # the values of both `size` and `transform`, but the - # visual size will be unchanged. + # Common properties for a page element. Note: When you initially create a + # PageElement, the API may modify the values of both `size` and `transform`, but + # the visual size will be unchanged. # Corresponds to the JSON property `elementProperties` # @return [Google::Apis::SlidesV1::PageElementProperties] attr_accessor :element_properties - # A user-supplied object ID. - # If you specify an ID, it must be unique among all pages and page elements - # in the presentation. The ID must start with an alphanumeric character or an - # underscore (matches regex `[a-zA-Z0-9_]`); remaining characters - # may include those as well as a hyphen or colon (matches regex - # `[a-zA-Z0-9_-:]`). - # The length of the ID must not be less than 5 or greater than 50. - # If you don't specify an ID, a unique one is generated. + # A user-supplied object ID. If you specify an ID, it must be unique among all + # pages and page elements in the presentation. The ID must start with an + # alphanumeric character or an underscore (matches regex `[a-zA-Z0-9_]`); + # remaining characters may include those as well as a hyphen or colon (matches + # regex `[a-zA-Z0-9_-:]`). The length of the ID must not be less than 5 or + # greater than 50. If you don't specify an ID, a unique one is generated. # Corresponds to the JSON property `objectId` # @return [String] attr_accessor :object_id_prop - # The image URL. - # The image is fetched once at insertion time and a copy is stored for - # display inside the presentation. Images must be less than 50MB in size, - # cannot exceed 25 megapixels, and must be in one of PNG, JPEG, or GIF - # format. - # The provided URL can be at most 2 kB in length. The URL itself is saved - # with the image, and exposed via the Image.source_url field. + # The image URL. The image is fetched once at insertion time and a copy is + # stored for display inside the presentation. Images must be less than 50MB in + # size, cannot exceed 25 megapixels, and must be in one of PNG, JPEG, or GIF + # format. The provided URL can be at most 2 kB in length. The URL itself is + # saved with the image, and exposed via the Image.source_url field. # Corresponds to the JSON property `url` # @return [String] attr_accessor :url @@ -361,47 +345,37 @@ module Google class CreateLineRequest include Google::Apis::Core::Hashable - # The category of the line to be created. - # The exact line type created is - # determined based on the category and how it's routed to connect to other - # page elements. - # If you specify both a `category` and a `line_category`, the `category` - # takes precedence. - # If you do not specify a value for `category`, but specify a value for - # `line_category`, then the specified `line_category` value is used. - # If you do not specify either, then STRAIGHT is used. + # The category of the line to be created. The exact line type created is + # determined based on the category and how it's routed to connect to other page + # elements. If you specify both a `category` and a `line_category`, the ` + # category` takes precedence. If you do not specify a value for `category`, but + # specify a value for `line_category`, then the specified `line_category` value + # is used. If you do not specify either, then STRAIGHT is used. # Corresponds to the JSON property `category` # @return [String] attr_accessor :category - # Common properties for a page element. - # Note: When you initially create a - # PageElement, the API may modify - # the values of both `size` and `transform`, but the - # visual size will be unchanged. + # Common properties for a page element. Note: When you initially create a + # PageElement, the API may modify the values of both `size` and `transform`, but + # the visual size will be unchanged. # Corresponds to the JSON property `elementProperties` # @return [Google::Apis::SlidesV1::PageElementProperties] attr_accessor :element_properties - # The category of the line to be created. - # Deprecated: use `category` instead. - # The exact line type created is - # determined based on the category and how it's routed to connect to other - # page elements. - # If you specify both a `category` and a `line_category`, the `category` - # takes precedence. + # The category of the line to be created. *Deprecated*: use `category` instead. + # The exact line type created is determined based on the category and how it's + # routed to connect to other page elements. If you specify both a `category` and + # a `line_category`, the `category` takes precedence. # Corresponds to the JSON property `lineCategory` # @return [String] attr_accessor :line_category - # A user-supplied object ID. - # If you specify an ID, it must be unique among all pages and page elements - # in the presentation. The ID must start with an alphanumeric character or an - # underscore (matches regex `[a-zA-Z0-9_]`); remaining characters - # may include those as well as a hyphen or colon (matches regex - # `[a-zA-Z0-9_-:]`). - # The length of the ID must not be less than 5 or greater than 50. - # If you don't specify an ID, a unique one is generated. + # A user-supplied object ID. If you specify an ID, it must be unique among all + # pages and page elements in the presentation. The ID must start with an + # alphanumeric character or an underscore (matches regex `[a-zA-Z0-9_]`); + # remaining characters may include those as well as a hyphen or colon (matches + # regex `[a-zA-Z0-9_-:]`). The length of the ID must not be less than 5 or + # greater than 50. If you don't specify an ID, a unique one is generated. # Corresponds to the JSON property `objectId` # @return [String] attr_accessor :object_id_prop @@ -438,20 +412,18 @@ module Google end end - # Creates bullets for all of the paragraphs that overlap with the given - # text index range. - # The nesting level of each paragraph will be determined by counting leading - # tabs in front of each paragraph. To avoid excess space between the bullet and - # the corresponding paragraph, these leading tabs are removed by this request. - # This may change the indices of parts of the text. - # If the paragraph immediately before paragraphs being updated is in a list - # with a matching preset, the paragraphs being updated are added to that - # preceding list. + # Creates bullets for all of the paragraphs that overlap with the given text + # index range. The nesting level of each paragraph will be determined by + # counting leading tabs in front of each paragraph. To avoid excess space + # between the bullet and the corresponding paragraph, these leading tabs are + # removed by this request. This may change the indices of parts of the text. If + # the paragraph immediately before paragraphs being updated is in a list with a + # matching preset, the paragraphs being updated are added to that preceding list. class CreateParagraphBulletsRequest include Google::Apis::Core::Hashable - # The kinds of bullet glyphs to be used. Defaults to the - # `BULLET_DISC_CIRCLE_SQUARE` preset. + # The kinds of bullet glyphs to be used. Defaults to the ` + # BULLET_DISC_CIRCLE_SQUARE` preset. # Corresponds to the JSON property `bulletPreset` # @return [String] attr_accessor :bullet_preset @@ -489,23 +461,19 @@ module Google class CreateShapeRequest include Google::Apis::Core::Hashable - # Common properties for a page element. - # Note: When you initially create a - # PageElement, the API may modify - # the values of both `size` and `transform`, but the - # visual size will be unchanged. + # Common properties for a page element. Note: When you initially create a + # PageElement, the API may modify the values of both `size` and `transform`, but + # the visual size will be unchanged. # Corresponds to the JSON property `elementProperties` # @return [Google::Apis::SlidesV1::PageElementProperties] attr_accessor :element_properties - # A user-supplied object ID. - # If you specify an ID, it must be unique among all pages and page elements - # in the presentation. The ID must start with an alphanumeric character or an - # underscore (matches regex `[a-zA-Z0-9_]`); remaining characters - # may include those as well as a hyphen or colon (matches regex - # `[a-zA-Z0-9_-:]`). - # The length of the ID must not be less than 5 or greater than 50. - # If empty, a unique identifier will be generated. + # A user-supplied object ID. If you specify an ID, it must be unique among all + # pages and page elements in the presentation. The ID must start with an + # alphanumeric character or an underscore (matches regex `[a-zA-Z0-9_]`); + # remaining characters may include those as well as a hyphen or colon (matches + # regex `[a-zA-Z0-9_-:]`). The length of the ID must not be less than 5 or + # greater than 50. If empty, a unique identifier will be generated. # Corresponds to the JSON property `objectId` # @return [String] attr_accessor :object_id_prop @@ -546,9 +514,9 @@ module Google end end - # Creates an embedded Google Sheets chart. - # NOTE: Chart creation requires at least one of the spreadsheets.readonly, - # spreadsheets, drive.readonly, drive.file, or drive OAuth scopes. + # Creates an embedded Google Sheets chart. NOTE: Chart creation requires at + # least one of the spreadsheets.readonly, spreadsheets, drive.readonly, drive. + # file, or drive OAuth scopes. class CreateSheetsChartRequest include Google::Apis::Core::Hashable @@ -557,27 +525,24 @@ module Google # @return [Fixnum] attr_accessor :chart_id - # Common properties for a page element. - # Note: When you initially create a - # PageElement, the API may modify - # the values of both `size` and `transform`, but the - # visual size will be unchanged. + # Common properties for a page element. Note: When you initially create a + # PageElement, the API may modify the values of both `size` and `transform`, but + # the visual size will be unchanged. # Corresponds to the JSON property `elementProperties` # @return [Google::Apis::SlidesV1::PageElementProperties] attr_accessor :element_properties - # The mode with which the chart is linked to the source spreadsheet. When - # not specified, the chart will be an image that is not linked. + # The mode with which the chart is linked to the source spreadsheet. When not + # specified, the chart will be an image that is not linked. # Corresponds to the JSON property `linkingMode` # @return [String] attr_accessor :linking_mode - # A user-supplied object ID. - # If specified, the ID must be unique among all pages and page elements in - # the presentation. The ID should start with a word character [a-zA-Z0-9_] - # and then followed by any number of the following characters [a-zA-Z0-9_-:]. - # The length of the ID should not be less than 5 or greater than 50. - # If empty, a unique identifier will be generated. + # A user-supplied object ID. If specified, the ID must be unique among all pages + # and page elements in the presentation. The ID should start with a word + # character [a-zA-Z0-9_] and then followed by any number of the following + # characters [a-zA-Z0-9_-:]. The length of the ID should not be less than 5 or + # greater than 50. If empty, a unique identifier will be generated. # Corresponds to the JSON property `objectId` # @return [String] attr_accessor :object_id_prop @@ -624,35 +589,31 @@ module Google class CreateSlideRequest include Google::Apis::Core::Hashable - # The optional zero-based index indicating where to insert the slides. - # If you don't specify an index, the new slide is created at the end. + # The optional zero-based index indicating where to insert the slides. If you + # don't specify an index, the new slide is created at the end. # Corresponds to the JSON property `insertionIndex` # @return [Fixnum] attr_accessor :insertion_index - # A user-supplied object ID. - # If you specify an ID, it must be unique among all pages and page elements - # in the presentation. The ID must start with an alphanumeric character or an - # underscore (matches regex `[a-zA-Z0-9_]`); remaining characters - # may include those as well as a hyphen or colon (matches regex - # `[a-zA-Z0-9_-:]`). - # The length of the ID must not be less than 5 or greater than 50. - # If you don't specify an ID, a unique one is generated. + # A user-supplied object ID. If you specify an ID, it must be unique among all + # pages and page elements in the presentation. The ID must start with an + # alphanumeric character or an underscore (matches regex `[a-zA-Z0-9_]`); + # remaining characters may include those as well as a hyphen or colon (matches + # regex `[a-zA-Z0-9_-:]`). The length of the ID must not be less than 5 or + # greater than 50. If you don't specify an ID, a unique one is generated. # Corresponds to the JSON property `objectId` # @return [String] attr_accessor :object_id_prop # An optional list of object ID mappings from the placeholder(s) on the layout - # to the placeholder(s) - # that will be created on the new slide from that specified layout. Can only - # be used when `slide_layout_reference` is specified. + # to the placeholder(s) that will be created on the new slide from that + # specified layout. Can only be used when `slide_layout_reference` is specified. # Corresponds to the JSON property `placeholderIdMappings` # @return [Array] attr_accessor :placeholder_id_mappings - # Slide layout reference. This may reference either: - # - A predefined layout - # - One of the layouts in the presentation. + # Slide layout reference. This may reference either: - A predefined layout - One + # of the layouts in the presentation. # Corresponds to the JSON property `slideLayoutReference` # @return [Google::Apis::SlidesV1::LayoutReference] attr_accessor :slide_layout_reference @@ -698,23 +659,19 @@ module Google # @return [Fixnum] attr_accessor :columns - # Common properties for a page element. - # Note: When you initially create a - # PageElement, the API may modify - # the values of both `size` and `transform`, but the - # visual size will be unchanged. + # Common properties for a page element. Note: When you initially create a + # PageElement, the API may modify the values of both `size` and `transform`, but + # the visual size will be unchanged. # Corresponds to the JSON property `elementProperties` # @return [Google::Apis::SlidesV1::PageElementProperties] attr_accessor :element_properties - # A user-supplied object ID. - # If you specify an ID, it must be unique among all pages and page elements - # in the presentation. The ID must start with an alphanumeric character or an - # underscore (matches regex `[a-zA-Z0-9_]`); remaining characters - # may include those as well as a hyphen or colon (matches regex - # `[a-zA-Z0-9_-:]`). - # The length of the ID must not be less than 5 or greater than 50. - # If you don't specify an ID, a unique one is generated. + # A user-supplied object ID. If you specify an ID, it must be unique among all + # pages and page elements in the presentation. The ID must start with an + # alphanumeric character or an underscore (matches regex `[a-zA-Z0-9_]`); + # remaining characters may include those as well as a hyphen or colon (matches + # regex `[a-zA-Z0-9_-:]`). The length of the ID must not be less than 5 or + # greater than 50. If you don't specify an ID, a unique one is generated. # Corresponds to the JSON property `objectId` # @return [String] attr_accessor :object_id_prop @@ -756,38 +713,33 @@ module Google end end - # Creates a video. - # NOTE: Creating a video from Google Drive requires that the requesting app - # have at least one of the drive, drive.readonly, or drive.file OAuth scopes. + # Creates a video. NOTE: Creating a video from Google Drive requires that the + # requesting app have at least one of the drive, drive.readonly, or drive.file + # OAuth scopes. class CreateVideoRequest include Google::Apis::Core::Hashable - # Common properties for a page element. - # Note: When you initially create a - # PageElement, the API may modify - # the values of both `size` and `transform`, but the - # visual size will be unchanged. + # Common properties for a page element. Note: When you initially create a + # PageElement, the API may modify the values of both `size` and `transform`, but + # the visual size will be unchanged. # Corresponds to the JSON property `elementProperties` # @return [Google::Apis::SlidesV1::PageElementProperties] attr_accessor :element_properties - # The video source's unique identifier for this video. - # e.g. For YouTube video https://www.youtube.com/watch?v=7U3axjORYZ0, - # the ID is 7U3axjORYZ0. For a Google Drive video - # https://drive.google.com/file/d/1xCgQLFTJi5_Xl8DgW_lcUYq5e-q6Hi5Q the ID - # is 1xCgQLFTJi5_Xl8DgW_lcUYq5e-q6Hi5Q. + # The video source's unique identifier for this video. e.g. For YouTube video + # https://www.youtube.com/watch?v=7U3axjORYZ0, the ID is 7U3axjORYZ0. For a + # Google Drive video https://drive.google.com/file/d/1xCgQLFTJi5_Xl8DgW_lcUYq5e- + # q6Hi5Q the ID is 1xCgQLFTJi5_Xl8DgW_lcUYq5e-q6Hi5Q. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id - # A user-supplied object ID. - # If you specify an ID, it must be unique among all pages and page elements - # in the presentation. The ID must start with an alphanumeric character or an - # underscore (matches regex `[a-zA-Z0-9_]`); remaining characters - # may include those as well as a hyphen or colon (matches regex - # `[a-zA-Z0-9_-:]`). - # The length of the ID must not be less than 5 or greater than 50. - # If you don't specify an ID, a unique one is generated. + # A user-supplied object ID. If you specify an ID, it must be unique among all + # pages and page elements in the presentation. The ID must start with an + # alphanumeric character or an underscore (matches regex `[a-zA-Z0-9_]`); + # remaining characters may include those as well as a hyphen or colon (matches + # regex `[a-zA-Z0-9_-:]`). The length of the ID must not be less than 5 or + # greater than 50. If you don't specify an ID, a unique one is generated. # Corresponds to the JSON property `objectId` # @return [String] attr_accessor :object_id_prop @@ -830,27 +782,24 @@ module Google end # The crop properties of an object enclosed in a container. For example, an - # Image. - # The crop properties is represented by the offsets of four edges which define - # a crop rectangle. The offsets are measured in percentage from the - # corresponding edges of the object's original bounding rectangle towards - # inside, relative to the object's original dimensions. - # - If the offset is in the interval (0, 1), the corresponding edge of crop - # rectangle is positioned inside of the object's original bounding rectangle. - # - If the offset is negative or greater than 1, the corresponding edge of crop - # rectangle is positioned outside of the object's original bounding rectangle. - # - If the left edge of the crop rectangle is on the right side of its right - # edge, the object will be flipped horizontally. - # - If the top edge of the crop rectangle is below its bottom edge, the object - # will be flipped vertically. - # - If all offsets and rotation angle is 0, the object is not cropped. - # After cropping, the content in the crop rectangle will be stretched to fit - # its container. + # Image. The crop properties is represented by the offsets of four edges which + # define a crop rectangle. The offsets are measured in percentage from the + # corresponding edges of the object's original bounding rectangle towards inside, + # relative to the object's original dimensions. - If the offset is in the + # interval (0, 1), the corresponding edge of crop rectangle is positioned inside + # of the object's original bounding rectangle. - If the offset is negative or + # greater than 1, the corresponding edge of crop rectangle is positioned outside + # of the object's original bounding rectangle. - If the left edge of the crop + # rectangle is on the right side of its right edge, the object will be flipped + # horizontally. - If the top edge of the crop rectangle is below its bottom edge, + # the object will be flipped vertically. - If all offsets and rotation angle is + # 0, the object is not cropped. After cropping, the content in the crop + # rectangle will be stretched to fit its container. class CropProperties include Google::Apis::Core::Hashable - # The rotation angle of the crop window around its center, in radians. - # Rotation angle is applied after the offset. + # The rotation angle of the crop window around its center, in radians. Rotation + # angle is applied after the offset. # Corresponds to the JSON property `angle` # @return [Float] attr_accessor :angle @@ -863,22 +812,22 @@ module Google attr_accessor :bottom_offset # The offset specifies the left edge of the crop rectangle that is located to - # the right of the original bounding rectangle left edge, relative to the - # object's original width. + # the right of the original bounding rectangle left edge, relative to the object' + # s original width. # Corresponds to the JSON property `leftOffset` # @return [Float] attr_accessor :left_offset - # The offset specifies the right edge of the crop rectangle that is located - # to the left of the original bounding rectangle right edge, relative to the - # object's original width. + # The offset specifies the right edge of the crop rectangle that is located to + # the left of the original bounding rectangle right edge, relative to the object' + # s original width. # Corresponds to the JSON property `rightOffset` # @return [Float] attr_accessor :right_offset - # The offset specifies the top edge of the crop rectangle that is located - # below the original bounding rectangle top edge, relative to the object's - # original height. + # The offset specifies the top edge of the crop rectangle that is located below + # the original bounding rectangle top edge, relative to the object's original + # height. # Corresponds to the JSON property `topOffset` # @return [Float] attr_accessor :top_offset @@ -897,17 +846,14 @@ module Google end end - # Deletes an object, either pages or - # page elements, from the - # presentation. + # Deletes an object, either pages or page elements, from the presentation. class DeleteObjectRequest include Google::Apis::Core::Hashable - # The object ID of the page or page element to delete. - # If after a delete operation a group contains - # only 1 or no page elements, the group is also deleted. - # If a placeholder is deleted on a layout, any empty inheriting shapes are - # also deleted. + # The object ID of the page or page element to delete. If after a delete + # operation a group contains only 1 or no page elements, the group is also + # deleted. If a placeholder is deleted on a layout, any empty inheriting shapes + # are also deleted. # Corresponds to the JSON property `objectId` # @return [String] attr_accessor :object_id_prop @@ -923,9 +869,8 @@ module Google end # Deletes bullets from all of the paragraphs that overlap with the given text - # index range. - # The nesting level of each paragraph will be visually preserved by adding - # indent to the start of the corresponding paragraph. + # index range. The nesting level of each paragraph will be visually preserved by + # adding indent to the start of the corresponding paragraph. class DeleteParagraphBulletsRequest include Google::Apis::Core::Hashable @@ -934,8 +879,7 @@ module Google # @return [Google::Apis::SlidesV1::TableCellLocation] attr_accessor :cell_location - # The object ID of the shape or table containing the text to delete bullets - # from. + # The object ID of the shape or table containing the text to delete bullets from. # Corresponds to the JSON property `objectId` # @return [String] attr_accessor :object_id_prop @@ -1065,10 +1009,10 @@ module Google end end - # Duplicates a slide or page element. - # When duplicating a slide, the duplicate slide will be created immediately - # following the specified slide. When duplicating a page element, the duplicate - # will be placed on the same page at the same position as the original. + # Duplicates a slide or page element. When duplicating a slide, the duplicate + # slide will be created immediately following the specified slide. When + # duplicating a page element, the duplicate will be placed on the same page at + # the same position as the original. class DuplicateObjectRequest include Google::Apis::Core::Hashable @@ -1078,21 +1022,19 @@ module Google attr_accessor :object_id_prop # The object being duplicated may contain other objects, for example when - # duplicating a slide or a group page element. This map defines how the IDs - # of duplicated objects are generated: the keys are the IDs of the original - # objects and its values are the IDs that will be assigned to the - # corresponding duplicate object. The ID of the source object's duplicate - # may be specified in this map as well, using the same value of the - # `object_id` field as a key and the newly desired ID as the value. - # All keys must correspond to existing IDs in the presentation. All values - # must be unique in the presentation and must start with an alphanumeric - # character or an underscore (matches regex `[a-zA-Z0-9_]`); remaining - # characters may include those as well as a hyphen or colon (matches regex - # `[a-zA-Z0-9_-:]`). The length of the new ID must not be less than 5 or - # greater than 50. - # If any IDs of source objects are omitted from the map, a new random ID will - # be assigned. If the map is empty or unset, all duplicate objects will - # receive a new random ID. + # duplicating a slide or a group page element. This map defines how the IDs of + # duplicated objects are generated: the keys are the IDs of the original objects + # and its values are the IDs that will be assigned to the corresponding + # duplicate object. The ID of the source object's duplicate may be specified in + # this map as well, using the same value of the `object_id` field as a key and + # the newly desired ID as the value. All keys must correspond to existing IDs in + # the presentation. All values must be unique in the presentation and must start + # with an alphanumeric character or an underscore (matches regex `[a-zA-Z0-9_]`); + # remaining characters may include those as well as a hyphen or colon (matches + # regex `[a-zA-Z0-9_-:]`). The length of the new ID must not be less than 5 or + # greater than 50. If any IDs of source objects are omitted from the map, a new + # random ID will be assigned. If the map is empty or unset, all duplicate + # objects will receive a new random ID. # Corresponds to the JSON property `objectIds` # @return [Hash] attr_accessor :object_ids @@ -1127,8 +1069,7 @@ module Google end end - # A PageElement kind representing a - # joined collection of PageElements. + # A PageElement kind representing a joined collection of PageElements. class Group include Google::Apis::Core::Hashable @@ -1152,22 +1093,21 @@ module Google class GroupObjectsRequest include Google::Apis::Core::Hashable - # The object IDs of the objects to group. - # Only page elements can be grouped. There should be at least two page - # elements on the same page that are not already in another group. Some page - # elements, such as videos, tables and placeholder shapes cannot be grouped. + # The object IDs of the objects to group. Only page elements can be grouped. + # There should be at least two page elements on the same page that are not + # already in another group. Some page elements, such as videos, tables and + # placeholder shapes cannot be grouped. # Corresponds to the JSON property `childrenObjectIds` # @return [Array] attr_accessor :children_object_ids - # A user-supplied object ID for the group to be created. - # If you specify an ID, it must be unique among all pages and page elements - # in the presentation. The ID must start with an alphanumeric character or an - # underscore (matches regex `[a-zA-Z0-9_]`); remaining characters - # may include those as well as a hyphen or colon (matches regex - # `[a-zA-Z0-9_-:]`). - # The length of the ID must not be less than 5 or greater than 50. - # If you don't specify an ID, a unique one is generated. + # A user-supplied object ID for the group to be created. If you specify an ID, + # it must be unique among all pages and page elements in the presentation. The + # ID must start with an alphanumeric character or an underscore (matches regex `[ + # a-zA-Z0-9_]`); remaining characters may include those as well as a hyphen or + # colon (matches regex `[a-zA-Z0-9_-:]`). The length of the ID must not be less + # than 5 or greater than 50. If you don't specify an ID, a unique one is + # generated. # Corresponds to the JSON property `groupObjectId` # @return [String] attr_accessor :group_object_id @@ -1202,15 +1142,14 @@ module Google end end - # A PageElement kind representing an - # image. + # A PageElement kind representing an image. class Image include Google::Apis::Core::Hashable - # An URL to an image with a default lifetime of 30 minutes. - # This URL is tagged with the account of the requester. Anyone with the URL - # effectively accesses the image as the original requester. Access to the - # image may be lost if the presentation's sharing settings change. + # An URL to an image with a default lifetime of 30 minutes. This URL is tagged + # with the account of the requester. Anyone with the URL effectively accesses + # the image as the original requester. Access to the image may be lost if the + # presentation's sharing settings change. # Corresponds to the JSON property `contentUrl` # @return [String] attr_accessor :content_url @@ -1242,35 +1181,32 @@ module Google class ImageProperties include Google::Apis::Core::Hashable - # The brightness effect of the image. The value should be in the interval - # [-1.0, 1.0], where 0 means no effect. This property is read-only. + # The brightness effect of the image. The value should be in the interval [-1.0, + # 1.0], where 0 means no effect. This property is read-only. # Corresponds to the JSON property `brightness` # @return [Float] attr_accessor :brightness - # The contrast effect of the image. The value should be in the interval - # [-1.0, 1.0], where 0 means no effect. This property is read-only. + # The contrast effect of the image. The value should be in the interval [-1.0, 1. + # 0], where 0 means no effect. This property is read-only. # Corresponds to the JSON property `contrast` # @return [Float] attr_accessor :contrast # The crop properties of an object enclosed in a container. For example, an - # Image. - # The crop properties is represented by the offsets of four edges which define - # a crop rectangle. The offsets are measured in percentage from the - # corresponding edges of the object's original bounding rectangle towards - # inside, relative to the object's original dimensions. - # - If the offset is in the interval (0, 1), the corresponding edge of crop - # rectangle is positioned inside of the object's original bounding rectangle. - # - If the offset is negative or greater than 1, the corresponding edge of crop - # rectangle is positioned outside of the object's original bounding rectangle. - # - If the left edge of the crop rectangle is on the right side of its right - # edge, the object will be flipped horizontally. - # - If the top edge of the crop rectangle is below its bottom edge, the object - # will be flipped vertically. - # - If all offsets and rotation angle is 0, the object is not cropped. - # After cropping, the content in the crop rectangle will be stretched to fit - # its container. + # Image. The crop properties is represented by the offsets of four edges which + # define a crop rectangle. The offsets are measured in percentage from the + # corresponding edges of the object's original bounding rectangle towards inside, + # relative to the object's original dimensions. - If the offset is in the + # interval (0, 1), the corresponding edge of crop rectangle is positioned inside + # of the object's original bounding rectangle. - If the offset is negative or + # greater than 1, the corresponding edge of crop rectangle is positioned outside + # of the object's original bounding rectangle. - If the left edge of the crop + # rectangle is on the right side of its right edge, the object will be flipped + # horizontally. - If the top edge of the crop rectangle is below its bottom edge, + # the object will be flipped vertically. - If all offsets and rotation angle is + # 0, the object is not cropped. After cropping, the content in the crop + # rectangle will be stretched to fit its container. # Corresponds to the JSON property `cropProperties` # @return [Google::Apis::SlidesV1::CropProperties] attr_accessor :crop_properties @@ -1280,11 +1216,10 @@ module Google # @return [Google::Apis::SlidesV1::Link] attr_accessor :link - # The outline of a PageElement. - # If these fields are unset, they may be inherited from a parent placeholder - # if it exists. If there is no parent, the fields will default to the value - # used for new page elements created in the Slides editor, which may depend on - # the page element kind. + # The outline of a PageElement. If these fields are unset, they may be inherited + # from a parent placeholder if it exists. If there is no parent, the fields will + # default to the value used for new page elements created in the Slides editor, + # which may depend on the page element kind. # Corresponds to the JSON property `outline` # @return [Google::Apis::SlidesV1::Outline] attr_accessor :outline @@ -1294,18 +1229,17 @@ module Google # @return [Google::Apis::SlidesV1::Recolor] attr_accessor :recolor - # The shadow properties of a page element. - # If these fields are unset, they may be inherited from a parent placeholder - # if it exists. If there is no parent, the fields will default to the value - # used for new page elements created in the Slides editor, which may depend on - # the page element kind. + # The shadow properties of a page element. If these fields are unset, they may + # be inherited from a parent placeholder if it exists. If there is no parent, + # the fields will default to the value used for new page elements created in the + # Slides editor, which may depend on the page element kind. # Corresponds to the JSON property `shadow` # @return [Google::Apis::SlidesV1::Shadow] attr_accessor :shadow - # The transparency effect of the image. The value should be in the interval - # [0.0, 1.0], where 0 means no effect and 1 means completely transparent. - # This property is read-only. + # The transparency effect of the image. The value should be in the interval [0.0, + # 1.0], where 0 means no effect and 1 means completely transparent. This + # property is read-only. # Corresponds to the JSON property `transparency` # @return [Float] attr_accessor :transparency @@ -1327,8 +1261,8 @@ module Google end end - # Inserts columns into a table. - # Other columns in the table will be resized to fit the new column. + # Inserts columns into a table. Other columns in the table will be resized to + # fit the new column. class InsertTableColumnsRequest include Google::Apis::Core::Hashable @@ -1337,9 +1271,8 @@ module Google # @return [Google::Apis::SlidesV1::TableCellLocation] attr_accessor :cell_location - # Whether to insert new columns to the right of the reference cell location. - # - `True`: insert to the right. - # - `False`: insert to the left. + # Whether to insert new columns to the right of the reference cell location. - ` + # True`: insert to the right. - `False`: insert to the left. # Corresponds to the JSON property `insertRight` # @return [Boolean] attr_accessor :insert_right @@ -1377,9 +1310,8 @@ module Google # @return [Google::Apis::SlidesV1::TableCellLocation] attr_accessor :cell_location - # Whether to insert new rows below the reference cell location. - # - `True`: insert below the cell. - # - `False`: insert above the cell. + # Whether to insert new rows below the reference cell location. - `True`: insert + # below the cell. - `False`: insert above the cell. # Corresponds to the JSON property `insertBelow` # @return [Boolean] attr_accessor :insert_below @@ -1417,12 +1349,11 @@ module Google # @return [Google::Apis::SlidesV1::TableCellLocation] attr_accessor :cell_location - # The index where the text will be inserted, in Unicode code units, based - # on TextElement indexes. - # The index is zero-based and is computed from the start of the string. - # The index may be adjusted to prevent insertions inside Unicode grapheme - # clusters. In these cases, the text will be inserted immediately after the - # grapheme cluster. + # The index where the text will be inserted, in Unicode code units, based on + # TextElement indexes. The index is zero-based and is computed from the start of + # the string. The index may be adjusted to prevent insertions inside Unicode + # grapheme clusters. In these cases, the text will be inserted immediately after + # the grapheme cluster. # Corresponds to the JSON property `insertionIndex` # @return [Fixnum] attr_accessor :insertion_index @@ -1432,16 +1363,13 @@ module Google # @return [String] attr_accessor :object_id_prop - # The text to be inserted. - # Inserting a newline character will implicitly create a new - # ParagraphMarker at that index. - # The paragraph style of the new paragraph will be copied from the paragraph - # at the current insertion index, including lists and bullets. - # Text styles for inserted text will be determined automatically, generally - # preserving the styling of neighboring text. In most cases, the text will be - # added to the TextRun that exists at the - # insertion index. - # Some control characters (U+0000-U+0008, U+000C-U+001F) and characters + # The text to be inserted. Inserting a newline character will implicitly create + # a new ParagraphMarker at that index. The paragraph style of the new paragraph + # will be copied from the paragraph at the current insertion index, including + # lists and bullets. Text styles for inserted text will be determined + # automatically, generally preserving the styling of neighboring text. In most + # cases, the text will be added to the TextRun that exists at the insertion + # index. Some control characters (U+0000-U+0008, U+000C-U+001F) and characters # from the Unicode Basic Multilingual Plane Private Use Area (U+E000-U+F8FF) # will be stripped out of the inserted text. # Corresponds to the JSON property `text` @@ -1471,20 +1399,17 @@ module Google # @return [Google::Apis::SlidesV1::Placeholder] attr_accessor :layout_placeholder - # The object ID of the placeholder on a layout that will be applied - # to a slide. + # The object ID of the placeholder on a layout that will be applied to a slide. # Corresponds to the JSON property `layoutPlaceholderObjectId` # @return [String] attr_accessor :layout_placeholder_object_id # A user-supplied object ID for the placeholder identified above that to be - # created onto a slide. - # If you specify an ID, it must be unique among all pages and page elements - # in the presentation. The ID must start with an alphanumeric character or an - # underscore (matches regex `[a-zA-Z0-9_]`); remaining characters - # may include those as well as a hyphen or colon (matches regex - # `[a-zA-Z0-9_-:]`). - # The length of the ID must not be less than 5 or greater than 50. + # created onto a slide. If you specify an ID, it must be unique among all pages + # and page elements in the presentation. The ID must start with an alphanumeric + # character or an underscore (matches regex `[a-zA-Z0-9_]`); remaining + # characters may include those as well as a hyphen or colon (matches regex `[a- + # zA-Z0-9_-:]`). The length of the ID must not be less than 5 or greater than 50. # If you don't specify an ID, a unique one is generated. # Corresponds to the JSON property `objectId` # @return [String] @@ -1502,8 +1427,7 @@ module Google end end - # The properties of Page are only - # relevant for pages with page_type LAYOUT. + # The properties of Page are only relevant for pages with page_type LAYOUT. class LayoutProperties include Google::Apis::Core::Hashable @@ -1534,9 +1458,8 @@ module Google end end - # Slide layout reference. This may reference either: - # - A predefined layout - # - One of the layouts in the presentation. + # Slide layout reference. This may reference either: - A predefined layout - One + # of the layouts in the presentation. class LayoutReference include Google::Apis::Core::Hashable @@ -1561,22 +1484,19 @@ module Google end end - # A PageElement kind representing a - # non-connector line, straight connector, curved connector, or bent connector. + # A PageElement kind representing a non-connector line, straight connector, + # curved connector, or bent connector. class Line include Google::Apis::Core::Hashable - # The category of the line. - # It matches the `category` specified in CreateLineRequest, and can be updated - # with - # UpdateLineCategoryRequest. + # The category of the line. It matches the `category` specified in + # CreateLineRequest, and can be updated with UpdateLineCategoryRequest. # Corresponds to the JSON property `lineCategory` # @return [String] attr_accessor :line_category - # The properties of the Line. - # When unset, these fields default to values that match the appearance of - # new lines created in the Slides editor. + # The properties of the Line. When unset, these fields default to values that + # match the appearance of new lines created in the Slides editor. # Corresponds to the JSON property `lineProperties` # @return [Google::Apis::SlidesV1::LineProperties] attr_accessor :line_properties @@ -1598,28 +1518,26 @@ module Google end end - # The properties for one end of a Line - # connection. + # The properties for one end of a Line connection. class LineConnection include Google::Apis::Core::Hashable - # The object ID of the connected page element. - # Some page elements, such as groups, tables, and lines - # do not have connection sites and therefore cannot be connected to a - # connector line. + # The object ID of the connected page element. Some page elements, such as + # groups, tables, and lines do not have connection sites and therefore cannot be + # connected to a connector line. # Corresponds to the JSON property `connectedObjectId` # @return [String] attr_accessor :connected_object_id - # The index of the connection site on the connected page element. - # In most cases, it corresponds to the predefined connection site index from - # the ECMA-376 standard. More information on those connection sites can be - # found in the description of the "cnx" attribute in section 20.1.9.9 and - # Annex H. "Predefined DrawingML Shape and Text Geometries" of "Office Open - # XML File Formats-Fundamentals and Markup Language Reference", part 1 of - # [ECMA-376 5th edition] - # (http://www.ecma-international.org/publications/standards/Ecma-376.htm). - # The position of each connection site can also be viewed from Slides editor. + # The index of the connection site on the connected page element. In most cases, + # it corresponds to the predefined connection site index from the ECMA-376 + # standard. More information on those connection sites can be found in the + # description of the "cnx" attribute in section 20.1.9.9 and Annex H. " + # Predefined DrawingML Shape and Text Geometries" of "Office Open XML File + # Formats-Fundamentals and Markup Language Reference", part 1 of [ECMA-376 5th + # edition] (http://www.ecma-international.org/publications/standards/Ecma-376. + # htm). The position of each connection site can also be viewed from Slides + # editor. # Corresponds to the JSON property `connectionSiteIndex` # @return [Fixnum] attr_accessor :connection_site_index @@ -1640,9 +1558,8 @@ module Google include Google::Apis::Core::Hashable # A solid color fill. The page or page element is filled entirely with the - # specified color value. - # If any field is unset, its value may be inherited from a parent placeholder - # if it exists. + # specified color value. If any field is unset, its value may be inherited from + # a parent placeholder if it exists. # Corresponds to the JSON property `solidFill` # @return [Google::Apis::SlidesV1::SolidFill] attr_accessor :solid_fill @@ -1657,9 +1574,8 @@ module Google end end - # The properties of the Line. - # When unset, these fields default to values that match the appearance of - # new lines created in the Slides editor. + # The properties of the Line. When unset, these fields default to values that + # match the appearance of new lines created in the Slides editor. class LineProperties include Google::Apis::Core::Hashable @@ -1673,8 +1589,7 @@ module Google # @return [String] attr_accessor :end_arrow - # The properties for one end of a Line - # connection. + # The properties for one end of a Line connection. # Corresponds to the JSON property `endConnection` # @return [Google::Apis::SlidesV1::LineConnection] attr_accessor :end_connection @@ -1694,8 +1609,7 @@ module Google # @return [String] attr_accessor :start_arrow - # The properties for one end of a Line - # connection. + # The properties for one end of a Line connection. # Corresponds to the JSON property `startConnection` # @return [Google::Apis::SlidesV1::LineConnection] attr_accessor :start_connection @@ -1726,20 +1640,20 @@ module Google class Link include Google::Apis::Core::Hashable - # If set, indicates this is a link to the specific page in this - # presentation with this ID. A page with this ID may not exist. + # If set, indicates this is a link to the specific page in this presentation + # with this ID. A page with this ID may not exist. # Corresponds to the JSON property `pageObjectId` # @return [String] attr_accessor :page_object_id - # If set, indicates this is a link to a slide in this presentation, - # addressed by its position. + # If set, indicates this is a link to a slide in this presentation, addressed by + # its position. # Corresponds to the JSON property `relativeLink` # @return [String] attr_accessor :relative_link - # If set, indicates this is a link to the slide at this zero-based index - # in the presentation. There may not be a slide at this index. + # If set, indicates this is a link to the slide at this zero-based index in the + # presentation. There may not be a slide at this index. # Corresponds to the JSON property `slideIndex` # @return [Fixnum] attr_accessor :slide_index @@ -1773,9 +1687,9 @@ module Google # @return [String] attr_accessor :list_id - # A map of nesting levels to the properties of bullets at the associated - # level. A list has at most nine levels of nesting, so the possible values - # for the keys of this map are 0 through 8, inclusive. + # A map of nesting levels to the properties of bullets at the associated level. + # A list has at most nine levels of nesting, so the possible values for the keys + # of this map are 0 through 8, inclusive. # Corresponds to the JSON property `nestingLevel` # @return [Hash] attr_accessor :nesting_level @@ -1791,8 +1705,7 @@ module Google end end - # The properties of Page that are only - # relevant for pages with page_type MASTER. + # The properties of Page that are only relevant for pages with page_type MASTER. class MasterProperties include Google::Apis::Core::Hashable @@ -1820,17 +1733,12 @@ module Google # @return [String] attr_accessor :object_id_prop - # A table range represents a reference to a subset of a table. - # It's important to note that the cells specified by a table range do not - # necessarily form a rectangle. For example, let's say we have a 3 x 3 table - # where all the cells of the last row are merged together. The table looks - # like this: - # - # [ ] - # A table range with location = (0, 0), row span = 3 and column span = 2 - # specifies the following cells: - # x x - # [ x x x ] + # A table range represents a reference to a subset of a table. It's important to + # note that the cells specified by a table range do not necessarily form a + # rectangle. For example, let's say we have a 3 x 3 table where all the cells of + # the last row are merged together. The table looks like this: [ ] A table range + # with location = (0, 0), row span = 3 and column span = 2 specifies the + # following cells: x x [ x x x ] # Corresponds to the JSON property `tableRange` # @return [Google::Apis::SlidesV1::TableRange] attr_accessor :table_range @@ -1851,21 +1759,18 @@ module Google class NestingLevel include Google::Apis::Core::Hashable - # Represents the styling that can be applied to a TextRun. - # If this text is contained in a shape with a parent placeholder, then these - # text styles may be + # Represents the styling that can be applied to a TextRun. If this text is + # contained in a shape with a parent placeholder, then these text styles may be # inherited from the parent. Which text styles are inherited depend on the - # nesting level of lists: - # * A text run in a paragraph that is not in a list will inherit its text style - # from the the newline character in the paragraph at the 0 nesting level of - # the list inside the parent placeholder. - # * A text run in a paragraph that is in a list will inherit its text style - # from the newline character in the paragraph at its corresponding nesting - # level of the list inside the parent placeholder. - # Inherited text styles are represented as unset fields in this message. If - # text is contained in a shape without a parent placeholder, unsetting these - # fields will revert the style to a value matching the defaults in the Slides - # editor. + # nesting level of lists: * A text run in a paragraph that is not in a list will + # inherit its text style from the the newline character in the paragraph at the + # 0 nesting level of the list inside the parent placeholder. * A text run in a + # paragraph that is in a list will inherit its text style from the newline + # character in the paragraph at its corresponding nesting level of the list + # inside the parent placeholder. Inherited text styles are represented as unset + # fields in this message. If text is contained in a shape without a parent + # placeholder, unsetting these fields will revert the style to a value matching + # the defaults in the Slides editor. # Corresponds to the JSON property `bulletStyle` # @return [Google::Apis::SlidesV1::TextStyle] attr_accessor :bullet_style @@ -1880,17 +1785,15 @@ module Google end end - # The properties of Page that are only - # relevant for pages with page_type NOTES. + # The properties of Page that are only relevant for pages with page_type NOTES. class NotesProperties include Google::Apis::Core::Hashable - # The object ID of the shape on this notes page that contains the speaker - # notes for the corresponding slide. - # The actual shape may not always exist on the notes page. Inserting text - # using this object ID will automatically create the shape. In this case, the - # actual shape may have different object ID. The `GetPresentation` or - # `GetPage` action will always return the latest object ID. + # The object ID of the shape on this notes page that contains the speaker notes + # for the corresponding slide. The actual shape may not always exist on the + # notes page. Inserting text using this object ID will automatically create the + # shape. In this case, the actual shape may have different object ID. The ` + # GetPresentation` or `GetPage` action will always return the latest object ID. # Corresponds to the JSON property `speakerNotesObjectId` # @return [String] attr_accessor :speaker_notes_object_id @@ -1949,11 +1852,10 @@ module Google end end - # The outline of a PageElement. - # If these fields are unset, they may be inherited from a parent placeholder - # if it exists. If there is no parent, the fields will default to the value - # used for new page elements created in the Slides editor, which may depend on - # the page element kind. + # The outline of a PageElement. If these fields are unset, they may be inherited + # from a parent placeholder if it exists. If there is no parent, the fields will + # default to the value used for new page elements created in the Slides editor, + # which may depend on the page element kind. class Outline include Google::Apis::Core::Hashable @@ -1967,12 +1869,11 @@ module Google # @return [Google::Apis::SlidesV1::OutlineFill] attr_accessor :outline_fill - # The outline property state. - # Updating the outline on a page element will implicitly update this field - # to `RENDERED`, unless another value is specified in the same request. To - # have no outline on a page element, set this field to `NOT_RENDERED`. In - # this case, any other outline fields set in the same request will be - # ignored. + # The outline property state. Updating the outline on a page element will + # implicitly update this field to `RENDERED`, unless another value is specified + # in the same request. To have no outline on a page element, set this field to ` + # NOT_RENDERED`. In this case, any other outline fields set in the same request + # will be ignored. # Corresponds to the JSON property `propertyState` # @return [String] attr_accessor :property_state @@ -2000,9 +1901,8 @@ module Google include Google::Apis::Core::Hashable # A solid color fill. The page or page element is filled entirely with the - # specified color value. - # If any field is unset, its value may be inherited from a parent placeholder - # if it exists. + # specified color value. If any field is unset, its value may be inherited from + # a parent placeholder if it exists. # Corresponds to the JSON property `solidFill` # @return [Google::Apis::SlidesV1::SolidFill] attr_accessor :solid_fill @@ -2021,27 +1921,23 @@ module Google class Page include Google::Apis::Core::Hashable - # The properties of Page are only - # relevant for pages with page_type LAYOUT. + # The properties of Page are only relevant for pages with page_type LAYOUT. # Corresponds to the JSON property `layoutProperties` # @return [Google::Apis::SlidesV1::LayoutProperties] attr_accessor :layout_properties - # The properties of Page that are only - # relevant for pages with page_type MASTER. + # The properties of Page that are only relevant for pages with page_type MASTER. # Corresponds to the JSON property `masterProperties` # @return [Google::Apis::SlidesV1::MasterProperties] attr_accessor :master_properties - # The properties of Page that are only - # relevant for pages with page_type NOTES. + # The properties of Page that are only relevant for pages with page_type NOTES. # Corresponds to the JSON property `notesProperties` # @return [Google::Apis::SlidesV1::NotesProperties] attr_accessor :notes_properties - # The object ID for this page. Object IDs used by - # Page and - # PageElement share the same namespace. + # The object ID for this page. Object IDs used by Page and PageElement share the + # same namespace. # Corresponds to the JSON property `objectId` # @return [String] attr_accessor :object_id_prop @@ -2051,11 +1947,9 @@ module Google # @return [Array] attr_accessor :page_elements - # The properties of the Page. - # The page will inherit properties from the parent page. Depending on the page - # type the hierarchy is defined in either - # SlideProperties or - # LayoutProperties. + # The properties of the Page. The page will inherit properties from the parent + # page. Depending on the page type the hierarchy is defined in either + # SlideProperties or LayoutProperties. # Corresponds to the JSON property `pageProperties` # @return [Google::Apis::SlidesV1::PageProperties] attr_accessor :page_properties @@ -2066,22 +1960,20 @@ module Google attr_accessor :page_type # The revision ID of the presentation containing this page. Can be used in - # update requests to assert that the presentation revision hasn't changed - # since the last read operation. Only populated if the user has edit access - # to the presentation. - # The format of the revision ID may change over time, so it should be treated - # opaquely. A returned revision ID is only guaranteed to be valid for 24 - # hours after it has been returned and cannot be shared across users. If the - # revision ID is unchanged between calls, then the presentation has not - # changed. Conversely, a changed ID (for the same presentation and user) - # usually means the presentation has been updated; however, a changed ID can - # also be due to internal factors such as ID format changes. + # update requests to assert that the presentation revision hasn't changed since + # the last read operation. Only populated if the user has edit access to the + # presentation. The format of the revision ID may change over time, so it should + # be treated opaquely. A returned revision ID is only guaranteed to be valid for + # 24 hours after it has been returned and cannot be shared across users. If the + # revision ID is unchanged between calls, then the presentation has not changed. + # Conversely, a changed ID (for the same presentation and user) usually means + # the presentation has been updated; however, a changed ID can also be due to + # internal factors such as ID format changes. # Corresponds to the JSON property `revisionId` # @return [String] attr_accessor :revision_id - # The properties of Page that are only - # relevant for pages with page_type SLIDE. + # The properties of Page that are only relevant for pages with page_type SLIDE. # Corresponds to the JSON property `slideProperties` # @return [Google::Apis::SlidesV1::SlideProperties] attr_accessor :slide_properties @@ -2108,19 +2000,18 @@ module Google class PageBackgroundFill include Google::Apis::Core::Hashable - # The background fill property state. - # Updating the fill on a page will implicitly update this field to - # `RENDERED`, unless another value is specified in the same request. To - # have no fill on a page, set this field to `NOT_RENDERED`. In this case, - # any other fill fields set in the same request will be ignored. + # The background fill property state. Updating the fill on a page will + # implicitly update this field to `RENDERED`, unless another value is specified + # in the same request. To have no fill on a page, set this field to ` + # NOT_RENDERED`. In this case, any other fill fields set in the same request + # will be ignored. # Corresponds to the JSON property `propertyState` # @return [String] attr_accessor :property_state # A solid color fill. The page or page element is filled entirely with the - # specified color value. - # If any field is unset, its value may be inherited from a parent placeholder - # if it exists. + # specified color value. If any field is unset, its value may be inherited from + # a parent placeholder if it exists. # Corresponds to the JSON property `solidFill` # @return [Google::Apis::SlidesV1::SolidFill] attr_accessor :solid_fill @@ -2147,47 +2038,41 @@ module Google class PageElement include Google::Apis::Core::Hashable - # The description of the page element. Combined with title to display alt - # text. - # The field is not supported for Group - # elements. + # The description of the page element. Combined with title to display alt text. + # The field is not supported for Group elements. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description - # A PageElement kind representing a - # joined collection of PageElements. + # A PageElement kind representing a joined collection of PageElements. # Corresponds to the JSON property `elementGroup` # @return [Google::Apis::SlidesV1::Group] attr_accessor :element_group - # A PageElement kind representing an - # image. + # A PageElement kind representing an image. # Corresponds to the JSON property `image` # @return [Google::Apis::SlidesV1::Image] attr_accessor :image - # A PageElement kind representing a - # non-connector line, straight connector, curved connector, or bent connector. + # A PageElement kind representing a non-connector line, straight connector, + # curved connector, or bent connector. # Corresponds to the JSON property `line` # @return [Google::Apis::SlidesV1::Line] attr_accessor :line - # The object ID for this page element. Object IDs used by - # google.apps.slides.v1.Page and - # google.apps.slides.v1.PageElement share the same namespace. + # The object ID for this page element. Object IDs used by google.apps.slides.v1. + # Page and google.apps.slides.v1.PageElement share the same namespace. # Corresponds to the JSON property `objectId` # @return [String] attr_accessor :object_id_prop - # A PageElement kind representing a - # generic shape that does not have a more specific classification. + # A PageElement kind representing a generic shape that does not have a more + # specific classification. # Corresponds to the JSON property `shape` # @return [Google::Apis::SlidesV1::Shape] attr_accessor :shape - # A PageElement kind representing - # a linked chart embedded from Google Sheets. + # A PageElement kind representing a linked chart embedded from Google Sheets. # Corresponds to the JSON property `sheetsChart` # @return [Google::Apis::SlidesV1::SheetsChart] attr_accessor :sheets_chart @@ -2197,41 +2082,32 @@ module Google # @return [Google::Apis::SlidesV1::Size] attr_accessor :size - # A PageElement kind representing a - # table. + # A PageElement kind representing a table. # Corresponds to the JSON property `table` # @return [Google::Apis::SlidesV1::Table] attr_accessor :table - # The title of the page element. Combined with description to display alt - # text. - # The field is not supported for Group - # elements. + # The title of the page element. Combined with description to display alt text. + # The field is not supported for Group elements. # Corresponds to the JSON property `title` # @return [String] attr_accessor :title - # AffineTransform uses a 3x3 matrix with an implied last row of [ 0 0 1 ] - # to transform source coordinates (x,y) into destination coordinates (x', y') - # according to: - # x' x = shear_y scale_y translate_y - # 1 [ 1 ] - # After transformation, - # x' = scale_x * x + shear_x * y + translate_x; - # y' = scale_y * y + shear_y * x + translate_y; - # This message is therefore composed of these six matrix elements. + # AffineTransform uses a 3x3 matrix with an implied last row of [ 0 0 1 ] to + # transform source coordinates (x,y) into destination coordinates (x', y') + # according to: x' x = shear_y scale_y translate_y 1 [ 1 ] After transformation, + # x' = scale_x * x + shear_x * y + translate_x; y' = scale_y * y + shear_y * x + + # translate_y; This message is therefore composed of these six matrix elements. # Corresponds to the JSON property `transform` # @return [Google::Apis::SlidesV1::AffineTransform] attr_accessor :transform - # A PageElement kind representing a - # video. + # A PageElement kind representing a video. # Corresponds to the JSON property `video` # @return [Google::Apis::SlidesV1::Video] attr_accessor :video - # A PageElement kind representing - # word art. + # A PageElement kind representing word art. # Corresponds to the JSON property `wordArt` # @return [Google::Apis::SlidesV1::WordArt] attr_accessor :word_art @@ -2258,11 +2134,9 @@ module Google end end - # Common properties for a page element. - # Note: When you initially create a - # PageElement, the API may modify - # the values of both `size` and `transform`, but the - # visual size will be unchanged. + # Common properties for a page element. Note: When you initially create a + # PageElement, the API may modify the values of both `size` and `transform`, but + # the visual size will be unchanged. class PageElementProperties include Google::Apis::Core::Hashable @@ -2276,15 +2150,11 @@ module Google # @return [Google::Apis::SlidesV1::Size] attr_accessor :size - # AffineTransform uses a 3x3 matrix with an implied last row of [ 0 0 1 ] - # to transform source coordinates (x,y) into destination coordinates (x', y') - # according to: - # x' x = shear_y scale_y translate_y - # 1 [ 1 ] - # After transformation, - # x' = scale_x * x + shear_x * y + translate_x; - # y' = scale_y * y + shear_y * x + translate_y; - # This message is therefore composed of these six matrix elements. + # AffineTransform uses a 3x3 matrix with an implied last row of [ 0 0 1 ] to + # transform source coordinates (x,y) into destination coordinates (x', y') + # according to: x' x = shear_y scale_y translate_y 1 [ 1 ] After transformation, + # x' = scale_x * x + shear_x * y + translate_x; y' = scale_y * y + shear_y * x + + # translate_y; This message is therefore composed of these six matrix elements. # Corresponds to the JSON property `transform` # @return [Google::Apis::SlidesV1::AffineTransform] attr_accessor :transform @@ -2301,11 +2171,9 @@ module Google end end - # The properties of the Page. - # The page will inherit properties from the parent page. Depending on the page - # type the hierarchy is defined in either - # SlideProperties or - # LayoutProperties. + # The properties of the Page. The page will inherit properties from the parent + # page. Depending on the page type the hierarchy is defined in either + # SlideProperties or LayoutProperties. class PageProperties include Google::Apis::Core::Hashable @@ -2339,16 +2207,13 @@ module Google # @return [Google::Apis::SlidesV1::Bullet] attr_accessor :bullet - # Styles that apply to a whole paragraph. - # If this text is contained in a shape with a parent placeholder, then these - # paragraph styles may be - # inherited from the parent. Which paragraph styles are inherited depend on the - # nesting level of lists: - # * A paragraph not in a list will inherit its paragraph style from the - # paragraph at the 0 nesting level of the list inside the parent placeholder. + # Styles that apply to a whole paragraph. If this text is contained in a shape + # with a parent placeholder, then these paragraph styles may be inherited from + # the parent. Which paragraph styles are inherited depend on the nesting level + # of lists: * A paragraph not in a list will inherit its paragraph style from + # the paragraph at the 0 nesting level of the list inside the parent placeholder. # * A paragraph in a list will inherit its paragraph style from the paragraph - # at its corresponding nesting level of the list inside the parent - # placeholder. + # at its corresponding nesting level of the list inside the parent placeholder. # Inherited paragraph styles are represented as unset fields in this message. # Corresponds to the JSON property `style` # @return [Google::Apis::SlidesV1::ParagraphStyle] @@ -2365,16 +2230,13 @@ module Google end end - # Styles that apply to a whole paragraph. - # If this text is contained in a shape with a parent placeholder, then these - # paragraph styles may be - # inherited from the parent. Which paragraph styles are inherited depend on the - # nesting level of lists: - # * A paragraph not in a list will inherit its paragraph style from the - # paragraph at the 0 nesting level of the list inside the parent placeholder. + # Styles that apply to a whole paragraph. If this text is contained in a shape + # with a parent placeholder, then these paragraph styles may be inherited from + # the parent. Which paragraph styles are inherited depend on the nesting level + # of lists: * A paragraph not in a list will inherit its paragraph style from + # the paragraph at the 0 nesting level of the list inside the parent placeholder. # * A paragraph in a list will inherit its paragraph style from the paragraph - # at its corresponding nesting level of the list inside the parent - # placeholder. + # at its corresponding nesting level of the list inside the parent placeholder. # Inherited paragraph styles are represented as unset fields in this message. class ParagraphStyle include Google::Apis::Core::Hashable @@ -2385,8 +2247,7 @@ module Google attr_accessor :alignment # The text direction of this paragraph. If unset, the value defaults to - # LEFT_TO_RIGHT since - # text direction is not inherited. + # LEFT_TO_RIGHT since text direction is not inherited. # Corresponds to the JSON property `direction` # @return [String] attr_accessor :direction @@ -2406,8 +2267,8 @@ module Google # @return [Google::Apis::SlidesV1::Dimension] attr_accessor :indent_start - # The amount of space between lines, as a percentage of normal, where normal - # is represented as 100.0. If unset, the value is inherited from the parent. + # The amount of space between lines, as a percentage of normal, where normal is + # represented as 100.0. If unset, the value is inherited from the parent. # Corresponds to the JSON property `lineSpacing` # @return [Float] attr_accessor :line_spacing @@ -2449,15 +2310,15 @@ module Google class Placeholder include Google::Apis::Core::Hashable - # The index of the placeholder. If the same placeholder types are present in - # the same page, they would have different index values. + # The index of the placeholder. If the same placeholder types are present in the + # same page, they would have different index values. # Corresponds to the JSON property `index` # @return [Fixnum] attr_accessor :index - # The object ID of this shape's parent placeholder. - # If unset, the parent placeholder shape does not exist, so the shape does - # not inherit properties from any other shape. + # The object ID of this shape's parent placeholder. If unset, the parent + # placeholder shape does not exist, so the shape does not inherit properties + # from any other shape. # Corresponds to the JSON property `parentObjectId` # @return [String] attr_accessor :parent_object_id @@ -2483,9 +2344,8 @@ module Google class Presentation include Google::Apis::Core::Hashable - # The layouts in the presentation. A layout is a template that determines - # how content is arranged and styled on the slides that inherit from that - # layout. + # The layouts in the presentation. A layout is a template that determines how + # content is arranged and styled on the slides that inherit from that layout. # Corresponds to the JSON property `layouts` # @return [Array] attr_accessor :layouts @@ -2495,15 +2355,13 @@ module Google # @return [String] attr_accessor :locale - # The slide masters in the presentation. A slide master contains all common - # page elements and the common properties for a set of layouts. They serve - # three purposes: - # - Placeholder shapes on a master contain the default text styles and shape - # properties of all placeholder shapes on pages that use that master. - # - The master page properties define the common page properties inherited by - # its layouts. - # - Any other shapes on the master slide appear on all slides using that - # master, regardless of their layout. + # The slide masters in the presentation. A slide master contains all common page + # elements and the common properties for a set of layouts. They serve three + # purposes: - Placeholder shapes on a master contain the default text styles and + # shape properties of all placeholder shapes on pages that use that master. - + # The master page properties define the common page properties inherited by its + # layouts. - Any other shapes on the master slide appear on all slides using + # that master, regardless of their layout. # Corresponds to the JSON property `masters` # @return [Array] attr_accessor :masters @@ -2523,23 +2381,22 @@ module Google # @return [String] attr_accessor :presentation_id - # The revision ID of the presentation. Can be used in update requests - # to assert that the presentation revision hasn't changed since the last - # read operation. Only populated if the user has edit access to the - # presentation. - # The format of the revision ID may change over time, so it should be treated - # opaquely. A returned revision ID is only guaranteed to be valid for 24 - # hours after it has been returned and cannot be shared across users. If the - # revision ID is unchanged between calls, then the presentation has not - # changed. Conversely, a changed ID (for the same presentation and user) - # usually means the presentation has been updated; however, a changed ID can - # also be due to internal factors such as ID format changes. + # The revision ID of the presentation. Can be used in update requests to assert + # that the presentation revision hasn't changed since the last read operation. + # Only populated if the user has edit access to the presentation. The format of + # the revision ID may change over time, so it should be treated opaquely. A + # returned revision ID is only guaranteed to be valid for 24 hours after it has + # been returned and cannot be shared across users. If the revision ID is + # unchanged between calls, then the presentation has not changed. Conversely, a + # changed ID (for the same presentation and user) usually means the presentation + # has been updated; however, a changed ID can also be due to internal factors + # such as ID format changes. # Corresponds to the JSON property `revisionId` # @return [String] attr_accessor :revision_id - # The slides in the presentation. - # A slide inherits properties from a slide layout. + # The slides in the presentation. A slide inherits properties from a slide + # layout. # Corresponds to the JSON property `slides` # @return [Array] attr_accessor :slides @@ -2572,14 +2429,14 @@ module Google class Range include Google::Apis::Core::Hashable - # The optional zero-based index of the end of the collection. - # Required for `FIXED_RANGE` ranges. + # The optional zero-based index of the end of the collection. Required for ` + # FIXED_RANGE` ranges. # Corresponds to the JSON property `endIndex` # @return [Fixnum] attr_accessor :end_index - # The optional zero-based index of the beginning of the collection. - # Required for `FIXED_RANGE` and `FROM_START_INDEX` ranges. + # The optional zero-based index of the beginning of the collection. Required for + # `FIXED_RANGE` and `FROM_START_INDEX` ranges. # Corresponds to the JSON property `startIndex` # @return [Fixnum] attr_accessor :start_index @@ -2605,19 +2462,17 @@ module Google class Recolor include Google::Apis::Core::Hashable - # The name of the recolor effect. - # The name is determined from the `recolor_stops` by matching the gradient - # against the colors in the page's current color scheme. This property is - # read-only. + # The name of the recolor effect. The name is determined from the `recolor_stops` + # by matching the gradient against the colors in the page's current color + # scheme. This property is read-only. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # The recolor effect is represented by a gradient, which is a list of color - # stops. - # The colors in the gradient will replace the corresponding colors at - # the same position in the color palette and apply to the image. This - # property is read-only. + # stops. The colors in the gradient will replace the corresponding colors at the + # same position in the color palette and apply to the image. This property is + # read-only. # Corresponds to the JSON property `recolorStops` # @return [Array] attr_accessor :recolor_stops @@ -2634,9 +2489,9 @@ module Google end # Refreshes an embedded Google Sheets chart by replacing it with the latest - # version of the chart from Google Sheets. - # NOTE: Refreshing charts requires at least one of the spreadsheets.readonly, - # spreadsheets, drive.readonly, or drive OAuth scopes. + # version of the chart from Google Sheets. NOTE: Refreshing charts requires at + # least one of the spreadsheets.readonly, spreadsheets, drive.readonly, or drive + # OAuth scopes. class RefreshSheetsChartRequest include Google::Apis::Core::Hashable @@ -2655,9 +2510,9 @@ module Google end end - # Replaces all shapes that match the given criteria with the provided image. - # The images replacing the shapes are rectangular after being inserted into - # the presentation and do not take on the forms of the shapes. + # Replaces all shapes that match the given criteria with the provided image. The + # images replacing the shapes are rectangular after being inserted into the + # presentation and do not take on the forms of the shapes. class ReplaceAllShapesWithImageRequest include Google::Apis::Core::Hashable @@ -2666,41 +2521,35 @@ module Google # @return [Google::Apis::SlidesV1::SubstringMatchCriteria] attr_accessor :contains_text - # The image replace method. - # If you specify both a `replace_method` and an `image_replace_method`, the - # `image_replace_method` takes precedence. - # If you do not specify a value for `image_replace_method`, but specify a - # value for `replace_method`, then the specified `replace_method` value is - # used. - # If you do not specify either, then CENTER_INSIDE is used. + # The image replace method. If you specify both a `replace_method` and an ` + # image_replace_method`, the `image_replace_method` takes precedence. If you do + # not specify a value for `image_replace_method`, but specify a value for ` + # replace_method`, then the specified `replace_method` value is used. If you do + # not specify either, then CENTER_INSIDE is used. # Corresponds to the JSON property `imageReplaceMethod` # @return [String] attr_accessor :image_replace_method - # The image URL. - # The image is fetched once at insertion time and a copy is stored for - # display inside the presentation. Images must be less than 50MB in size, - # cannot exceed 25 megapixels, and must be in one of PNG, JPEG, or GIF - # format. - # The provided URL can be at most 2 kB in length. The URL itself is saved - # with the image, and exposed via the Image.source_url field. + # The image URL. The image is fetched once at insertion time and a copy is + # stored for display inside the presentation. Images must be less than 50MB in + # size, cannot exceed 25 megapixels, and must be in one of PNG, JPEG, or GIF + # format. The provided URL can be at most 2 kB in length. The URL itself is + # saved with the image, and exposed via the Image.source_url field. # Corresponds to the JSON property `imageUrl` # @return [String] attr_accessor :image_url # If non-empty, limits the matches to page elements only on the given pages. - # Returns a 400 bad request error if given the page object ID of a - # notes page or a - # notes master, or if a - # page with that object ID doesn't exist in the presentation. + # Returns a 400 bad request error if given the page object ID of a notes page or + # a notes master, or if a page with that object ID doesn't exist in the + # presentation. # Corresponds to the JSON property `pageObjectIds` # @return [Array] attr_accessor :page_object_ids - # The replace method. - # Deprecated: use `image_replace_method` instead. - # If you specify both a `replace_method` and an `image_replace_method`, the - # `image_replace_method` takes precedence. + # The replace method. *Deprecated*: use `image_replace_method` instead. If you + # specify both a `replace_method` and an `image_replace_method`, the ` + # image_replace_method` takes precedence. # Corresponds to the JSON property `replaceMethod` # @return [String] attr_accessor :replace_method @@ -2740,9 +2589,9 @@ module Google # Replaces all shapes that match the given criteria with the provided Google # Sheets chart. The chart will be scaled and centered to fit within the bounds - # of the original shape. - # NOTE: Replacing shapes with a chart requires at least one of the - # spreadsheets.readonly, spreadsheets, drive.readonly, or drive OAuth scopes. + # of the original shape. NOTE: Replacing shapes with a chart requires at least + # one of the spreadsheets.readonly, spreadsheets, drive.readonly, or drive OAuth + # scopes. class ReplaceAllShapesWithSheetsChartRequest include Google::Apis::Core::Hashable @@ -2756,17 +2605,16 @@ module Google # @return [Google::Apis::SlidesV1::SubstringMatchCriteria] attr_accessor :contains_text - # The mode with which the chart is linked to the source spreadsheet. When - # not specified, the chart will be an image that is not linked. + # The mode with which the chart is linked to the source spreadsheet. When not + # specified, the chart will be an image that is not linked. # Corresponds to the JSON property `linkingMode` # @return [String] attr_accessor :linking_mode # If non-empty, limits the matches to page elements only on the given pages. - # Returns a 400 bad request error if given the page object ID of a - # notes page or a - # notes master, or if a - # page with that object ID doesn't exist in the presentation. + # Returns a 400 bad request error if given the page object ID of a notes page or + # a notes master, or if a page with that object ID doesn't exist in the + # presentation. # Corresponds to the JSON property `pageObjectIds` # @return [Array] attr_accessor :page_object_ids @@ -2819,8 +2667,7 @@ module Google attr_accessor :contains_text # If non-empty, limits the matches to page elements only on the given pages. - # Returns a 400 bad request error if given the page object ID of a - # notes master, + # Returns a 400 bad request error if given the page object ID of a notes master, # or if a page with that object ID doesn't exist in the presentation. # Corresponds to the JSON property `pageObjectIds` # @return [Array] @@ -2862,8 +2709,8 @@ module Google end end - # Replaces an existing image with a new image. - # Replacing an image removes some image effects from the existing image. + # Replaces an existing image with a new image. Replacing an image removes some + # image effects from the existing image. class ReplaceImageRequest include Google::Apis::Core::Hashable @@ -2877,13 +2724,11 @@ module Google # @return [String] attr_accessor :image_replace_method - # The image URL. - # The image is fetched once at insertion time and a copy is stored for - # display inside the presentation. Images must be less than 50MB in size, - # cannot exceed 25 megapixels, and must be in one of PNG, JPEG, or GIF - # format. - # The provided URL can be at most 2 kB in length. The URL itself is saved - # with the image, and exposed via the Image.source_url field. + # The image URL. The image is fetched once at insertion time and a copy is + # stored for display inside the presentation. Images must be less than 50MB in + # size, cannot exceed 25 megapixels, and must be in one of PNG, JPEG, or GIF + # format. The provided URL can be at most 2 kB in length. The URL itself is + # saved with the image, and exposed via the Image.source_url field. # Corresponds to the JSON property `url` # @return [String] attr_accessor :url @@ -2914,15 +2759,13 @@ module Google # @return [Google::Apis::SlidesV1::CreateLineRequest] attr_accessor :create_line - # Creates bullets for all of the paragraphs that overlap with the given - # text index range. - # The nesting level of each paragraph will be determined by counting leading - # tabs in front of each paragraph. To avoid excess space between the bullet and - # the corresponding paragraph, these leading tabs are removed by this request. - # This may change the indices of parts of the text. - # If the paragraph immediately before paragraphs being updated is in a list - # with a matching preset, the paragraphs being updated are added to that - # preceding list. + # Creates bullets for all of the paragraphs that overlap with the given text + # index range. The nesting level of each paragraph will be determined by + # counting leading tabs in front of each paragraph. To avoid excess space + # between the bullet and the corresponding paragraph, these leading tabs are + # removed by this request. This may change the indices of parts of the text. If + # the paragraph immediately before paragraphs being updated is in a list with a + # matching preset, the paragraphs being updated are added to that preceding list. # Corresponds to the JSON property `createParagraphBullets` # @return [Google::Apis::SlidesV1::CreateParagraphBulletsRequest] attr_accessor :create_paragraph_bullets @@ -2932,9 +2775,9 @@ module Google # @return [Google::Apis::SlidesV1::CreateShapeRequest] attr_accessor :create_shape - # Creates an embedded Google Sheets chart. - # NOTE: Chart creation requires at least one of the spreadsheets.readonly, - # spreadsheets, drive.readonly, drive.file, or drive OAuth scopes. + # Creates an embedded Google Sheets chart. NOTE: Chart creation requires at + # least one of the spreadsheets.readonly, spreadsheets, drive.readonly, drive. + # file, or drive OAuth scopes. # Corresponds to the JSON property `createSheetsChart` # @return [Google::Apis::SlidesV1::CreateSheetsChartRequest] attr_accessor :create_sheets_chart @@ -2949,24 +2792,21 @@ module Google # @return [Google::Apis::SlidesV1::CreateTableRequest] attr_accessor :create_table - # Creates a video. - # NOTE: Creating a video from Google Drive requires that the requesting app - # have at least one of the drive, drive.readonly, or drive.file OAuth scopes. + # Creates a video. NOTE: Creating a video from Google Drive requires that the + # requesting app have at least one of the drive, drive.readonly, or drive.file + # OAuth scopes. # Corresponds to the JSON property `createVideo` # @return [Google::Apis::SlidesV1::CreateVideoRequest] attr_accessor :create_video - # Deletes an object, either pages or - # page elements, from the - # presentation. + # Deletes an object, either pages or page elements, from the presentation. # Corresponds to the JSON property `deleteObject` # @return [Google::Apis::SlidesV1::DeleteObjectRequest] attr_accessor :delete_object # Deletes bullets from all of the paragraphs that overlap with the given text - # index range. - # The nesting level of each paragraph will be visually preserved by adding - # indent to the start of the corresponding paragraph. + # index range. The nesting level of each paragraph will be visually preserved by + # adding indent to the start of the corresponding paragraph. # Corresponds to the JSON property `deleteParagraphBullets` # @return [Google::Apis::SlidesV1::DeleteParagraphBulletsRequest] attr_accessor :delete_paragraph_bullets @@ -2986,10 +2826,10 @@ module Google # @return [Google::Apis::SlidesV1::DeleteTextRequest] attr_accessor :delete_text - # Duplicates a slide or page element. - # When duplicating a slide, the duplicate slide will be created immediately - # following the specified slide. When duplicating a page element, the duplicate - # will be placed on the same page at the same position as the original. + # Duplicates a slide or page element. When duplicating a slide, the duplicate + # slide will be created immediately following the specified slide. When + # duplicating a page element, the duplicate will be placed on the same page at + # the same position as the original. # Corresponds to the JSON property `duplicateObject` # @return [Google::Apis::SlidesV1::DuplicateObjectRequest] attr_accessor :duplicate_object @@ -3000,8 +2840,8 @@ module Google # @return [Google::Apis::SlidesV1::GroupObjectsRequest] attr_accessor :group_objects - # Inserts columns into a table. - # Other columns in the table will be resized to fit the new column. + # Inserts columns into a table. Other columns in the table will be resized to + # fit the new column. # Corresponds to the JSON property `insertTableColumns` # @return [Google::Apis::SlidesV1::InsertTableColumnsRequest] attr_accessor :insert_table_columns @@ -3022,25 +2862,25 @@ module Google attr_accessor :merge_table_cells # Refreshes an embedded Google Sheets chart by replacing it with the latest - # version of the chart from Google Sheets. - # NOTE: Refreshing charts requires at least one of the spreadsheets.readonly, - # spreadsheets, drive.readonly, or drive OAuth scopes. + # version of the chart from Google Sheets. NOTE: Refreshing charts requires at + # least one of the spreadsheets.readonly, spreadsheets, drive.readonly, or drive + # OAuth scopes. # Corresponds to the JSON property `refreshSheetsChart` # @return [Google::Apis::SlidesV1::RefreshSheetsChartRequest] attr_accessor :refresh_sheets_chart - # Replaces all shapes that match the given criteria with the provided image. - # The images replacing the shapes are rectangular after being inserted into - # the presentation and do not take on the forms of the shapes. + # Replaces all shapes that match the given criteria with the provided image. The + # images replacing the shapes are rectangular after being inserted into the + # presentation and do not take on the forms of the shapes. # Corresponds to the JSON property `replaceAllShapesWithImage` # @return [Google::Apis::SlidesV1::ReplaceAllShapesWithImageRequest] attr_accessor :replace_all_shapes_with_image # Replaces all shapes that match the given criteria with the provided Google # Sheets chart. The chart will be scaled and centered to fit within the bounds - # of the original shape. - # NOTE: Replacing shapes with a chart requires at least one of the - # spreadsheets.readonly, spreadsheets, drive.readonly, or drive OAuth scopes. + # of the original shape. NOTE: Replacing shapes with a chart requires at least + # one of the spreadsheets.readonly, spreadsheets, drive.readonly, or drive OAuth + # scopes. # Corresponds to the JSON property `replaceAllShapesWithSheetsChart` # @return [Google::Apis::SlidesV1::ReplaceAllShapesWithSheetsChartRequest] attr_accessor :replace_all_shapes_with_sheets_chart @@ -3050,14 +2890,14 @@ module Google # @return [Google::Apis::SlidesV1::ReplaceAllTextRequest] attr_accessor :replace_all_text - # Replaces an existing image with a new image. - # Replacing an image removes some image effects from the existing image. + # Replaces an existing image with a new image. Replacing an image removes some + # image effects from the existing image. # Corresponds to the JSON property `replaceImage` # @return [Google::Apis::SlidesV1::ReplaceImageRequest] attr_accessor :replace_image - # Reroutes a line such that it's connected at the - # two closest connection sites on the connected page elements. + # Reroutes a line such that it's connected at the two closest connection sites + # on the connected page elements. # Corresponds to the JSON property `rerouteLine` # @return [Google::Apis::SlidesV1::RerouteLineRequest] attr_accessor :reroute_line @@ -3087,16 +2927,15 @@ module Google # @return [Google::Apis::SlidesV1::UpdateLinePropertiesRequest] attr_accessor :update_line_properties - # Updates the alt text title and/or description of a - # page element. + # Updates the alt text title and/or description of a page element. # Corresponds to the JSON property `updatePageElementAltText` # @return [Google::Apis::SlidesV1::UpdatePageElementAltTextRequest] attr_accessor :update_page_element_alt_text - # Updates the transform of a page element. - # Updating the transform of a group will change the absolute transform of the - # page elements in that group, which can change their visual appearance. See - # the documentation for PageElement.transform for more details. + # Updates the transform of a page element. Updating the transform of a group + # will change the absolute transform of the page elements in that group, which + # can change their visual appearance. See the documentation for PageElement. + # transform for more details. # Corresponds to the JSON property `updatePageElementTransform` # @return [Google::Apis::SlidesV1::UpdatePageElementTransformRequest] attr_accessor :update_page_element_transform @@ -3149,8 +2988,7 @@ module Google # @return [Google::Apis::SlidesV1::UpdateTableRowPropertiesRequest] attr_accessor :update_table_row_properties - # Update the styling of text in a Shape or - # Table. + # Update the styling of text in a Shape or Table. # Corresponds to the JSON property `updateTextStyle` # @return [Google::Apis::SlidesV1::UpdateTextStyleRequest] attr_accessor :update_text_style @@ -3212,15 +3050,14 @@ module Google end end - # Reroutes a line such that it's connected at the - # two closest connection sites on the connected page elements. + # Reroutes a line such that it's connected at the two closest connection sites + # on the connected page elements. class RerouteLineRequest include Google::Apis::Core::Hashable - # The object ID of the line to reroute. - # Only a line with a category - # indicating it is a "connector" can be rerouted. The start and end - # connections of the line must be on different page elements. + # The object ID of the line to reroute. Only a line with a category indicating + # it is a "connector" can be rerouted. The start and end connections of the line + # must be on different page elements. # Corresponds to the JSON property `objectId` # @return [String] attr_accessor :object_id_prop @@ -3351,16 +3188,15 @@ module Google end end - # The shadow properties of a page element. - # If these fields are unset, they may be inherited from a parent placeholder - # if it exists. If there is no parent, the fields will default to the value - # used for new page elements created in the Slides editor, which may depend on - # the page element kind. + # The shadow properties of a page element. If these fields are unset, they may + # be inherited from a parent placeholder if it exists. If there is no parent, + # the fields will default to the value used for new page elements created in the + # Slides editor, which may depend on the page element kind. class Shadow include Google::Apis::Core::Hashable - # The alignment point of the shadow, that sets the origin for translate, - # scale and skew of the shadow. This property is read-only. + # The alignment point of the shadow, that sets the origin for translate, scale + # and skew of the shadow. This property is read-only. # Corresponds to the JSON property `alignment` # @return [String] attr_accessor :alignment @@ -3380,31 +3216,26 @@ module Google # @return [Google::Apis::SlidesV1::OpaqueColor] attr_accessor :color - # The shadow property state. - # Updating the shadow on a page element will implicitly update this field to - # `RENDERED`, unless another value is specified in the same request. To have - # no shadow on a page element, set this field to `NOT_RENDERED`. In this - # case, any other shadow fields set in the same request will be ignored. + # The shadow property state. Updating the shadow on a page element will + # implicitly update this field to `RENDERED`, unless another value is specified + # in the same request. To have no shadow on a page element, set this field to ` + # NOT_RENDERED`. In this case, any other shadow fields set in the same request + # will be ignored. # Corresponds to the JSON property `propertyState` # @return [String] attr_accessor :property_state - # Whether the shadow should rotate with the shape. This property is - # read-only. + # Whether the shadow should rotate with the shape. This property is read-only. # Corresponds to the JSON property `rotateWithShape` # @return [Boolean] attr_accessor :rotate_with_shape alias_method :rotate_with_shape?, :rotate_with_shape - # AffineTransform uses a 3x3 matrix with an implied last row of [ 0 0 1 ] - # to transform source coordinates (x,y) into destination coordinates (x', y') - # according to: - # x' x = shear_y scale_y translate_y - # 1 [ 1 ] - # After transformation, - # x' = scale_x * x + shear_x * y + translate_x; - # y' = scale_y * y + shear_y * x + translate_y; - # This message is therefore composed of these six matrix elements. + # AffineTransform uses a 3x3 matrix with an implied last row of [ 0 0 1 ] to + # transform source coordinates (x,y) into destination coordinates (x', y') + # according to: x' x = shear_y scale_y translate_y 1 [ 1 ] After transformation, + # x' = scale_x * x + shear_x * y + translate_x; y' = scale_y * y + shear_y * x + + # translate_y; This message is therefore composed of these six matrix elements. # Corresponds to the JSON property `transform` # @return [Google::Apis::SlidesV1::AffineTransform] attr_accessor :transform @@ -3431,8 +3262,8 @@ module Google end end - # A PageElement kind representing a - # generic shape that does not have a more specific classification. + # A PageElement kind representing a generic shape that does not have a more + # specific classification. class Shape include Google::Apis::Core::Hashable @@ -3441,12 +3272,10 @@ module Google # @return [Google::Apis::SlidesV1::Placeholder] attr_accessor :placeholder - # The properties of a Shape. - # If the shape is a placeholder shape as determined by the - # placeholder field, then these - # properties may be inherited from a parent placeholder shape. - # Determining the rendered value of the property depends on the corresponding - # property_state field value. + # The properties of a Shape. If the shape is a placeholder shape as determined + # by the placeholder field, then these properties may be inherited from a parent + # placeholder shape. Determining the rendered value of the property depends on + # the corresponding property_state field value. # Corresponds to the JSON property `shapeProperties` # @return [Google::Apis::SlidesV1::ShapeProperties] attr_accessor :shape_properties @@ -3479,19 +3308,18 @@ module Google class ShapeBackgroundFill include Google::Apis::Core::Hashable - # The background fill property state. - # Updating the fill on a shape will implicitly update this field to - # `RENDERED`, unless another value is specified in the same request. To - # have no fill on a shape, set this field to `NOT_RENDERED`. In this case, - # any other fill fields set in the same request will be ignored. + # The background fill property state. Updating the fill on a shape will + # implicitly update this field to `RENDERED`, unless another value is specified + # in the same request. To have no fill on a shape, set this field to ` + # NOT_RENDERED`. In this case, any other fill fields set in the same request + # will be ignored. # Corresponds to the JSON property `propertyState` # @return [String] attr_accessor :property_state # A solid color fill. The page or page element is filled entirely with the - # specified color value. - # If any field is unset, its value may be inherited from a parent placeholder - # if it exists. + # specified color value. If any field is unset, its value may be inherited from + # a parent placeholder if it exists. # Corresponds to the JSON property `solidFill` # @return [Google::Apis::SlidesV1::SolidFill] attr_accessor :solid_fill @@ -3507,19 +3335,17 @@ module Google end end - # The properties of a Shape. - # If the shape is a placeholder shape as determined by the - # placeholder field, then these - # properties may be inherited from a parent placeholder shape. - # Determining the rendered value of the property depends on the corresponding - # property_state field value. + # The properties of a Shape. If the shape is a placeholder shape as determined + # by the placeholder field, then these properties may be inherited from a parent + # placeholder shape. Determining the rendered value of the property depends on + # the corresponding property_state field value. class ShapeProperties include Google::Apis::Core::Hashable - # The alignment of the content in the shape. If unspecified, - # the alignment is inherited from a parent placeholder if it exists. If the - # shape has no parent, the default alignment matches the alignment for new - # shapes created in the Slides editor. + # The alignment of the content in the shape. If unspecified, the alignment is + # inherited from a parent placeholder if it exists. If the shape has no parent, + # the default alignment matches the alignment for new shapes created in the + # Slides editor. # Corresponds to the JSON property `contentAlignment` # @return [String] attr_accessor :content_alignment @@ -3529,20 +3355,18 @@ module Google # @return [Google::Apis::SlidesV1::Link] attr_accessor :link - # The outline of a PageElement. - # If these fields are unset, they may be inherited from a parent placeholder - # if it exists. If there is no parent, the fields will default to the value - # used for new page elements created in the Slides editor, which may depend on - # the page element kind. + # The outline of a PageElement. If these fields are unset, they may be inherited + # from a parent placeholder if it exists. If there is no parent, the fields will + # default to the value used for new page elements created in the Slides editor, + # which may depend on the page element kind. # Corresponds to the JSON property `outline` # @return [Google::Apis::SlidesV1::Outline] attr_accessor :outline - # The shadow properties of a page element. - # If these fields are unset, they may be inherited from a parent placeholder - # if it exists. If there is no parent, the fields will default to the value - # used for new page elements created in the Slides editor, which may depend on - # the page element kind. + # The shadow properties of a page element. If these fields are unset, they may + # be inherited from a parent placeholder if it exists. If there is no parent, + # the fields will default to the value used for new page elements created in the + # Slides editor, which may depend on the page element kind. # Corresponds to the JSON property `shadow` # @return [Google::Apis::SlidesV1::Shadow] attr_accessor :shadow @@ -3566,21 +3390,19 @@ module Google end end - # A PageElement kind representing - # a linked chart embedded from Google Sheets. + # A PageElement kind representing a linked chart embedded from Google Sheets. class SheetsChart include Google::Apis::Core::Hashable - # The ID of the specific chart in the Google Sheets spreadsheet that is - # embedded. + # The ID of the specific chart in the Google Sheets spreadsheet that is embedded. # Corresponds to the JSON property `chartId` # @return [Fixnum] attr_accessor :chart_id # The URL of an image of the embedded chart, with a default lifetime of 30 - # minutes. This URL is tagged with the account of the requester. Anyone with - # the URL effectively accesses the image as the original requester. Access to - # the image may be lost if the presentation's sharing settings change. + # minutes. This URL is tagged with the account of the requester. Anyone with the + # URL effectively accesses the image as the original requester. Access to the + # image may be lost if the presentation's sharing settings change. # Corresponds to the JSON property `contentUrl` # @return [String] attr_accessor :content_url @@ -3652,19 +3474,18 @@ module Google end end - # The properties of Page that are only - # relevant for pages with page_type SLIDE. + # The properties of Page that are only relevant for pages with page_type SLIDE. class SlideProperties include Google::Apis::Core::Hashable - # The object ID of the layout that this slide is based on. This property is - # read-only. + # The object ID of the layout that this slide is based on. This property is read- + # only. # Corresponds to the JSON property `layoutObjectId` # @return [String] attr_accessor :layout_object_id - # The object ID of the master that this slide is based on. This property is - # read-only. + # The object ID of the master that this slide is based on. This property is read- + # only. # Corresponds to the JSON property `masterObjectId` # @return [String] attr_accessor :master_object_id @@ -3687,17 +3508,16 @@ module Google end # A solid color fill. The page or page element is filled entirely with the - # specified color value. - # If any field is unset, its value may be inherited from a parent placeholder - # if it exists. + # specified color value. If any field is unset, its value may be inherited from + # a parent placeholder if it exists. class SolidFill include Google::Apis::Core::Hashable - # The fraction of this `color` that should be applied to the pixel. - # That is, the final pixel color is defined by the equation: - # pixel color = alpha * (color) + (1.0 - alpha) * (background color) - # This means that a value of 1.0 corresponds to a solid color, whereas - # a value of 0.0 corresponds to a completely transparent color. + # The fraction of this `color` that should be applied to the pixel. That is, the + # final pixel color is defined by the equation: pixel color = alpha * (color) + ( + # 1.0 - alpha) * (background color) This means that a value of 1.0 corresponds + # to a solid color, whereas a value of 0.0 corresponds to a completely + # transparent color. # Corresponds to the JSON property `alpha` # @return [Float] attr_accessor :alpha @@ -3723,17 +3543,14 @@ module Google class StretchedPictureFill include Google::Apis::Core::Hashable - # Reading the content_url: - # An URL to a picture with a default lifetime of 30 minutes. - # This URL is tagged with the account of the requester. Anyone with the URL - # effectively accesses the picture as the original requester. Access to the - # picture may be lost if the presentation's sharing settings change. - # Writing the content_url: - # The picture is fetched once at insertion time and a copy is stored for - # display inside the presentation. Pictures must be less than 50MB in size, - # cannot exceed 25 megapixels, and must be in one of PNG, JPEG, or GIF - # format. - # The provided URL can be at most 2 kB in length. + # Reading the content_url: An URL to a picture with a default lifetime of 30 + # minutes. This URL is tagged with the account of the requester. Anyone with the + # URL effectively accesses the picture as the original requester. Access to the + # picture may be lost if the presentation's sharing settings change. Writing the + # content_url: The picture is fetched once at insertion time and a copy is + # stored for display inside the presentation. Pictures must be less than 50MB in + # size, cannot exceed 25 megapixels, and must be in one of PNG, JPEG, or GIF + # format. The provided URL can be at most 2 kB in length. # Corresponds to the JSON property `contentUrl` # @return [String] attr_accessor :content_url @@ -3758,9 +3575,8 @@ module Google class SubstringMatchCriteria include Google::Apis::Core::Hashable - # Indicates whether the search should respect case: - # - `True`: the search is case sensitive. - # - `False`: the search is case insensitive. + # Indicates whether the search should respect case: - `True`: the search is case + # sensitive. - `False`: the search is case insensitive. # Corresponds to the JSON property `matchCase` # @return [Boolean] attr_accessor :match_case @@ -3782,8 +3598,7 @@ module Google end end - # A PageElement kind representing a - # table. + # A PageElement kind representing a table. class Table include Google::Apis::Core::Hashable @@ -3792,11 +3607,11 @@ module Google # @return [Fixnum] attr_accessor :columns - # Properties of horizontal cell borders. - # A table's horizontal cell borders are represented as a grid. The grid has - # one more row than the number of rows in the table and the same number of - # columns as the table. For example, if the table is 3 x 3, its horizontal - # borders will be represented as a grid with 4 rows and 3 columns. + # Properties of horizontal cell borders. A table's horizontal cell borders are + # represented as a grid. The grid has one more row than the number of rows in + # the table and the same number of columns as the table. For example, if the + # table is 3 x 3, its horizontal borders will be represented as a grid with 4 + # rows and 3 columns. # Corresponds to the JSON property `horizontalBorderRows` # @return [Array] attr_accessor :horizontal_border_rows @@ -3811,19 +3626,17 @@ module Google # @return [Array] attr_accessor :table_columns - # Properties and contents of each row. - # Cells that span multiple rows are contained in only one of these rows and - # have a row_span greater - # than 1. + # Properties and contents of each row. Cells that span multiple rows are + # contained in only one of these rows and have a row_span greater than 1. # Corresponds to the JSON property `tableRows` # @return [Array] attr_accessor :table_rows - # Properties of vertical cell borders. - # A table's vertical cell borders are represented as a grid. The grid has the - # same number of rows as the table and one more column than the number of - # columns in the table. For example, if the table is 3 x 3, its vertical - # borders will be represented as a grid with 3 rows and 4 columns. + # Properties of vertical cell borders. A table's vertical cell borders are + # represented as a grid. The grid has the same number of rows as the table and + # one more column than the number of columns in the table. For example, if the + # table is 3 x 3, its vertical borders will be represented as a grid with 3 rows + # and 4 columns. # Corresponds to the JSON property `verticalBorderRows` # @return [Array] attr_accessor :vertical_border_rows @@ -3852,8 +3665,7 @@ module Google # @return [Google::Apis::SlidesV1::TableCellLocation] attr_accessor :location - # The border styling properties of the - # TableBorderCell. + # The border styling properties of the TableBorderCell. # Corresponds to the JSON property `tableBorderProperties` # @return [Google::Apis::SlidesV1::TableBorderProperties] attr_accessor :table_border_properties @@ -3874,9 +3686,8 @@ module Google include Google::Apis::Core::Hashable # A solid color fill. The page or page element is filled entirely with the - # specified color value. - # If any field is unset, its value may be inherited from a parent placeholder - # if it exists. + # specified color value. If any field is unset, its value may be inherited from + # a parent placeholder if it exists. # Corresponds to the JSON property `solidFill` # @return [Google::Apis::SlidesV1::SolidFill] attr_accessor :solid_fill @@ -3891,8 +3702,7 @@ module Google end end - # The border styling properties of the - # TableBorderCell. + # The border styling properties of the TableBorderCell. class TableBorderProperties include Google::Apis::Core::Hashable @@ -3991,19 +3801,18 @@ module Google class TableCellBackgroundFill include Google::Apis::Core::Hashable - # The background fill property state. - # Updating the fill on a table cell will implicitly update this field - # to `RENDERED`, unless another value is specified in the same request. To - # have no fill on a table cell, set this field to `NOT_RENDERED`. In this - # case, any other fill fields set in the same request will be ignored. + # The background fill property state. Updating the fill on a table cell will + # implicitly update this field to `RENDERED`, unless another value is specified + # in the same request. To have no fill on a table cell, set this field to ` + # NOT_RENDERED`. In this case, any other fill fields set in the same request + # will be ignored. # Corresponds to the JSON property `propertyState` # @return [String] attr_accessor :property_state # A solid color fill. The page or page element is filled entirely with the - # specified color value. - # If any field is unset, its value may be inherited from a parent placeholder - # if it exists. + # specified color value. If any field is unset, its value may be inherited from + # a parent placeholder if it exists. # Corresponds to the JSON property `solidFill` # @return [Google::Apis::SlidesV1::SolidFill] attr_accessor :solid_fill @@ -4048,8 +3857,8 @@ module Google class TableCellProperties include Google::Apis::Core::Hashable - # The alignment of the content in the table cell. The default alignment - # matches the alignment for newly created table cells in the Slides editor. + # The alignment of the content in the table cell. The default alignment matches + # the alignment for newly created table cells in the Slides editor. # Corresponds to the JSON property `contentAlignment` # @return [String] attr_accessor :content_alignment @@ -4089,17 +3898,12 @@ module Google end end - # A table range represents a reference to a subset of a table. - # It's important to note that the cells specified by a table range do not - # necessarily form a rectangle. For example, let's say we have a 3 x 3 table - # where all the cells of the last row are merged together. The table looks - # like this: - # - # [ ] - # A table range with location = (0, 0), row span = 3 and column span = 2 - # specifies the following cells: - # x x - # [ x x x ] + # A table range represents a reference to a subset of a table. It's important to + # note that the cells specified by a table range do not necessarily form a + # rectangle. For example, let's say we have a 3 x 3 table where all the cells of + # the last row are merged together. The table looks like this: [ ] A table range + # with location = (0, 0), row span = 3 and column span = 2 specifies the + # following cells: x x [ x x x ] class TableRange include Google::Apis::Core::Hashable @@ -4139,11 +3943,10 @@ module Google # @return [Google::Apis::SlidesV1::Dimension] attr_accessor :row_height - # Properties and contents of each cell. - # Cells that span multiple columns are represented only once with a - # column_span greater - # than 1. As a result, the length of this collection does not always match - # the number of columns of the entire table. + # Properties and contents of each cell. Cells that span multiple columns are + # represented only once with a column_span greater than 1. As a result, the + # length of this collection does not always match the number of columns of the + # entire table. # Corresponds to the JSON property `tableCells` # @return [Array] attr_accessor :table_cells @@ -4237,8 +4040,7 @@ module Google # @return [Fixnum] attr_accessor :start_index - # A TextElement kind that represents a run of text that all has the same - # styling. + # A TextElement kind that represents a run of text that all has the same styling. # Corresponds to the JSON property `textRun` # @return [Google::Apis::SlidesV1::TextRun] attr_accessor :text_run @@ -4257,8 +4059,7 @@ module Google end end - # A TextElement kind that represents a run of text that all has the same - # styling. + # A TextElement kind that represents a run of text that all has the same styling. class TextRun include Google::Apis::Core::Hashable @@ -4267,21 +4068,18 @@ module Google # @return [String] attr_accessor :content - # Represents the styling that can be applied to a TextRun. - # If this text is contained in a shape with a parent placeholder, then these - # text styles may be + # Represents the styling that can be applied to a TextRun. If this text is + # contained in a shape with a parent placeholder, then these text styles may be # inherited from the parent. Which text styles are inherited depend on the - # nesting level of lists: - # * A text run in a paragraph that is not in a list will inherit its text style - # from the the newline character in the paragraph at the 0 nesting level of - # the list inside the parent placeholder. - # * A text run in a paragraph that is in a list will inherit its text style - # from the newline character in the paragraph at its corresponding nesting - # level of the list inside the parent placeholder. - # Inherited text styles are represented as unset fields in this message. If - # text is contained in a shape without a parent placeholder, unsetting these - # fields will revert the style to a value matching the defaults in the Slides - # editor. + # nesting level of lists: * A text run in a paragraph that is not in a list will + # inherit its text style from the the newline character in the paragraph at the + # 0 nesting level of the list inside the parent placeholder. * A text run in a + # paragraph that is in a list will inherit its text style from the newline + # character in the paragraph at its corresponding nesting level of the list + # inside the parent placeholder. Inherited text styles are represented as unset + # fields in this message. If text is contained in a shape without a parent + # placeholder, unsetting these fields will revert the style to a value matching + # the defaults in the Slides editor. # Corresponds to the JSON property `style` # @return [Google::Apis::SlidesV1::TextStyle] attr_accessor :style @@ -4297,21 +4095,18 @@ module Google end end - # Represents the styling that can be applied to a TextRun. - # If this text is contained in a shape with a parent placeholder, then these - # text styles may be + # Represents the styling that can be applied to a TextRun. If this text is + # contained in a shape with a parent placeholder, then these text styles may be # inherited from the parent. Which text styles are inherited depend on the - # nesting level of lists: - # * A text run in a paragraph that is not in a list will inherit its text style - # from the the newline character in the paragraph at the 0 nesting level of - # the list inside the parent placeholder. - # * A text run in a paragraph that is in a list will inherit its text style - # from the newline character in the paragraph at its corresponding nesting - # level of the list inside the parent placeholder. - # Inherited text styles are represented as unset fields in this message. If - # text is contained in a shape without a parent placeholder, unsetting these - # fields will revert the style to a value matching the defaults in the Slides - # editor. + # nesting level of lists: * A text run in a paragraph that is not in a list will + # inherit its text style from the the newline character in the paragraph at the + # 0 nesting level of the list inside the parent placeholder. * A text run in a + # paragraph that is in a list will inherit its text style from the newline + # character in the paragraph at its corresponding nesting level of the list + # inside the parent placeholder. Inherited text styles are represented as unset + # fields in this message. If text is contained in a shape without a parent + # placeholder, unsetting these fields will revert the style to a value matching + # the defaults in the Slides editor. class TextStyle include Google::Apis::Core::Hashable @@ -4320,10 +4115,10 @@ module Google # @return [Google::Apis::SlidesV1::OptionalColor] attr_accessor :background_color - # The text's vertical offset from its normal position. - # Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically - # rendered in a smaller font size, computed based on the `font_size` field. - # The `font_size` itself is not affected by changes in this field. + # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` + # or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font + # size, computed based on the `font_size` field. The `font_size` itself is not + # affected by changes in this field. # Corresponds to the JSON property `baselineOffset` # @return [String] attr_accessor :baseline_offset @@ -4334,13 +4129,11 @@ module Google attr_accessor :bold alias_method :bold?, :bold - # The font family of the text. - # The font family can be any font from the Font menu in Slides or from - # [Google Fonts] (https://fonts.google.com/). If the font name is - # unrecognized, the text is rendered in `Arial`. - # Some fonts can affect the weight of the text. If an update request - # specifies values for both `font_family` and `bold`, the explicitly-set - # `bold` value is used. + # The font family of the text. The font family can be any font from the Font + # menu in Slides or from [Google Fonts] (https://fonts.google.com/). If the font + # name is unrecognized, the text is rendered in `Arial`. Some fonts can affect + # the weight of the text. If an update request specifies values for both ` + # font_family` and `bold`, the explicitly-set `bold` value is used. # Corresponds to the JSON property `fontFamily` # @return [String] attr_accessor :font_family @@ -4439,13 +4232,12 @@ module Google class Thumbnail include Google::Apis::Core::Hashable - # The content URL of the thumbnail image. - # The URL to the image has a default lifetime of 30 minutes. - # This URL is tagged with the account of the requester. Anyone with the URL - # effectively accesses the image as the original requester. Access to the - # image may be lost if the presentation's sharing settings change. - # The mime type of the thumbnail image is the same as specified in the - # `GetPageThumbnailRequest`. + # The content URL of the thumbnail image. The URL to the image has a default + # lifetime of 30 minutes. This URL is tagged with the account of the requester. + # Anyone with the URL effectively accesses the image as the original requester. + # Access to the image may be lost if the presentation's sharing settings change. + # The mime type of the thumbnail image is the same as specified in the ` + # GetPageThumbnailRequest`. # Corresponds to the JSON property `contentUrl` # @return [String] attr_accessor :content_url @@ -4476,11 +4268,10 @@ module Google class UngroupObjectsRequest include Google::Apis::Core::Hashable - # The object IDs of the objects to ungroup. - # Only groups that are not inside other - # groups can be ungrouped. All the groups - # should be on the same page. The group itself is deleted. The visual sizes - # and positions of all the children are preserved. + # The object IDs of the objects to ungroup. Only groups that are not inside + # other groups can be ungrouped. All the groups should be on the same page. The + # group itself is deleted. The visual sizes and positions of all the children + # are preserved. # Corresponds to the JSON property `objectIds` # @return [Array] attr_accessor :object_ids @@ -4504,17 +4295,12 @@ module Google # @return [String] attr_accessor :object_id_prop - # A table range represents a reference to a subset of a table. - # It's important to note that the cells specified by a table range do not - # necessarily form a rectangle. For example, let's say we have a 3 x 3 table - # where all the cells of the last row are merged together. The table looks - # like this: - # - # [ ] - # A table range with location = (0, 0), row span = 3 and column span = 2 - # specifies the following cells: - # x x - # [ x x x ] + # A table range represents a reference to a subset of a table. It's important to + # note that the cells specified by a table range do not necessarily form a + # rectangle. For example, let's say we have a 3 x 3 table where all the cells of + # the last row are merged together. The table looks like this: [ ] A table range + # with location = (0, 0), row span = 3 and column span = 2 specifies the + # following cells: x x [ x x x ] # Corresponds to the JSON property `tableRange` # @return [Google::Apis::SlidesV1::TableRange] attr_accessor :table_range @@ -4534,14 +4320,12 @@ module Google class UpdateImagePropertiesRequest include Google::Apis::Core::Hashable - # The fields that should be updated. - # At least one field must be specified. The root `imageProperties` is - # implied and should not be specified. A single `"*"` can be used as - # short-hand for listing every field. - # For example to update the image outline color, set `fields` to - # `"outline.outlineFill.solidFill.color"`. - # To reset a property to its default value, include its field name in the - # field mask but leave the field itself unset. + # The fields that should be updated. At least one field must be specified. The + # root `imageProperties` is implied and should not be specified. A single `"*"` + # can be used as short-hand for listing every field. For example to update the + # image outline color, set `fields` to `"outline.outlineFill.solidFill.color"`. + # To reset a property to its default value, include its field name in the field + # mask but leave the field itself unset. # Corresponds to the JSON property `fields` # @return [String] attr_accessor :fields @@ -4572,18 +4356,15 @@ module Google class UpdateLineCategoryRequest include Google::Apis::Core::Hashable - # The line category to update to. - # The exact line type is determined based - # on the category to update to and how it's routed to connect to other page - # elements. + # The line category to update to. The exact line type is determined based on the + # category to update to and how it's routed to connect to other page elements. # Corresponds to the JSON property `lineCategory` # @return [String] attr_accessor :line_category - # The object ID of the line the update is applied to. - # Only a line with a category - # indicating it is a "connector" can be updated. - # The line may be rerouted after updating its category. + # The object ID of the line the update is applied to. Only a line with a + # category indicating it is a "connector" can be updated. The line may be + # rerouted after updating its category. # Corresponds to the JSON property `objectId` # @return [String] attr_accessor :object_id_prop @@ -4603,21 +4384,18 @@ module Google class UpdateLinePropertiesRequest include Google::Apis::Core::Hashable - # The fields that should be updated. - # At least one field must be specified. The root `lineProperties` is - # implied and should not be specified. A single `"*"` can be used as - # short-hand for listing every field. - # For example to update the line solid fill color, set `fields` to - # `"lineFill.solidFill.color"`. - # To reset a property to its default value, include its field name in the - # field mask but leave the field itself unset. + # The fields that should be updated. At least one field must be specified. The + # root `lineProperties` is implied and should not be specified. A single `"*"` + # can be used as short-hand for listing every field. For example to update the + # line solid fill color, set `fields` to `"lineFill.solidFill.color"`. To reset + # a property to its default value, include its field name in the field mask but + # leave the field itself unset. # Corresponds to the JSON property `fields` # @return [String] attr_accessor :fields - # The properties of the Line. - # When unset, these fields default to values that match the appearance of - # new lines created in the Slides editor. + # The properties of the Line. When unset, these fields default to values that + # match the appearance of new lines created in the Slides editor. # Corresponds to the JSON property `lineProperties` # @return [Google::Apis::SlidesV1::LineProperties] attr_accessor :line_properties @@ -4639,15 +4417,14 @@ module Google end end - # Updates the alt text title and/or description of a - # page element. + # Updates the alt text title and/or description of a page element. class UpdatePageElementAltTextRequest include Google::Apis::Core::Hashable # The updated alt text description of the page element. If unset the existing - # value will be maintained. The description is exposed to screen readers - # and other accessibility interfaces. Only use human readable values related - # to the content of the page element. + # value will be maintained. The description is exposed to screen readers and + # other accessibility interfaces. Only use human readable values related to the + # content of the page element. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description @@ -4657,10 +4434,10 @@ module Google # @return [String] attr_accessor :object_id_prop - # The updated alt text title of the page element. If unset the - # existing value will be maintained. The title is exposed to screen readers - # and other accessibility interfaces. Only use human readable values related - # to the content of the page element. + # The updated alt text title of the page element. If unset the existing value + # will be maintained. The title is exposed to screen readers and other + # accessibility interfaces. Only use human readable values related to the + # content of the page element. # Corresponds to the JSON property `title` # @return [String] attr_accessor :title @@ -4677,10 +4454,10 @@ module Google end end - # Updates the transform of a page element. - # Updating the transform of a group will change the absolute transform of the - # page elements in that group, which can change their visual appearance. See - # the documentation for PageElement.transform for more details. + # Updates the transform of a page element. Updating the transform of a group + # will change the absolute transform of the page elements in that group, which + # can change their visual appearance. See the documentation for PageElement. + # transform for more details. class UpdatePageElementTransformRequest include Google::Apis::Core::Hashable @@ -4694,15 +4471,11 @@ module Google # @return [String] attr_accessor :object_id_prop - # AffineTransform uses a 3x3 matrix with an implied last row of [ 0 0 1 ] - # to transform source coordinates (x,y) into destination coordinates (x', y') - # according to: - # x' x = shear_y scale_y translate_y - # 1 [ 1 ] - # After transformation, - # x' = scale_x * x + shear_x * y + translate_x; - # y' = scale_y * y + shear_y * x + translate_y; - # This message is therefore composed of these six matrix elements. + # AffineTransform uses a 3x3 matrix with an implied last row of [ 0 0 1 ] to + # transform source coordinates (x,y) into destination coordinates (x', y') + # according to: x' x = shear_y scale_y translate_y 1 [ 1 ] After transformation, + # x' = scale_x * x + shear_x * y + translate_x; y' = scale_y * y + shear_y * x + + # translate_y; This message is therefore composed of these six matrix elements. # Corresponds to the JSON property `transform` # @return [Google::Apis::SlidesV1::AffineTransform] attr_accessor :transform @@ -4725,15 +4498,15 @@ module Google class UpdatePageElementsZOrderRequest include Google::Apis::Core::Hashable - # The Z-order operation to apply on the page elements. - # When applying the operation on multiple page elements, the relative - # Z-orders within these page elements before the operation is maintained. + # The Z-order operation to apply on the page elements. When applying the + # operation on multiple page elements, the relative Z-orders within these page + # elements before the operation is maintained. # Corresponds to the JSON property `operation` # @return [String] attr_accessor :operation - # The object IDs of the page elements to update. - # All the page elements must be on the same page and must not be grouped. + # The object IDs of the page elements to update. All the page elements must be + # on the same page and must not be grouped. # Corresponds to the JSON property `pageElementObjectIds` # @return [Array] attr_accessor :page_element_object_ids @@ -4753,14 +4526,12 @@ module Google class UpdatePagePropertiesRequest include Google::Apis::Core::Hashable - # The fields that should be updated. - # At least one field must be specified. The root `pageProperties` is - # implied and should not be specified. A single `"*"` can be used as - # short-hand for listing every field. - # For example to update the page background solid fill color, set `fields` - # to `"pageBackgroundFill.solidFill.color"`. - # To reset a property to its default value, include its field name in the - # field mask but leave the field itself unset. + # The fields that should be updated. At least one field must be specified. The + # root `pageProperties` is implied and should not be specified. A single `"*"` + # can be used as short-hand for listing every field. For example to update the + # page background solid fill color, set `fields` to `"pageBackgroundFill. + # solidFill.color"`. To reset a property to its default value, include its field + # name in the field mask but leave the field itself unset. # Corresponds to the JSON property `fields` # @return [String] attr_accessor :fields @@ -4770,11 +4541,9 @@ module Google # @return [String] attr_accessor :object_id_prop - # The properties of the Page. - # The page will inherit properties from the parent page. Depending on the page - # type the hierarchy is defined in either - # SlideProperties or - # LayoutProperties. + # The properties of the Page. The page will inherit properties from the parent + # page. Depending on the page type the hierarchy is defined in either + # SlideProperties or LayoutProperties. # Corresponds to the JSON property `pageProperties` # @return [Google::Apis::SlidesV1::PageProperties] attr_accessor :page_properties @@ -4801,14 +4570,12 @@ module Google # @return [Google::Apis::SlidesV1::TableCellLocation] attr_accessor :cell_location - # The fields that should be updated. - # At least one field must be specified. The root `style` is implied and - # should not be specified. A single `"*"` can be used as short-hand for - # listing every field. - # For example, to update the paragraph alignment, set `fields` to - # `"alignment"`. - # To reset a property to its default value, include its field name in the - # field mask but leave the field itself unset. + # The fields that should be updated. At least one field must be specified. The + # root `style` is implied and should not be specified. A single `"*"` can be + # used as short-hand for listing every field. For example, to update the + # paragraph alignment, set `fields` to `"alignment"`. To reset a property to its + # default value, include its field name in the field mask but leave the field + # itself unset. # Corresponds to the JSON property `fields` # @return [String] attr_accessor :fields @@ -4818,16 +4585,13 @@ module Google # @return [String] attr_accessor :object_id_prop - # Styles that apply to a whole paragraph. - # If this text is contained in a shape with a parent placeholder, then these - # paragraph styles may be - # inherited from the parent. Which paragraph styles are inherited depend on the - # nesting level of lists: - # * A paragraph not in a list will inherit its paragraph style from the - # paragraph at the 0 nesting level of the list inside the parent placeholder. + # Styles that apply to a whole paragraph. If this text is contained in a shape + # with a parent placeholder, then these paragraph styles may be inherited from + # the parent. Which paragraph styles are inherited depend on the nesting level + # of lists: * A paragraph not in a list will inherit its paragraph style from + # the paragraph at the 0 nesting level of the list inside the parent placeholder. # * A paragraph in a list will inherit its paragraph style from the paragraph - # at its corresponding nesting level of the list inside the parent - # placeholder. + # at its corresponding nesting level of the list inside the parent placeholder. # Inherited paragraph styles are represented as unset fields in this message. # Corresponds to the JSON property `style` # @return [Google::Apis::SlidesV1::ParagraphStyle] @@ -4857,14 +4621,12 @@ module Google class UpdateShapePropertiesRequest include Google::Apis::Core::Hashable - # The fields that should be updated. - # At least one field must be specified. The root `shapeProperties` is - # implied and should not be specified. A single `"*"` can be used as - # short-hand for listing every field. - # For example to update the shape background solid fill color, set `fields` - # to `"shapeBackgroundFill.solidFill.color"`. - # To reset a property to its default value, include its field name in the - # field mask but leave the field itself unset. + # The fields that should be updated. At least one field must be specified. The + # root `shapeProperties` is implied and should not be specified. A single `"*"` + # can be used as short-hand for listing every field. For example to update the + # shape background solid fill color, set `fields` to `"shapeBackgroundFill. + # solidFill.color"`. To reset a property to its default value, include its field + # name in the field mask but leave the field itself unset. # Corresponds to the JSON property `fields` # @return [String] attr_accessor :fields @@ -4874,12 +4636,10 @@ module Google # @return [String] attr_accessor :object_id_prop - # The properties of a Shape. - # If the shape is a placeholder shape as determined by the - # placeholder field, then these - # properties may be inherited from a parent placeholder shape. - # Determining the rendered value of the property depends on the corresponding - # property_state field value. + # The properties of a Shape. If the shape is a placeholder shape as determined + # by the placeholder field, then these properties may be inherited from a parent + # placeholder shape. Determining the rendered value of the property depends on + # the corresponding property_state field value. # Corresponds to the JSON property `shapeProperties` # @return [Google::Apis::SlidesV1::ShapeProperties] attr_accessor :shape_properties @@ -4900,16 +4660,15 @@ module Google class UpdateSlidesPositionRequest include Google::Apis::Core::Hashable - # The index where the slides should be inserted, based on the slide - # arrangement before the move takes place. Must be between zero and the - # number of slides in the presentation, inclusive. + # The index where the slides should be inserted, based on the slide arrangement + # before the move takes place. Must be between zero and the number of slides in + # the presentation, inclusive. # Corresponds to the JSON property `insertionIndex` # @return [Fixnum] attr_accessor :insertion_index - # The IDs of the slides in the presentation that should be moved. - # The slides in this list must be in existing presentation order, without - # duplicates. + # The IDs of the slides in the presentation that should be moved. The slides in + # this list must be in existing presentation order, without duplicates. # Corresponds to the JSON property `slideObjectIds` # @return [Array] attr_accessor :slide_object_ids @@ -4930,20 +4689,18 @@ module Google include Google::Apis::Core::Hashable # The border position in the table range the updates should apply to. If a - # border position is not specified, the updates will apply to all borders in - # the table range. + # border position is not specified, the updates will apply to all borders in the + # table range. # Corresponds to the JSON property `borderPosition` # @return [String] attr_accessor :border_position - # The fields that should be updated. - # At least one field must be specified. The root `tableBorderProperties` is - # implied and should not be specified. A single `"*"` can be used as - # short-hand for listing every field. - # For example to update the table border solid fill color, set - # `fields` to `"tableBorderFill.solidFill.color"`. - # To reset a property to its default value, include its field name in the - # field mask but leave the field itself unset. + # The fields that should be updated. At least one field must be specified. The + # root `tableBorderProperties` is implied and should not be specified. A single ` + # "*"` can be used as short-hand for listing every field. For example to update + # the table border solid fill color, set `fields` to `"tableBorderFill.solidFill. + # color"`. To reset a property to its default value, include its field name in + # the field mask but leave the field itself unset. # Corresponds to the JSON property `fields` # @return [String] attr_accessor :fields @@ -4953,23 +4710,17 @@ module Google # @return [String] attr_accessor :object_id_prop - # The border styling properties of the - # TableBorderCell. + # The border styling properties of the TableBorderCell. # Corresponds to the JSON property `tableBorderProperties` # @return [Google::Apis::SlidesV1::TableBorderProperties] attr_accessor :table_border_properties - # A table range represents a reference to a subset of a table. - # It's important to note that the cells specified by a table range do not - # necessarily form a rectangle. For example, let's say we have a 3 x 3 table - # where all the cells of the last row are merged together. The table looks - # like this: - # - # [ ] - # A table range with location = (0, 0), row span = 3 and column span = 2 - # specifies the following cells: - # x x - # [ x x x ] + # A table range represents a reference to a subset of a table. It's important to + # note that the cells specified by a table range do not necessarily form a + # rectangle. For example, let's say we have a 3 x 3 table where all the cells of + # the last row are merged together. The table looks like this: [ ] A table range + # with location = (0, 0), row span = 3 and column span = 2 specifies the + # following cells: x x [ x x x ] # Corresponds to the JSON property `tableRange` # @return [Google::Apis::SlidesV1::TableRange] attr_accessor :table_range @@ -4992,14 +4743,13 @@ module Google class UpdateTableCellPropertiesRequest include Google::Apis::Core::Hashable - # The fields that should be updated. - # At least one field must be specified. The root `tableCellProperties` is - # implied and should not be specified. A single `"*"` can be used as - # short-hand for listing every field. - # For example to update the table cell background solid fill color, set - # `fields` to `"tableCellBackgroundFill.solidFill.color"`. - # To reset a property to its default value, include its field name in the - # field mask but leave the field itself unset. + # The fields that should be updated. At least one field must be specified. The + # root `tableCellProperties` is implied and should not be specified. A single `"* + # "` can be used as short-hand for listing every field. For example to update + # the table cell background solid fill color, set `fields` to `" + # tableCellBackgroundFill.solidFill.color"`. To reset a property to its default + # value, include its field name in the field mask but leave the field itself + # unset. # Corresponds to the JSON property `fields` # @return [String] attr_accessor :fields @@ -5014,17 +4764,12 @@ module Google # @return [Google::Apis::SlidesV1::TableCellProperties] attr_accessor :table_cell_properties - # A table range represents a reference to a subset of a table. - # It's important to note that the cells specified by a table range do not - # necessarily form a rectangle. For example, let's say we have a 3 x 3 table - # where all the cells of the last row are merged together. The table looks - # like this: - # - # [ ] - # A table range with location = (0, 0), row span = 3 and column span = 2 - # specifies the following cells: - # x x - # [ x x x ] + # A table range represents a reference to a subset of a table. It's important to + # note that the cells specified by a table range do not necessarily form a + # rectangle. For example, let's say we have a 3 x 3 table where all the cells of + # the last row are merged together. The table looks like this: [ ] A table range + # with location = (0, 0), row span = 3 and column span = 2 specifies the + # following cells: x x [ x x x ] # Corresponds to the JSON property `tableRange` # @return [Google::Apis::SlidesV1::TableRange] attr_accessor :table_range @@ -5052,13 +4797,12 @@ module Google # @return [Array] attr_accessor :column_indices - # The fields that should be updated. - # At least one field must be specified. The root `tableColumnProperties` is - # implied and should not be specified. A single `"*"` can be used as - # short-hand for listing every field. - # For example to update the column width, set `fields` to `"column_width"`. - # If '"column_width"' is included in the field mask but the property is left - # unset, the column width will default to 406,400 EMU (32 points). + # The fields that should be updated. At least one field must be specified. The + # root `tableColumnProperties` is implied and should not be specified. A single ` + # "*"` can be used as short-hand for listing every field. For example to update + # the column width, set `fields` to `"column_width"`. If '"column_width"' is + # included in the field mask but the property is left unset, the column width + # will default to 406,400 EMU (32 points). # Corresponds to the JSON property `fields` # @return [String] attr_accessor :fields @@ -5090,14 +4834,12 @@ module Google class UpdateTableRowPropertiesRequest include Google::Apis::Core::Hashable - # The fields that should be updated. - # At least one field must be specified. The root `tableRowProperties` is - # implied and should not be specified. A single `"*"` can be used as - # short-hand for listing every field. - # For example to update the minimum row height, set `fields` to - # `"min_row_height"`. - # If '"min_row_height"' is included in the field mask but the property is - # left unset, the minimum row height will default to 0. + # The fields that should be updated. At least one field must be specified. The + # root `tableRowProperties` is implied and should not be specified. A single `"*" + # ` can be used as short-hand for listing every field. For example to update the + # minimum row height, set `fields` to `"min_row_height"`. If '"min_row_height"' + # is included in the field mask but the property is left unset, the minimum row + # height will default to 0. # Corresponds to the JSON property `fields` # @return [String] attr_accessor :fields @@ -5107,8 +4849,8 @@ module Google # @return [String] attr_accessor :object_id_prop - # The list of zero-based indices specifying which rows to update. If no - # indices are provided, all rows in the table will be updated. + # The list of zero-based indices specifying which rows to update. If no indices + # are provided, all rows in the table will be updated. # Corresponds to the JSON property `rowIndices` # @return [Array] attr_accessor :row_indices @@ -5131,8 +4873,7 @@ module Google end end - # Update the styling of text in a Shape or - # Table. + # Update the styling of text in a Shape or Table. class UpdateTextStyleRequest include Google::Apis::Core::Hashable @@ -5141,13 +4882,12 @@ module Google # @return [Google::Apis::SlidesV1::TableCellLocation] attr_accessor :cell_location - # The fields that should be updated. - # At least one field must be specified. The root `style` is implied and - # should not be specified. A single `"*"` can be used as short-hand for - # listing every field. - # For example, to update the text style to bold, set `fields` to `"bold"`. - # To reset a property to its default value, include its field name in the - # field mask but leave the field itself unset. + # The fields that should be updated. At least one field must be specified. The + # root `style` is implied and should not be specified. A single `"*"` can be + # used as short-hand for listing every field. For example, to update the text + # style to bold, set `fields` to `"bold"`. To reset a property to its default + # value, include its field name in the field mask but leave the field itself + # unset. # Corresponds to the JSON property `fields` # @return [String] attr_accessor :fields @@ -5157,21 +4897,18 @@ module Google # @return [String] attr_accessor :object_id_prop - # Represents the styling that can be applied to a TextRun. - # If this text is contained in a shape with a parent placeholder, then these - # text styles may be + # Represents the styling that can be applied to a TextRun. If this text is + # contained in a shape with a parent placeholder, then these text styles may be # inherited from the parent. Which text styles are inherited depend on the - # nesting level of lists: - # * A text run in a paragraph that is not in a list will inherit its text style - # from the the newline character in the paragraph at the 0 nesting level of - # the list inside the parent placeholder. - # * A text run in a paragraph that is in a list will inherit its text style - # from the newline character in the paragraph at its corresponding nesting - # level of the list inside the parent placeholder. - # Inherited text styles are represented as unset fields in this message. If - # text is contained in a shape without a parent placeholder, unsetting these - # fields will revert the style to a value matching the defaults in the Slides - # editor. + # nesting level of lists: * A text run in a paragraph that is not in a list will + # inherit its text style from the the newline character in the paragraph at the + # 0 nesting level of the list inside the parent placeholder. * A text run in a + # paragraph that is in a list will inherit its text style from the newline + # character in the paragraph at its corresponding nesting level of the list + # inside the parent placeholder. Inherited text styles are represented as unset + # fields in this message. If text is contained in a shape without a parent + # placeholder, unsetting these fields will revert the style to a value matching + # the defaults in the Slides editor. # Corresponds to the JSON property `style` # @return [Google::Apis::SlidesV1::TextStyle] attr_accessor :style @@ -5200,14 +4937,12 @@ module Google class UpdateVideoPropertiesRequest include Google::Apis::Core::Hashable - # The fields that should be updated. - # At least one field must be specified. The root `videoProperties` is - # implied and should not be specified. A single `"*"` can be used as - # short-hand for listing every field. - # For example to update the video outline color, set `fields` to - # `"outline.outlineFill.solidFill.color"`. - # To reset a property to its default value, include its field name in the - # field mask but leave the field itself unset. + # The fields that should be updated. At least one field must be specified. The + # root `videoProperties` is implied and should not be specified. A single `"*"` + # can be used as short-hand for listing every field. For example to update the + # video outline color, set `fields` to `"outline.outlineFill.solidFill.color"`. + # To reset a property to its default value, include its field name in the field + # mask but leave the field itself unset. # Corresponds to the JSON property `fields` # @return [String] attr_accessor :fields @@ -5234,8 +4969,7 @@ module Google end end - # A PageElement kind representing a - # video. + # A PageElement kind representing a video. class Video include Google::Apis::Core::Hashable @@ -5277,18 +5011,17 @@ module Google class VideoProperties include Google::Apis::Core::Hashable - # Whether to enable video autoplay when the page is displayed in present - # mode. Defaults to false. + # Whether to enable video autoplay when the page is displayed in present mode. + # Defaults to false. # Corresponds to the JSON property `autoPlay` # @return [Boolean] attr_accessor :auto_play alias_method :auto_play?, :auto_play - # The time at which to end playback, measured in seconds from the beginning - # of the video. - # If set, the end time should be after the start time. - # If not set or if you set this to a value that exceeds the video's length, - # the video will be played until its end. + # The time at which to end playback, measured in seconds from the beginning of + # the video. If set, the end time should be after the start time. If not set or + # if you set this to a value that exceeds the video's length, the video will be + # played until its end. # Corresponds to the JSON property `end` # @return [Fixnum] attr_accessor :end @@ -5299,21 +5032,19 @@ module Google attr_accessor :mute alias_method :mute?, :mute - # The outline of a PageElement. - # If these fields are unset, they may be inherited from a parent placeholder - # if it exists. If there is no parent, the fields will default to the value - # used for new page elements created in the Slides editor, which may depend on - # the page element kind. + # The outline of a PageElement. If these fields are unset, they may be inherited + # from a parent placeholder if it exists. If there is no parent, the fields will + # default to the value used for new page elements created in the Slides editor, + # which may depend on the page element kind. # Corresponds to the JSON property `outline` # @return [Google::Apis::SlidesV1::Outline] attr_accessor :outline - # The time at which to start playback, measured in seconds from the beginning - # of the video. - # If set, the start time should be before the end time. - # If you set this to a value that exceeds the video's length in seconds, the - # video will be played from the last second. - # If not set, the video will be played from the beginning. + # The time at which to start playback, measured in seconds from the beginning of + # the video. If set, the start time should be before the end time. If you set + # this to a value that exceeds the video's length in seconds, the video will be + # played from the last second. If not set, the video will be played from the + # beginning. # Corresponds to the JSON property `start` # @return [Fixnum] attr_accessor :start @@ -5336,22 +5067,19 @@ module Google class WeightedFontFamily include Google::Apis::Core::Hashable - # The font family of the text. - # The font family can be any font from the Font menu in Slides or from - # [Google Fonts] (https://fonts.google.com/). If the font name is - # unrecognized, the text is rendered in `Arial`. + # The font family of the text. The font family can be any font from the Font + # menu in Slides or from [Google Fonts] (https://fonts.google.com/). If the font + # name is unrecognized, the text is rendered in `Arial`. # Corresponds to the JSON property `fontFamily` # @return [String] attr_accessor :font_family # The rendered weight of the text. This field can have any value that is a - # multiple of `100` between `100` and `900`, inclusive. This range - # corresponds to the numerical values described in the CSS 2.1 - # Specification, - # [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), - # with non-numerical values disallowed. Weights greater than or equal to - # `700` are considered bold, and weights less than `700`are not bold. The - # default value is `400` ("normal"). + # multiple of `100` between `100` and `900`, inclusive. This range corresponds + # to the numerical values described in the CSS 2.1 Specification, [section 15.6]( + # https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical + # values disallowed. Weights greater than or equal to `700` are considered bold, + # and weights less than `700`are not bold. The default value is `400` ("normal"). # Corresponds to the JSON property `weight` # @return [Fixnum] attr_accessor :weight @@ -5367,8 +5095,7 @@ module Google end end - # A PageElement kind representing - # word art. + # A PageElement kind representing word art. class WordArt include Google::Apis::Core::Hashable diff --git a/generated/google/apis/slides_v1/service.rb b/generated/google/apis/slides_v1/service.rb index 61368a36b..485de2116 100644 --- a/generated/google/apis/slides_v1/service.rb +++ b/generated/google/apis/slides_v1/service.rb @@ -47,23 +47,19 @@ module Google @batch_path = 'batch' end - # Applies one or more updates to the presentation. - # Each request is validated before - # being applied. If any request is not valid, then the entire request will - # fail and nothing will be applied. - # Some requests have replies to - # give you some information about how they are applied. Other requests do - # not need to return information; these each return an empty reply. - # The order of replies matches that of the requests. - # For example, suppose you call batchUpdate with four updates, and only the - # third one returns information. The response would have two empty replies: - # the reply to the third request, and another empty reply, in that order. - # Because other users may be editing the presentation, the presentation - # might not exactly reflect your changes: your changes may - # be altered with respect to collaborator changes. If there are no - # collaborators, the presentation should reflect your changes. In any case, - # the updates in your request are guaranteed to be applied together - # atomically. + # Applies one or more updates to the presentation. Each request is validated + # before being applied. If any request is not valid, then the entire request + # will fail and nothing will be applied. Some requests have replies to give you + # some information about how they are applied. Other requests do not need to + # return information; these each return an empty reply. The order of replies + # matches that of the requests. For example, suppose you call batchUpdate with + # four updates, and only the third one returns information. The response would + # have two empty replies: the reply to the third request, and another empty + # reply, in that order. Because other users may be editing the presentation, the + # presentation might not exactly reflect your changes: your changes may be + # altered with respect to collaborator changes. If there are no collaborators, + # the presentation should reflect your changes. In any case, the updates in your + # request are guaranteed to be applied together atomically. # @param [String] presentation_id # The presentation to apply the updates to. # @param [Google::Apis::SlidesV1::BatchUpdatePresentationRequest] batch_update_presentation_request_object @@ -96,11 +92,10 @@ module Google execute_or_queue_command(command, &block) end - # 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. - # Otherwise, a new ID is generated. Other fields in the request, including - # any provided content, are ignored. - # Returns the created presentation. + # 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. + # Otherwise, a new ID is generated. Other fields in the request, including any + # provided content, are ignored. Returns the created presentation. # @param [Google::Apis::SlidesV1::Presentation] presentation_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -194,20 +189,18 @@ module Google end # Generates a thumbnail of the latest version of the specified page in the - # presentation and returns a URL to the thumbnail image. - # This request counts as an [expensive read request](/slides/limits) for - # quota purposes. + # presentation and returns a URL to the thumbnail image. This request counts as + # an [expensive read request](/slides/limits) for quota purposes. # @param [String] presentation_id # The ID of the presentation to retrieve. # @param [String] page_object_id # The object ID of the page whose thumbnail to retrieve. # @param [String] thumbnail_properties_mime_type - # The optional mime type of the thumbnail image. - # If you don't specify the mime type, the mime type defaults to PNG. + # The optional mime type of the thumbnail image. If you don't specify the mime + # type, the mime type defaults to PNG. # @param [String] thumbnail_properties_thumbnail_size - # The optional thumbnail image size. - # If you don't specify the size, the server chooses a default size of the - # image. + # The optional thumbnail image size. If you don't specify the size, the server + # chooses a default size of the image. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user diff --git a/generated/google/apis/streetviewpublish_v1.rb b/generated/google/apis/streetviewpublish_v1.rb index 8eed990de..2645a4707 100644 --- a/generated/google/apis/streetviewpublish_v1.rb +++ b/generated/google/apis/streetviewpublish_v1.rb @@ -27,7 +27,7 @@ module Google # @see https://developers.google.com/streetview/publish/ module StreetviewpublishV1 VERSION = 'V1' - REVISION = '20200224' + REVISION = '20200809' # Publish and manage your 360 photos on Google Street View AUTH_STREETVIEWPUBLISH = 'https://www.googleapis.com/auth/streetviewpublish' diff --git a/generated/google/apis/streetviewpublish_v1/classes.rb b/generated/google/apis/streetviewpublish_v1/classes.rb index 550da2ad4..8000aaeb2 100644 --- a/generated/google/apis/streetviewpublish_v1/classes.rb +++ b/generated/google/apis/streetviewpublish_v1/classes.rb @@ -26,9 +26,8 @@ module Google class BatchDeletePhotosRequest include Google::Apis::Core::Hashable - # Required. IDs of the Photos. HTTP - # GET requests require the following syntax for the URL query parameter: - # `photoIds=&photoIds=&...`. + # Required. IDs of the Photos. HTTP GET requests require the following syntax + # for the URL query parameter: `photoIds=&photoIds=&...`. # Corresponds to the JSON property `photoIds` # @return [Array] attr_accessor :photo_ids @@ -43,13 +42,11 @@ module Google end end - # Response to batch delete of one or more - # Photos. + # Response to batch delete of one or more Photos. class BatchDeletePhotosResponse include Google::Apis::Core::Hashable - # The status for the operation to delete a single - # Photo in the batch request. + # The status for the operation to delete a single Photo in the batch request. # Corresponds to the JSON property `status` # @return [Array] attr_accessor :status @@ -68,10 +65,8 @@ module Google class BatchGetPhotosResponse include Google::Apis::Core::Hashable - # List of results for each individual - # Photo requested, in the same order as - # the requests in - # BatchGetPhotos. + # List of results for each individual Photo requested, in the same order as the + # requests in BatchGetPhotos. # Corresponds to the JSON property `results` # @return [Array] attr_accessor :results @@ -86,13 +81,12 @@ module Google end end - # Request to update the metadata of photos. - # Updating the pixels of photos is not supported. + # Request to update the metadata of photos. Updating the pixels of photos is not + # supported. class BatchUpdatePhotosRequest include Google::Apis::Core::Hashable - # Required. List of - # UpdatePhotoRequests. + # Required. List of UpdatePhotoRequests. # Corresponds to the JSON property `updatePhotoRequests` # @return [Array] attr_accessor :update_photo_requests @@ -107,14 +101,12 @@ module Google end end - # Response to batch update of metadata of one or more - # Photos. + # Response to batch update of metadata of one or more Photos. class BatchUpdatePhotosResponse include Google::Apis::Core::Hashable - # List of results for each individual - # Photo updated, in the same order as - # the request. + # List of results for each individual Photo updated, in the same order as the + # request. # Corresponds to the JSON property `results` # @return [Array] attr_accessor :results @@ -148,13 +140,11 @@ module Google end end - # A generic empty message that you can re-use to avoid defining duplicated - # empty messages in your APIs. A typical example is to use it as the request - # or the response type of an API method. For instance: - # service Foo ` - # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); - # ` - # The JSON representation for `Empty` is empty JSON object ````. + # A generic empty message that you can re-use to avoid defining duplicated empty + # messages in your APIs. A typical example is to use it as the request or the + # response type of an API method. For instance: service Foo ` rpc Bar(google. + # protobuf.Empty) returns (google.protobuf.Empty); ` The JSON representation for + # `Empty` is empty JSON object ````. class Empty include Google::Apis::Core::Hashable @@ -169,9 +159,8 @@ module Google # An object representing a latitude/longitude pair. This is expressed as a pair # of doubles representing degrees latitude and degrees longitude. Unless - # specified otherwise, this must conform to the - # WGS84 - # standard. Values must be within normalized ranges. + # specified otherwise, this must conform to the WGS84 standard. Values must be + # within normalized ranges. class LatLng include Google::Apis::Core::Hashable @@ -200,16 +189,16 @@ module Google class Level include Google::Apis::Core::Hashable - # Required. A name assigned to this Level, restricted to 3 characters. - # Consider how the elevator buttons would be labeled for this level if there - # was an elevator. + # Required. A name assigned to this Level, restricted to 3 characters. Consider + # how the elevator buttons would be labeled for this level if there was an + # elevator. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Floor number, used for ordering. 0 indicates the ground level, 1 indicates - # the first level above ground level, -1 indicates the first level under - # ground level. Non-integer values are OK. + # Floor number, used for ordering. 0 indicates the ground level, 1 indicates the + # first level above ground level, -1 indicates the first level under ground + # level. Non-integer values are OK. # Corresponds to the JSON property `number` # @return [Float] attr_accessor :number @@ -235,9 +224,8 @@ module Google # @return [String] attr_accessor :next_page_token - # List of photos. The - # pageSize field - # in the request determines the number of items returned. + # List of photos. The pageSize field in the request determines the number of + # items returned. # Corresponds to the JSON property `photos` # @return [Array] attr_accessor :photos @@ -258,47 +246,45 @@ module Google class Operation include Google::Apis::Core::Hashable - # If the value is `false`, it means the operation is still in progress. - # If `true`, the operation is completed, and either `error` or `response` is - # available. + # If the value is `false`, it means the operation is still in progress. If `true` + # , the operation is completed, and either `error` or `response` is available. # Corresponds to the JSON property `done` # @return [Boolean] attr_accessor :done alias_method :done?, :done - # The `Status` type defines a logical error model that is suitable for - # different programming environments, including REST APIs and RPC APIs. It is - # used by [gRPC](https://github.com/grpc). Each `Status` message contains - # three pieces of data: error code, error message, and error details. - # You can find out more about this error model and how to work with it in the - # [API Design Guide](https://cloud.google.com/apis/design/errors). + # The `Status` type defines a logical error model that is suitable for different + # programming environments, including REST APIs and RPC APIs. It is used by [ + # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of + # data: error code, error message, and error details. You can find out more + # about this error model and how to work with it in the [API Design Guide](https: + # //cloud.google.com/apis/design/errors). # Corresponds to the JSON property `error` # @return [Google::Apis::StreetviewpublishV1::Status] attr_accessor :error - # Service-specific metadata associated with the operation. It typically - # contains progress information and common metadata such as create time. - # Some services might not provide such metadata. Any method that returns a - # long-running operation should document the metadata type, if any. + # Service-specific metadata associated with the operation. It typically contains + # progress information and common metadata such as create time. Some services + # might not provide such metadata. Any method that returns a long-running + # operation should document the metadata type, if any. # Corresponds to the JSON property `metadata` # @return [Hash] attr_accessor :metadata # The server-assigned name, which is only unique within the same service that - # originally returns it. If you use the default HTTP mapping, the - # `name` should be a resource name ending with `operations/`unique_id``. + # originally returns it. If you use the default HTTP mapping, the `name` should + # be a resource name ending with `operations/`unique_id``. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # The normal response of the operation in case of success. If the original - # method returns no data on success, such as `Delete`, the response is - # `google.protobuf.Empty`. If the original method is standard - # `Get`/`Create`/`Update`, the response should be the resource. For other - # methods, the response should have the type `XxxResponse`, where `Xxx` - # is the original method name. For example, if the original method name - # is `TakeSnapshot()`, the inferred response type is - # `TakeSnapshotResponse`. + # The normal response of the operation in case of success. If the original + # method returns no data on success, such as `Delete`, the response is `google. + # protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, + # the response should be the resource. For other methods, the response should + # have the type `XxxResponse`, where `Xxx` is the original method name. For + # example, if the original method name is `TakeSnapshot()`, the inferred + # response type is `TakeSnapshotResponse`. # Corresponds to the JSON property `response` # @return [Hash] attr_accessor :response @@ -321,24 +307,20 @@ module Google class Photo include Google::Apis::Core::Hashable - # Absolute time when the photo was captured. - # When the photo has no exif timestamp, this is used to set a timestamp in - # the photo metadata. + # Absolute time when the photo was captured. When the photo has no exif + # timestamp, this is used to set a timestamp in the photo metadata. # Corresponds to the JSON property `captureTime` # @return [String] attr_accessor :capture_time - # Connections to other photos. A connection represents the link from this - # photo to another photo. + # Connections to other photos. A connection represents the link from this photo + # to another photo. # Corresponds to the JSON property `connections` # @return [Array] attr_accessor :connections - # Output only. The download URL for the photo bytes. This field is set only - # when - # GetPhotoRequest.view - # is set to - # PhotoView.INCLUDE_DOWNLOAD_URL. + # Output only. The download URL for the photo bytes. This field is set only when + # GetPhotoRequest.view is set to PhotoView.INCLUDE_DOWNLOAD_URL. # Corresponds to the JSON property `downloadUrl` # @return [String] attr_accessor :download_url @@ -429,12 +411,8 @@ module Google end end - # Response payload for a single - # Photo - # in batch operations including - # BatchGetPhotos - # and - # BatchUpdatePhotos. + # Response payload for a single Photo in batch operations including + # BatchGetPhotos and BatchUpdatePhotos. class PhotoResponse include Google::Apis::Core::Hashable @@ -443,12 +421,12 @@ module Google # @return [Google::Apis::StreetviewpublishV1::Photo] attr_accessor :photo - # The `Status` type defines a logical error model that is suitable for - # different programming environments, including REST APIs and RPC APIs. It is - # used by [gRPC](https://github.com/grpc). Each `Status` message contains - # three pieces of data: error code, error message, and error details. - # You can find out more about this error model and how to work with it in the - # [API Design Guide](https://cloud.google.com/apis/design/errors). + # The `Status` type defines a logical error model that is suitable for different + # programming environments, including REST APIs and RPC APIs. It is used by [ + # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of + # data: error code, error message, and error details. You can find out more + # about this error model and how to work with it in the [API Design Guide](https: + # //cloud.google.com/apis/design/errors). # Corresponds to the JSON property `status` # @return [Google::Apis::StreetviewpublishV1::Status] attr_accessor :status @@ -468,8 +446,8 @@ module Google class Place include Google::Apis::Core::Hashable - # Output-only. The language_code that the name is localized with. This should - # be the language_code specified in the request, but may be a fallback. + # Output-only. The language_code that the name is localized with. This should be + # the language_code specified in the request, but may be a fallback. # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code @@ -479,8 +457,8 @@ module Google # @return [String] attr_accessor :name - # Place identifier, as described in - # https://developers.google.com/places/place-id. + # Place identifier, as described in https://developers.google.com/places/place- + # id. # Corresponds to the JSON property `placeId` # @return [String] attr_accessor :place_id @@ -501,35 +479,31 @@ module Google class Pose include Google::Apis::Core::Hashable - # The estimated horizontal accuracy of this pose in meters with 68% - # confidence (one standard deviation). For example, on Android, this value is - # available from this method: - # https://developer.android.com/reference/android/location/Location#getAccuracy() - # . - # Other platforms have different methods of obtaining similar accuracy - # estimations. + # The estimated horizontal accuracy of this pose in meters with 68% confidence ( + # one standard deviation). For example, on Android, this value is available from + # this method: https://developer.android.com/reference/android/location/Location# + # getAccuracy(). Other platforms have different methods of obtaining similar + # accuracy estimations. # Corresponds to the JSON property `accuracyMeters` # @return [Float] attr_accessor :accuracy_meters - # Altitude of the pose in meters above WGS84 ellipsoid. - # NaN indicates an unmeasured quantity. + # Altitude of the pose in meters above WGS84 ellipsoid. NaN indicates an + # unmeasured quantity. # Corresponds to the JSON property `altitude` # @return [Float] attr_accessor :altitude - # Compass heading, measured at the center of the photo in degrees clockwise - # from North. Value must be >=0 and <360. - # NaN indicates an unmeasured quantity. + # Compass heading, measured at the center of the photo in degrees clockwise from + # North. Value must be >=0 and <360. NaN indicates an unmeasured quantity. # Corresponds to the JSON property `heading` # @return [Float] attr_accessor :heading # An object representing a latitude/longitude pair. This is expressed as a pair # of doubles representing degrees latitude and degrees longitude. Unless - # specified otherwise, this must conform to the - # WGS84 - # standard. Values must be within normalized ranges. + # specified otherwise, this must conform to the WGS84 standard. Values must be + # within normalized ranges. # Corresponds to the JSON property `latLngPair` # @return [Google::Apis::StreetviewpublishV1::LatLng] attr_accessor :lat_lng_pair @@ -539,17 +513,15 @@ module Google # @return [Google::Apis::StreetviewpublishV1::Level] attr_accessor :level - # Pitch, measured at the center of the photo in degrees. Value must be >=-90 - # and <= 90. A value of -90 means looking directly down, and a value of 90 - # means looking directly up. - # NaN indicates an unmeasured quantity. + # Pitch, measured at the center of the photo in degrees. Value must be >=-90 and + # <= 90. A value of -90 means looking directly down, and a value of 90 means + # looking directly up. NaN indicates an unmeasured quantity. # Corresponds to the JSON property `pitch` # @return [Float] attr_accessor :pitch - # Roll, measured in degrees. Value must be >= 0 and <360. A value of 0 - # means level with the horizon. - # NaN indicates an unmeasured quantity. + # Roll, measured in degrees. Value must be >= 0 and <360. A value of 0 means + # level with the horizon. NaN indicates an unmeasured quantity. # Corresponds to the JSON property `roll` # @return [Float] attr_accessor :roll @@ -570,12 +542,12 @@ module Google end end - # The `Status` type defines a logical error model that is suitable for - # different programming environments, including REST APIs and RPC APIs. It is - # used by [gRPC](https://github.com/grpc). Each `Status` message contains - # three pieces of data: error code, error message, and error details. - # You can find out more about this error model and how to work with it in the - # [API Design Guide](https://cloud.google.com/apis/design/errors). + # The `Status` type defines a logical error model that is suitable for different + # programming environments, including REST APIs and RPC APIs. It is used by [ + # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of + # data: error code, error message, and error details. You can find out more + # about this error model and how to work with it in the [API Design Guide](https: + # //cloud.google.com/apis/design/errors). class Status include Google::Apis::Core::Hashable @@ -584,15 +556,15 @@ module Google # @return [Fixnum] attr_accessor :code - # A list of messages that carry the error details. There is a common set of + # A list of messages that carry the error details. There is a common set of # message types for APIs to use. # Corresponds to the JSON property `details` # @return [Array>] attr_accessor :details - # A developer-facing error message, which should be in English. Any - # user-facing error message should be localized and sent in the - # google.rpc.Status.details field, or localized by the client. + # A developer-facing error message, which should be in English. Any user-facing + # error message should be localized and sent in the google.rpc.Status.details + # field, or localized by the client. # Corresponds to the JSON property `message` # @return [String] attr_accessor :message @@ -609,9 +581,8 @@ module Google end end - # Request to update the metadata of a - # Photo. Updating the pixels of a photo - # is not supported. + # Request to update the metadata of a Photo. Updating the pixels of a photo is + # not supported. class UpdatePhotoRequest include Google::Apis::Core::Hashable @@ -620,28 +591,16 @@ module Google # @return [Google::Apis::StreetviewpublishV1::Photo] attr_accessor :photo - # Required. Mask that identifies fields on the photo metadata to update. - # If not present, the old Photo - # metadata is entirely replaced with the - # new Photo metadata in this request. - # The update fails if invalid fields are specified. Multiple fields can be - # specified in a comma-delimited list. - # The following fields are valid: - # * `pose.heading` - # * `pose.latLngPair` - # * `pose.pitch` - # * `pose.roll` - # * `pose.level` - # * `pose.altitude` - # * `connections` - # * `places` - #

+ # Required. Mask that identifies fields on the photo metadata to update. If not + # present, the old Photo metadata is entirely replaced with the new Photo + # metadata in this request. The update fails if invalid fields are specified. + # Multiple fields can be specified in a comma-delimited list. The following + # fields are valid: * `pose.heading` * `pose.latLngPair` * `pose.pitch` * `pose. + # roll` * `pose.level` * `pose.altitude` * `connections` * `places` *Note:* 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. # Corresponds to the JSON property `updateMask` # @return [String] attr_accessor :update_mask @@ -661,9 +620,8 @@ module Google class UploadRef include Google::Apis::Core::Hashable - # Required. An upload reference should be unique for each user. It follows - # the form: - # "https://streetviewpublish.googleapis.com/media/user/`account_id`/photo/` + # Required. An upload reference should be unique for each user. It follows the + # form: "https://streetviewpublish.googleapis.com/media/user/`account_id`/photo/` # upload_reference`" # Corresponds to the JSON property `uploadUrl` # @return [String] diff --git a/generated/google/apis/streetviewpublish_v1/service.rb b/generated/google/apis/streetviewpublish_v1/service.rb index acdb204c6..a6ee620f5 100644 --- a/generated/google/apis/streetviewpublish_v1/service.rb +++ b/generated/google/apis/streetviewpublish_v1/service.rb @@ -49,21 +49,16 @@ module Google @batch_path = 'batch' end - # After the client finishes uploading the photo with the returned - # UploadRef, - # CreatePhoto - # publishes the uploaded Photo to - # Street View on Google Maps. + # After the client finishes uploading the photo with the returned UploadRef, + # CreatePhoto publishes the uploaded Photo to Street View on Google Maps. # Currently, the only way to set heading, pitch, and roll in CreatePhoto is - # through the [Photo Sphere XMP - # metadata](https://developers.google.com/streetview/spherical-metadata) in - # the photo bytes. CreatePhoto ignores the `pose.heading`, `pose.pitch`, - # `pose.roll`, `pose.altitude`, and `pose.level` fields in Pose. - # This method returns the following error codes: - # * google.rpc.Code.INVALID_ARGUMENT if the request is malformed or if - # the uploaded photo is not a 360 photo. - # * google.rpc.Code.NOT_FOUND if the upload reference does not exist. - # * google.rpc.Code.RESOURCE_EXHAUSTED if the account has reached the + # through the [Photo Sphere XMP metadata](https://developers.google.com/ + # streetview/spherical-metadata) in the photo bytes. CreatePhoto ignores the ` + # pose.heading`, `pose.pitch`, `pose.roll`, `pose.altitude`, and `pose.level` + # fields in Pose. This method returns the following error codes: * google.rpc. + # Code.INVALID_ARGUMENT if the request is malformed or if the uploaded photo is + # not a 360 photo. * 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. # @param [Google::Apis::StreetviewpublishV1::Photo] photo_object # @param [String] fields @@ -94,11 +89,10 @@ module Google execute_or_queue_command(command, &block) end - # Deletes a Photo and its metadata. - # This method returns the following error codes: - # * 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 not exist. + # Deletes a Photo and its metadata. This method returns the following error + # codes: * 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 + # not exist. # @param [String] photo_id # Required. ID of the Photo. # @param [String] fields @@ -128,27 +122,21 @@ module Google execute_or_queue_command(command, &block) end - # Gets the metadata of the specified - # Photo. - # This method returns the following error codes: - # * google.rpc.Code.PERMISSION_DENIED if the requesting user did not - # create the requested Photo. - # * google.rpc.Code.NOT_FOUND if the requested - # Photo does not exist. - # * google.rpc.Code.UNAVAILABLE if the requested - # Photo is still being indexed. + # Gets the metadata of the specified Photo. This method returns the following + # error codes: * google.rpc.Code.PERMISSION_DENIED if the requesting user did + # not create the requested Photo. * 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 # Required. ID of the Photo. # @param [String] language_code - # The BCP-47 language code, such as "en-US" or "sr-Latn". For more - # information, see - # http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. - # If language_code is unspecified, the user's language preference for Google + # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, + # see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. If + # language_code is unspecified, the user's language preference for Google # services is used. # @param [String] view # Required. Specifies if a download URL for the photo bytes should be returned - # in the - # Photo response. + # in the Photo response. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -178,23 +166,17 @@ module Google execute_or_queue_command(command, &block) end - # Creates an upload session to start uploading photo bytes. The method uses - # the upload URL of the returned - # UploadRef to upload the bytes for - # the Photo. - # In addition to the photo requirements shown in - # https://support.google.com/maps/answer/7012050?hl=en&ref_topic=6275604, - # the photo must meet the following requirements: - # * Photo Sphere XMP metadata must be included in the photo metadata. See - # https://developers.google.com/streetview/spherical-metadata for the - # required fields. - # * The pixel size of the photo must meet the size requirements listed in - # 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. + # Creates an upload session to start uploading photo bytes. The method uses the + # upload URL of the returned UploadRef to upload the bytes for the Photo. In + # addition to the photo requirements shown in https://support.google.com/maps/ + # answer/7012050?hl=en&ref_topic=6275604, the photo must meet the following + # requirements: * Photo Sphere XMP metadata must be included in the photo + # metadata. See https://developers.google.com/streetview/spherical-metadata for + # the required fields. * The pixel size of the photo must meet the size + # requirements listed in 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 [String] fields # Selector specifying which fields to include in a partial response. @@ -224,46 +206,29 @@ module Google execute_or_queue_command(command, &block) end - # Updates the metadata of a Photo, such - # as pose, place association, connections, etc. Changing the pixels of a - # photo is not supported. - # Only the fields specified in the - # updateMask - # field are used. If `updateMask` is not present, the update applies to all - # fields. - # This method returns the following error codes: - # * google.rpc.Code.PERMISSION_DENIED if the requesting user did not - # 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. + # Updates the metadata of a Photo, such as pose, place association, connections, + # etc. Changing the pixels of a photo is not supported. Only the fields + # specified in the updateMask field are used. If `updateMask` is not present, + # the update applies to all fields. This method returns the following error + # codes: * google.rpc.Code.PERMISSION_DENIED if the requesting user did not + # 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 # Required. A unique identifier for a photo. # @param [Google::Apis::StreetviewpublishV1::Photo] photo_object # @param [String] update_mask - # Required. Mask that identifies fields on the photo metadata to update. - # If not present, the old Photo - # metadata is entirely replaced with the - # new Photo metadata in this request. - # The update fails if invalid fields are specified. Multiple fields can be - # specified in a comma-delimited list. - # The following fields are valid: - # * `pose.heading` - # * `pose.latLngPair` - # * `pose.pitch` - # * `pose.roll` - # * `pose.level` - # * `pose.altitude` - # * `connections` - # * `places` - # + # Required. Mask that identifies fields on the photo metadata to update. If not + # present, the old Photo metadata is entirely replaced with the new Photo + # metadata in this request. The update fails if invalid fields are specified. + # Multiple fields can be specified in a comma-delimited list. The following + # fields are valid: * `pose.heading` * `pose.latLngPair` * `pose.pitch` * `pose. + # roll` * `pose.level` * `pose.altitude` * `connections` * `places` *Note:* 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. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -294,21 +259,12 @@ module Google execute_or_queue_command(command, &block) end - # Deletes a list of Photos and their - # metadata. - # Note that if - # BatchDeletePhotos - # fails, either critical fields are missing or there is an authentication - # error. Even if - # 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. + # Deletes a list of Photos and their metadata. Note that if BatchDeletePhotos + # fails, either critical fields are missing or there is an authentication error. + # Even if 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 [String] fields # Selector specifying which fields to include in a partial response. @@ -338,35 +294,23 @@ module Google execute_or_queue_command(command, &block) end - # Gets the metadata of the specified - # Photo batch. - # Note that if - # BatchGetPhotos - # fails, either critical fields are missing or there is an authentication - # error. Even if - # 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. + # Gets the metadata of the specified Photo batch. Note that if BatchGetPhotos + # fails, either critical fields are missing or there is an authentication error. + # Even if 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 - # The BCP-47 language code, such as "en-US" or "sr-Latn". For more - # information, see - # http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. - # If language_code is unspecified, the user's language preference for Google + # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, + # see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. If + # language_code is unspecified, the user's language preference for Google # services is used. # @param [Array, String] photo_ids - # Required. IDs of the Photos. For HTTP - # GET requests, the URL query parameter should be - # `photoIds=&photoIds=&...`. + # Required. IDs of the Photos. For HTTP GET requests, the URL query parameter + # should be `photoIds=&photoIds=&...`. # @param [String] view # Required. Specifies if a download URL for the photo bytes should be returned - # in the - # Photo response. + # in the Photo response. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -396,35 +340,17 @@ module Google execute_or_queue_command(command, &block) end - # Updates the metadata of Photos, such - # as pose, place association, connections, etc. Changing the pixels of photos - # is not supported. - # Note that if - # BatchUpdatePhotos - # fails, either critical fields are missing or there is an authentication - # error. Even if - # BatchUpdatePhotos - # succeeds, individual photos in the batch may have failures. - # These failures are specified in each - # PhotoResponse.status - # 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. - # + # Updates the metadata of Photos, such as pose, place association, connections, + # etc. Changing the pixels of photos is not supported. Note that if + # BatchUpdatePhotos fails, either critical fields are missing or there is an + # authentication error. Even if BatchUpdatePhotos succeeds, individual photos in + # the batch may have failures. These failures are specified in each + # PhotoResponse.status 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. *Note:* To update Pose.altitude, + # Pose.latLngPair has to be filled as well. Otherwise, the request will fail. # @param [Google::Apis::StreetviewpublishV1::BatchUpdatePhotosRequest] batch_update_photos_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -454,36 +380,27 @@ module Google execute_or_queue_command(command, &block) end - # Lists all the Photos that belong to - # the user. - # + # Lists all the Photos that belong to the user. *Note:* Recently created photos + # that are still being indexed are not returned in the response. # @param [String] filter # Required. The filter expression. For example: `placeId= - # ChIJj61dQgK6j4AR4GeTYWZsKWw`. - # The only filter supported at the moment is `placeId`. + # ChIJj61dQgK6j4AR4GeTYWZsKWw`. The only filter supported at the moment is ` + # placeId`. # @param [String] language_code - # The BCP-47 language code, such as "en-US" or "sr-Latn". For more - # information, see - # http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. - # If language_code is unspecified, the user's language preference for Google + # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, + # see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. If + # language_code is unspecified, the user's language preference for Google # services is used. # @param [Fixnum] page_size - # The maximum number of photos to return. - # `pageSize` must be non-negative. If `pageSize` is zero or is not provided, - # 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 that belong to the user is less than `pageSize`. + # The maximum number of photos to return. `pageSize` must be non-negative. If ` + # pageSize` is zero or is not provided, 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 that belong to the user is less than `pageSize`. # @param [String] page_token - # The - # nextPageToken - # value returned from a previous - # ListPhotos - # request, if any. + # The nextPageToken value returned from a previous ListPhotos request, if any. # @param [String] view # Required. Specifies if a download URL for the photos bytes should be returned - # in the - # Photos response. + # in the Photos response. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user diff --git a/generated/google/apis/tasks_v1.rb b/generated/google/apis/tasks_v1.rb index c04a1c33e..bebd6755e 100644 --- a/generated/google/apis/tasks_v1.rb +++ b/generated/google/apis/tasks_v1.rb @@ -25,7 +25,7 @@ module Google # @see module TasksV1 VERSION = 'V1' - REVISION = '20200516' + REVISION = '20200809' # Create, edit, organize, and delete all your tasks AUTH_TASKS = 'https://www.googleapis.com/auth/tasks' diff --git a/generated/google/apis/tasks_v1/classes.rb b/generated/google/apis/tasks_v1/classes.rb index 5514ffde6..1eb5c4296 100644 --- a/generated/google/apis/tasks_v1/classes.rb +++ b/generated/google/apis/tasks_v1/classes.rb @@ -26,8 +26,8 @@ module Google class Task include Google::Apis::Core::Hashable - # Completion date of the task (as a RFC 3339 timestamp). This field is - # omitted if the task has not been completed. + # Completion date of the task (as a RFC 3339 timestamp). This field is omitted + # if the task has not been completed. # Corresponds to the JSON property `completed` # @return [String] attr_accessor :completed @@ -39,9 +39,9 @@ module Google alias_method :deleted?, :deleted # 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 - # when setting the due date. It isn't possible to read or write the time that - # a task is due via the API. + # records date information; the time portion of the timestamp is discarded when + # setting the due date. It isn't possible to read or write the time that a task + # is due via the API. # Corresponds to the JSON property `due` # @return [String] attr_accessor :due @@ -51,9 +51,9 @@ module Google # @return [String] attr_accessor :etag - # Flag indicating whether the task is hidden. This is the case if the task - # had been marked completed when the task list was last cleared. The default - # is False. This field is read-only. + # Flag indicating whether the task is hidden. This is the case if the task had + # been marked completed when the task list was last cleared. The default is + # False. This field is read-only. # Corresponds to the JSON property `hidden` # @return [Boolean] attr_accessor :hidden @@ -79,19 +79,19 @@ module Google # @return [String] attr_accessor :notes - # Parent task identifier. This field is omitted if it is a top-level task. - # This field is read-only. Use the "move" method to move the task under a - # different parent or to the top level. + # Parent task identifier. This field is omitted if it is a top-level task. This + # field is read-only. Use the "move" method to move the task under a different + # parent or to the top level. # Corresponds to the JSON property `parent` # @return [String] attr_accessor :parent - # String indicating the position of the task among its sibling tasks under - # the same parent task or at the top level. If this string is greater than - # another task's corresponding position string according to lexicographical - # ordering, the task is positioned after the other task under the same parent - # task (or at the top level). This field is read-only. Use the "move" method - # to move the task to another position. + # String indicating the position of the task among its sibling tasks under the + # same parent task or at the top level. If this string is greater than another + # task's corresponding position string according to lexicographical ordering, + # the task is positioned after the other task under the same parent task (or at + # the top level). This field is read-only. Use the "move" method to move the + # task to another position. # Corresponds to the JSON property `position` # @return [String] attr_accessor :position @@ -143,8 +143,7 @@ module Google class Link include Google::Apis::Core::Hashable - # The description. In HTML speak: Everything between <a> and - # </a>. + # The description. In HTML speak: Everything between and . # Corresponds to the JSON property `description` # @return [String] attr_accessor :description @@ -191,8 +190,8 @@ module Google # @return [String] attr_accessor :kind - # URL pointing to this task list. Used to retrieve, update, or delete this - # task list. + # URL pointing to this task list. Used to retrieve, update, or delete this task + # list. # Corresponds to the JSON property `selfLink` # @return [String] attr_accessor :self_link diff --git a/generated/google/apis/tasks_v1/service.rb b/generated/google/apis/tasks_v1/service.rb index b9a29df3d..2bf71a332 100644 --- a/generated/google/apis/tasks_v1/service.rb +++ b/generated/google/apis/tasks_v1/service.rb @@ -137,8 +137,8 @@ module Google # Returns all the authenticated user's task lists. # @param [Fixnum] max_results - # Maximum number of task lists returned on one page. Optional. The default is - # 20 (max allowed: 100). + # Maximum number of task lists returned on one page. Optional. The default is 20 + # (max allowed: 100). # @param [String] page_token # Token specifying the result page to return. Optional. # @param [String] fields @@ -338,8 +338,8 @@ module Google # Parent task identifier. If the task is created at the top level, this # parameter is omitted. Optional. # @param [String] previous - # Previous sibling task identifier. If the task is created at the first - # position among its siblings, this parameter is omitted. Optional. + # Previous sibling task identifier. If the task is created at the first position + # among its siblings, this parameter is omitted. Optional. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -375,11 +375,11 @@ module Google # @param [String] tasklist # Task list identifier. # @param [String] completed_max - # Upper bound for a task's completion date (as a RFC 3339 timestamp) to - # filter by. Optional. The default is not to filter by completion date. + # Upper bound for a task's completion date (as a RFC 3339 timestamp) to filter + # by. Optional. The default is not to filter by completion date. # @param [String] completed_min - # Lower bound for a task's completion date (as a RFC 3339 timestamp) to - # filter by. Optional. The default is not to filter by completion date. + # Lower bound for a task's completion date (as a RFC 3339 timestamp) to filter + # by. Optional. The default is not to filter by completion date. # @param [String] due_max # Upper bound for a task's due date (as a RFC 3339 timestamp) to filter by. # Optional. The default is not to filter by due date. @@ -387,23 +387,22 @@ module Google # Lower bound for a task's due date (as a RFC 3339 timestamp) to filter by. # Optional. The default is not to filter by due date. # @param [Fixnum] max_results - # Maximum number of task lists returned on one page. Optional. The default is - # 20 (max allowed: 100). + # Maximum number of task lists returned on one page. Optional. The default is 20 + # (max allowed: 100). # @param [String] page_token # Token specifying the result page to return. Optional. # @param [Boolean] show_completed - # Flag indicating whether completed tasks are returned in the result. - # Optional. The default is True. + # Flag indicating whether completed tasks are returned in the result. Optional. + # The default is True. # @param [Boolean] show_deleted # Flag indicating whether deleted tasks are returned in the result. Optional. # The default is False. # @param [Boolean] show_hidden - # Flag indicating whether hidden tasks are returned in the result. Optional. - # The default is False. + # Flag indicating whether hidden tasks are returned in the result. Optional. The + # default is False. # @param [String] updated_min - # Lower bound for a task's last modification time (as a RFC 3339 timestamp) - # to filter by. Optional. The default is not to filter by last modification - # time. + # Lower bound for a task's last modification time (as a RFC 3339 timestamp) to + # filter by. Optional. The default is not to filter by last modification time. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user diff --git a/generated/google/apis/translate_v3.rb b/generated/google/apis/translate_v3.rb index d97fd5188..c49a2c323 100644 --- a/generated/google/apis/translate_v3.rb +++ b/generated/google/apis/translate_v3.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/translate/docs/quickstarts module TranslateV3 VERSION = 'V3' - REVISION = '20200730' + REVISION = '20200807' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/translate_v3/classes.rb b/generated/google/apis/translate_v3/classes.rb index 45ab929e6..925acfa71 100644 --- a/generated/google/apis/translate_v3/classes.rb +++ b/generated/google/apis/translate_v3/classes.rb @@ -26,42 +26,38 @@ module Google class BatchTranslateTextRequest include Google::Apis::Core::Hashable - # Optional. Glossaries to be applied for translation. - # It's keyed by target language code. + # Optional. Glossaries to be applied for translation. It's keyed by target + # language code. # Corresponds to the JSON property `glossaries` # @return [Hash] attr_accessor :glossaries - # Required. Input configurations. - # The total number of files matched should be <= 1000. - # The total content size should be <= 100M Unicode codepoints. - # The files must use UTF-8 encoding. + # Required. Input configurations. The total number of files matched should be <= + # 1000. The total content size should be <= 100M Unicode codepoints. The files + # must use UTF-8 encoding. # Corresponds to the JSON property `inputConfigs` # @return [Array] attr_accessor :input_configs - # Optional. The labels with user-defined metadata for the request. - # Label keys and values can be no longer than 63 characters - # (Unicode codepoints), can only contain lowercase letters, numeric - # characters, underscores and dashes. International characters are allowed. - # Label values are optional. Label keys must start with a letter. - # See https://cloud.google.com/translate/docs/advanced/labels for more - # information. + # Optional. The labels with user-defined metadata for the request. Label keys + # and values can be no longer than 63 characters (Unicode codepoints), can only + # contain lowercase letters, numeric characters, underscores and dashes. + # International characters are allowed. Label values are optional. Label keys + # must start with a letter. See https://cloud.google.com/translate/docs/advanced/ + # labels for more information. # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels - # Optional. The models to use for translation. Map's key is target language - # code. Map's value is model name. Value can be a built-in general model, - # or an AutoML Translation model. - # The value format depends on model type: - # - AutoML Translation models: - # `projects/`project-number-or-id`/locations/`location-id`/models/`model-id`` - # - General (built-in) models: - # `projects/`project-number-or-id`/locations/`location-id`/models/general/nmt`, - # `projects/`project-number-or-id`/locations/`location-id`/models/general/base` - # If the map is empty or a specific model is - # not requested for a language pair, then default google model (nmt) is used. + # Optional. The models to use for translation. Map's key is target language code. + # Map's value is model name. Value can be a built-in general model, or an + # AutoML Translation model. The value format depends on model type: - AutoML + # Translation models: `projects/`project-number-or-id`/locations/`location-id`/ + # models/`model-id`` - General (built-in) models: `projects/`project-number-or- + # id`/locations/`location-id`/models/general/nmt`, `projects/`project-number-or- + # id`/locations/`location-id`/models/general/base` 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` # @return [Hash] attr_accessor :models @@ -119,31 +115,27 @@ module Google # @return [String] attr_accessor :content - # Optional. The labels with user-defined metadata for the request. - # Label keys and values can be no longer than 63 characters - # (Unicode codepoints), can only contain lowercase letters, numeric - # characters, underscores and dashes. International characters are allowed. - # Label values are optional. Label keys must start with a letter. - # See https://cloud.google.com/translate/docs/advanced/labels for more - # information. + # Optional. The labels with user-defined metadata for the request. Label keys + # and values can be no longer than 63 characters (Unicode codepoints), can only + # contain lowercase letters, numeric characters, underscores and dashes. + # International characters are allowed. Label values are optional. Label keys + # must start with a letter. See https://cloud.google.com/translate/docs/advanced/ + # labels for more information. # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels - # Optional. The format of the source text, for example, "text/html", - # "text/plain". If left blank, the MIME type defaults to "text/html". + # Optional. The format of the source text, for example, "text/html", "text/plain" + # . If left blank, the MIME type defaults to "text/html". # Corresponds to the JSON property `mimeType` # @return [String] attr_accessor :mime_type - # Optional. The language detection model to be used. - # Format: - # `projects/`project-number-or-id`/locations/`location-id`/models/language- - # detection/`model-id`` - # Only one language detection model is currently supported: - # `projects/`project-number-or-id`/locations/`location-id`/models/language- - # detection/default`. - # If not specified, the default model is used. + # Optional. The language detection model to be used. Format: `projects/`project- + # number-or-id`/locations/`location-id`/models/language-detection/`model-id`` + # Only one language detection model is currently supported: `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` # @return [String] attr_accessor :model @@ -207,13 +199,11 @@ module Google end end - # A generic empty message that you can re-use to avoid defining duplicated - # empty messages in your APIs. A typical example is to use it as the request - # or the response type of an API method. For instance: - # service Foo ` - # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); - # ` - # The JSON representation for `Empty` is empty JSON object ````. + # A generic empty message that you can re-use to avoid defining duplicated empty + # messages in your APIs. A typical example is to use it as the request or the + # response type of an API method. For instance: service Foo ` rpc Bar(google. + # protobuf.Empty) returns (google.protobuf.Empty); ` The JSON representation for + # `Empty` is empty JSON object ````. class Empty include Google::Apis::Core::Hashable @@ -231,8 +221,7 @@ module Google include Google::Apis::Core::Hashable # Required. The bucket used in 'output_uri_prefix' must exist and there must be - # no - # files under 'output_uri_prefix'. 'output_uri_prefix' must end with "/" and + # no 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 # translation job at a time. Otherwise an INVALID_ARGUMENT (400) error is # returned. @@ -298,8 +287,8 @@ module Google # @return [Google::Apis::TranslateV3::LanguageCodePair] attr_accessor :language_pair - # Required. The resource name of the glossary. Glossary names have the form - # `projects/`project-number-or-id`/locations/`location-id`/glossaries/`glossary- + # Required. The resource name of the glossary. Glossary names have the form ` + # projects/`project-number-or-id`/locations/`location-id`/glossaries/`glossary- # id``. # Corresponds to the JSON property `name` # @return [String] @@ -354,9 +343,8 @@ module Google # @return [Google::Apis::TranslateV3::GcsSource] attr_accessor :gcs_source - # Optional. Can be "text/plain" or "text/html". - # For `.tsv`, "text/html" is used if mime_type is missing. - # For `.html`, this field must be "text/html" or empty. + # Optional. Can be "text/plain" or "text/html". For `.tsv`, "text/html" is used + # if mime_type is missing. For `.html`, this field must be "text/html" or empty. # For `.txt`, this field must be "text/plain" or empty. # Corresponds to the JSON property `mimeType` # @return [String] @@ -377,14 +365,14 @@ module Google class LanguageCodePair include Google::Apis::Core::Hashable - # Required. The BCP-47 language code of the input text, for example, - # "en-US". Expected to be an exact match for GlossaryTerm.language_code. + # Required. The BCP-47 language code of the input text, for example, "en-US". + # Expected to be an exact match for GlossaryTerm.language_code. # Corresponds to the JSON property `sourceLanguageCode` # @return [String] attr_accessor :source_language_code - # Required. The BCP-47 language code for translation output, for example, - # "zh-CN". Expected to be an exact match for GlossaryTerm.language_code. + # Required. The BCP-47 language code for translation output, for example, "zh-CN" + # . Expected to be an exact match for GlossaryTerm.language_code. # Corresponds to the JSON property `targetLanguageCode` # @return [String] attr_accessor :target_language_code @@ -404,9 +392,9 @@ module Google class LanguageCodesSet include Google::Apis::Core::Hashable - # The BCP-47 language code(s) for terms defined in the glossary. - # All entries are unique. The list contains at least two entries. - # Expected to be an exact match for GlossaryTerm.language_code. + # The BCP-47 language code(s) for terms defined in the glossary. All entries are + # unique. The list contains at least two entries. Expected to be an exact match + # for GlossaryTerm.language_code. # Corresponds to the JSON property `languageCodes` # @return [Array] attr_accessor :language_codes @@ -430,9 +418,9 @@ module Google # @return [Array] attr_accessor :glossaries - # A token to retrieve a page of results. Pass this value in the - # [ListGlossariesRequest.page_token] field in the subsequent call to - # `ListGlossaries` method to retrieve the next page of results. + # A token to retrieve a page of results. Pass this value in the [ + # ListGlossariesRequest.page_token] field in the subsequent call to ` + # ListGlossaries` method to retrieve the next page of results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -502,14 +490,14 @@ module Google class Location include Google::Apis::Core::Hashable - # The friendly name for this location, typically a nearby city name. - # For example, "Tokyo". + # The friendly name for this location, typically a nearby city name. For example, + # "Tokyo". # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name - # Cross-service attributes for the location. For example - # `"cloud.googleapis.com/region": "us-east1"` + # Cross-service attributes for the location. For example `"cloud.googleapis.com/ + # region": "us-east1"` # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels @@ -525,8 +513,8 @@ module Google # @return [Hash] attr_accessor :metadata - # Resource name for the location, which may vary between implementations. - # For example: `"projects/example-project/locations/us-east1"` + # Resource name for the location, which may vary between implementations. For + # example: `"projects/example-project/locations/us-east1"` # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -550,47 +538,45 @@ module Google class Operation include Google::Apis::Core::Hashable - # If the value is `false`, it means the operation is still in progress. - # If `true`, the operation is completed, and either `error` or `response` is - # available. + # If the value is `false`, it means the operation is still in progress. If `true` + # , the operation is completed, and either `error` or `response` is available. # Corresponds to the JSON property `done` # @return [Boolean] attr_accessor :done alias_method :done?, :done - # The `Status` type defines a logical error model that is suitable for - # different programming environments, including REST APIs and RPC APIs. It is - # used by [gRPC](https://github.com/grpc). Each `Status` message contains - # three pieces of data: error code, error message, and error details. - # You can find out more about this error model and how to work with it in the - # [API Design Guide](https://cloud.google.com/apis/design/errors). + # The `Status` type defines a logical error model that is suitable for different + # programming environments, including REST APIs and RPC APIs. It is used by [ + # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of + # data: error code, error message, and error details. You can find out more + # about this error model and how to work with it in the [API Design Guide](https: + # //cloud.google.com/apis/design/errors). # Corresponds to the JSON property `error` # @return [Google::Apis::TranslateV3::Status] attr_accessor :error - # Service-specific metadata associated with the operation. It typically - # contains progress information and common metadata such as create time. - # Some services might not provide such metadata. Any method that returns a - # long-running operation should document the metadata type, if any. + # Service-specific metadata associated with the operation. It typically contains + # progress information and common metadata such as create time. Some services + # might not provide such metadata. Any method that returns a long-running + # operation should document the metadata type, if any. # Corresponds to the JSON property `metadata` # @return [Hash] attr_accessor :metadata # The server-assigned name, which is only unique within the same service that - # originally returns it. If you use the default HTTP mapping, the - # `name` should be a resource name ending with `operations/`unique_id``. + # originally returns it. If you use the default HTTP mapping, the `name` should + # be a resource name ending with `operations/`unique_id``. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # The normal response of the operation in case of success. If the original - # method returns no data on success, such as `Delete`, the response is - # `google.protobuf.Empty`. If the original method is standard - # `Get`/`Create`/`Update`, the response should be the resource. For other - # methods, the response should have the type `XxxResponse`, where `Xxx` - # is the original method name. For example, if the original method name - # is `TakeSnapshot()`, the inferred response type is - # `TakeSnapshotResponse`. + # The normal response of the operation in case of success. If the original + # method returns no data on success, such as `Delete`, the response is `google. + # protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, + # the response should be the resource. For other methods, the response should + # have the type `XxxResponse`, where `Xxx` is the original method name. For + # example, if the original method name is `TakeSnapshot()`, the inferred + # response type is `TakeSnapshotResponse`. # Corresponds to the JSON property `response` # @return [Hash] attr_accessor :response @@ -628,12 +614,12 @@ module Google end end - # The `Status` type defines a logical error model that is suitable for - # different programming environments, including REST APIs and RPC APIs. It is - # used by [gRPC](https://github.com/grpc). Each `Status` message contains - # three pieces of data: error code, error message, and error details. - # You can find out more about this error model and how to work with it in the - # [API Design Guide](https://cloud.google.com/apis/design/errors). + # The `Status` type defines a logical error model that is suitable for different + # programming environments, including REST APIs and RPC APIs. It is used by [ + # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of + # data: error code, error message, and error details. You can find out more + # about this error model and how to work with it in the [API Design Guide](https: + # //cloud.google.com/apis/design/errors). class Status include Google::Apis::Core::Hashable @@ -642,15 +628,15 @@ module Google # @return [Fixnum] attr_accessor :code - # A list of messages that carry the error details. There is a common set of + # A list of messages that carry the error details. There is a common set of # message types for APIs to use. # Corresponds to the JSON property `details` # @return [Array>] attr_accessor :details - # A developer-facing error message, which should be in English. Any - # user-facing error message should be localized and sent in the - # google.rpc.Status.details field, or localized by the client. + # A developer-facing error message, which should be in English. Any user-facing + # error message should be localized and sent in the google.rpc.Status.details + # field, or localized by the client. # Corresponds to the JSON property `message` # @return [String] attr_accessor :message @@ -667,8 +653,8 @@ module Google end end - # A single supported language response corresponds to information related - # to one supported language. + # A single supported language response corresponds to information related to one + # supported language. class SupportedLanguage include Google::Apis::Core::Hashable @@ -678,10 +664,9 @@ module Google # @return [String] attr_accessor :display_name - # Supported language code, generally consisting of its ISO 639-1 - # identifier, for example, 'en', 'ja'. In certain cases, BCP-47 codes - # including language and region identifiers are returned (for example, - # 'zh-TW' and 'zh-CN') + # Supported language code, generally consisting of its ISO 639-1 identifier, for + # example, 'en', 'ja'. In certain cases, BCP-47 codes including language and + # region identifiers are returned (for example, 'zh-TW' and 'zh-CN') # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code @@ -715,8 +700,8 @@ module Google class SupportedLanguages include Google::Apis::Core::Hashable - # A list of supported language responses. This list contains an entry - # for each language the Translation API supports. + # A list of supported language responses. This list contains an entry for each + # language the Translation API supports. # Corresponds to the JSON property `languages` # @return [Array] attr_accessor :languages @@ -731,22 +716,20 @@ module Google end end - # Configures which glossary should be used for a specific target language, - # and defines options for applying that glossary. + # Configures which glossary should be used for a specific target language, and + # defines options for applying that glossary. class TranslateTextGlossaryConfig include Google::Apis::Core::Hashable - # Required. The `glossary` to be applied for this translation. - # The format depends on glossary: - # - User provided custom glossary: - # `projects/`project-number-or-id`/locations/`location-id`/glossaries/` - # glossary-id`` + # Required. The `glossary` to be applied for this translation. The format + # depends on glossary: - User provided custom glossary: `projects/`project- + # number-or-id`/locations/`location-id`/glossaries/`glossary-id`` # Corresponds to the JSON property `glossary` # @return [String] attr_accessor :glossary - # Optional. Indicates match is case-insensitive. - # Default value is false if missing. + # Optional. Indicates match is case-insensitive. Default value is false if + # missing. # Corresponds to the JSON property `ignoreCase` # @return [Boolean] attr_accessor :ignore_case @@ -767,62 +750,57 @@ module Google class TranslateTextRequest include Google::Apis::Core::Hashable - # Required. The content of the input in string format. - # We recommend the total content be less than 30k codepoints. - # Use BatchTranslateText for larger text. + # Required. The content of the input in string format. We recommend the total + # content be less than 30k codepoints. Use BatchTranslateText for larger text. # Corresponds to the JSON property `contents` # @return [Array] attr_accessor :contents - # Configures which glossary should be used for a specific target language, - # and defines options for applying that glossary. + # Configures which glossary should be used for a specific target language, and + # defines options for applying that glossary. # Corresponds to the JSON property `glossaryConfig` # @return [Google::Apis::TranslateV3::TranslateTextGlossaryConfig] attr_accessor :glossary_config - # Optional. The labels with user-defined metadata for the request. - # Label keys and values can be no longer than 63 characters - # (Unicode codepoints), can only contain lowercase letters, numeric - # characters, underscores and dashes. International characters are allowed. - # Label values are optional. Label keys must start with a letter. - # See https://cloud.google.com/translate/docs/advanced/labels for more - # information. + # Optional. The labels with user-defined metadata for the request. Label keys + # and values can be no longer than 63 characters (Unicode codepoints), can only + # contain lowercase letters, numeric characters, underscores and dashes. + # International characters are allowed. Label values are optional. Label keys + # must start with a letter. See https://cloud.google.com/translate/docs/advanced/ + # labels for more information. # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels - # Optional. The format of the source text, for example, "text/html", - # "text/plain". If left blank, the MIME type defaults to "text/html". + # Optional. The format of the source text, for example, "text/html", "text/plain" + # . If left blank, the MIME type defaults to "text/html". # Corresponds to the JSON property `mimeType` # @return [String] attr_accessor :mime_type - # Optional. The `model` type requested for this translation. - # The format depends on model type: - # - AutoML Translation models: - # `projects/`project-number-or-id`/locations/`location-id`/models/`model-id`` - # - General (built-in) models: - # `projects/`project-number-or-id`/locations/`location-id`/models/general/nmt`, - # `projects/`project-number-or-id`/locations/`location-id`/models/general/base` - # For global (non-regionalized) requests, use `location-id` `global`. - # For example, - # `projects/`project-number-or-id`/locations/global/models/general/nmt`. + # Optional. The `model` type requested for this translation. The format depends + # on model type: - AutoML Translation models: `projects/`project-number-or-id`/ + # locations/`location-id`/models/`model-id`` - General (built-in) models: ` + # projects/`project-number-or-id`/locations/`location-id`/models/general/nmt`, ` + # projects/`project-number-or-id`/locations/`location-id`/models/general/base` + # 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. # Corresponds to the JSON property `model` # @return [String] attr_accessor :model - # Optional. The BCP-47 language code of the input text if - # known, for example, "en-US" or "sr-Latn". Supported language codes are - # listed in Language Support. If the source language isn't specified, the API - # attempts to identify the source language automatically and returns the - # source language within the response. + # Optional. The BCP-47 language code of the input text if known, for example, " + # en-US" or "sr-Latn". Supported language codes are listed in Language Support. + # If the source language isn't specified, the API attempts to identify the + # source language automatically and returns the source language within the + # response. # Corresponds to the JSON property `sourceLanguageCode` # @return [String] attr_accessor :source_language_code - # Required. The BCP-47 language code to use for translation of the input - # text, set to one of the language codes listed in Language Support. + # Required. The BCP-47 language code to use for translation of the input text, + # set to one of the language codes listed in Language Support. # Corresponds to the JSON property `targetLanguageCode` # @return [String] attr_accessor :target_language_code @@ -847,18 +825,15 @@ module Google class TranslateTextResponse include Google::Apis::Core::Hashable - # Text translation responses if a glossary is provided in the request. - # This can be the same as - # `translations` if no terms apply. - # This field has the same length as - # `contents`. + # Text translation responses if a glossary is provided in the request. This can + # be the same as `translations` if no terms apply. This field has the same + # length as `contents`. # Corresponds to the JSON property `glossaryTranslations` # @return [Array] attr_accessor :glossary_translations - # Text translation responses with no glossary applied. - # This field has the same length as - # `contents`. + # Text translation responses with no glossary applied. This field has the same + # length as `contents`. # Corresponds to the JSON property `translations` # @return [Array] attr_accessor :translations @@ -879,26 +854,24 @@ module Google include Google::Apis::Core::Hashable # The BCP-47 language code of source text in the initial request, detected - # automatically, if no source language was passed within the initial - # request. If the source language was passed, auto-detection of the language - # does not occur and this field is empty. + # automatically, if no source language was passed within the initial request. If + # the source language was passed, auto-detection of the language does not occur + # and this field is empty. # Corresponds to the JSON property `detectedLanguageCode` # @return [String] attr_accessor :detected_language_code - # Configures which glossary should be used for a specific target language, - # and defines options for applying that glossary. + # Configures which glossary should be used for a specific target language, and + # defines options for applying that glossary. # Corresponds to the JSON property `glossaryConfig` # @return [Google::Apis::TranslateV3::TranslateTextGlossaryConfig] attr_accessor :glossary_config - # Only present when `model` is present in the request. - # `model` here is normalized to have project number. - # For example: - # If the `model` requested in TranslationTextRequest is - # `projects/`project-id`/locations/`location-id`/models/general/nmt` then - # `model` here would be normalized to - # `projects/`project-number`/locations/`location-id`/models/general/nmt`. + # Only present when `model` is present in the request. `model` here is + # normalized to have project number. For example: If the `model` requested in + # TranslationTextRequest is `projects/`project-id`/locations/`location-id`/ + # models/general/nmt` then `model` here would be normalized to `projects/` + # project-number`/locations/`location-id`/models/general/nmt`. # Corresponds to the JSON property `model` # @return [String] attr_accessor :model @@ -925,9 +898,9 @@ module Google class WaitOperationRequest include Google::Apis::Core::Hashable - # The maximum duration to wait before timing out. If left blank, the wait - # will be at most the time permitted by the underlying HTTP/RPC protocol. - # If RPC context deadline is also specified, the shorter one will be used. + # The maximum duration to wait before timing out. If left blank, the wait will + # be at most the time permitted by the underlying HTTP/RPC protocol. If RPC + # context deadline is also specified, the shorter one will be used. # Corresponds to the JSON property `timeout` # @return [String] attr_accessor :timeout diff --git a/generated/google/apis/translate_v3/service.rb b/generated/google/apis/translate_v3/service.rb index 879e004e3..e37cf8db9 100644 --- a/generated/google/apis/translate_v3/service.rb +++ b/generated/google/apis/translate_v3/service.rb @@ -49,14 +49,12 @@ module Google # Detects the language of text within a request. # @param [String] parent - # Required. Project or location to make a call. Must refer to a caller's - # project. - # Format: `projects/`project-number-or-id`/locations/`location-id`` or - # `projects/`project-number-or-id``. - # For global calls, use `projects/`project-number-or-id`/locations/global` or - # `projects/`project-number-or-id``. - # Only models within the same region (has same location-id) can be used. - # Otherwise an INVALID_ARGUMENT (400) error is returned. + # Required. Project or location to make a call. Must refer to a caller's project. + # Format: `projects/`project-number-or-id`/locations/`location-id`` or ` + # projects/`project-number-or-id``. For global calls, use `projects/`project- + # number-or-id`/locations/global` or `projects/`project-number-or-id``. 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 [String] fields # Selector specifying which fields to include in a partial response. @@ -89,29 +87,25 @@ module Google # Returns a list of supported languages for translation. # @param [String] parent - # Required. Project or location to make a call. Must refer to a caller's - # project. - # Format: `projects/`project-number-or-id`` or - # `projects/`project-number-or-id`/locations/`location-id``. - # For global calls, use `projects/`project-number-or-id`/locations/global` or - # `projects/`project-number-or-id``. - # Non-global location is required for AutoML models. - # Only models within the same region (have same location-id) can be used, - # otherwise an INVALID_ARGUMENT (400) error is returned. + # Required. Project or location to make a call. Must refer to a caller's project. + # Format: `projects/`project-number-or-id`` or `projects/`project-number-or-id`/ + # locations/`location-id``. For global calls, use `projects/`project-number-or- + # id`/locations/global` or `projects/`project-number-or-id``. Non-global + # location is required for AutoML models. 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 - # Optional. The language to use to return localized, human readable names - # of supported languages. If missing, then display names are not returned - # in a response. + # Optional. The language to use to return localized, human readable names of + # supported languages. If missing, then display names are not returned in a + # response. # @param [String] model - # Optional. Get supported languages of this model. - # The format depends on model type: - # - AutoML Translation models: - # `projects/`project-number-or-id`/locations/`location-id`/models/`model-id`` - # - General (built-in) models: - # `projects/`project-number-or-id`/locations/`location-id`/models/general/nmt`, - # `projects/`project-number-or-id`/locations/`location-id`/models/general/base` - # Returns languages supported by the specified model. - # If missing, we get supported languages of Google general base (PBMT) model. + # Optional. Get supported languages of this model. The format depends on model + # type: - AutoML Translation models: `projects/`project-number-or-id`/locations/` + # location-id`/models/`model-id`` - General (built-in) models: `projects/` + # project-number-or-id`/locations/`location-id`/models/general/nmt`, `projects/` + # project-number-or-id`/locations/`location-id`/models/general/base` Returns + # languages supported by the specified model. If missing, we get supported + # languages of Google general base (PBMT) model. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -143,16 +137,13 @@ module Google # Translates input text and returns translated text. # @param [String] parent - # Required. Project or location to make a call. Must refer to a caller's - # project. - # Format: `projects/`project-number-or-id`` or - # `projects/`project-number-or-id`/locations/`location-id``. - # For global calls, use `projects/`project-number-or-id`/locations/global` or - # `projects/`project-number-or-id``. - # Non-global location is required for requests using AutoML models or - # custom glossaries. - # Models and glossaries must be within the same region (have same - # location-id), otherwise an INVALID_ARGUMENT (400) error is returned. + # Required. Project or location to make a call. Must refer to a caller's project. + # Format: `projects/`project-number-or-id`` or `projects/`project-number-or-id`/ + # locations/`location-id``. For global calls, use `projects/`project-number-or- + # id`/locations/global` or `projects/`project-number-or-id``. Non-global + # location is required for requests using AutoML models or 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 [String] fields # Selector specifying which fields to include in a partial response. @@ -183,19 +174,18 @@ module Google execute_or_queue_command(command, &block) end - # Translates a large volume of text in asynchronous batch mode. - # This function provides real-time output as the inputs are being processed. - # If caller cancels a request, the partial results (for an input file, it's - # all or nothing) may still be available on the specified output location. - # This call returns immediately and you can - # use google.longrunning.Operation.name to poll the status of the call. + # Translates a large volume of text in asynchronous batch mode. This function + # provides real-time output as the inputs are being processed. If caller cancels + # a request, the partial results (for an input file, it's all or nothing) may + # still be available on the specified output location. This call returns + # immediately and you can use google.longrunning.Operation.name to poll the + # status of the call. # @param [String] parent - # Required. Location to make a call. Must refer to a caller's project. - # Format: `projects/`project-number-or-id`/locations/`location-id``. - # The `global` location is not supported for batch translation. - # Only AutoML Translation models or glossaries within the same region (have - # the same location-id) can be used, otherwise an INVALID_ARGUMENT (400) - # error is returned. + # Required. Location to make a call. Must refer to a caller's project. Format: ` + # projects/`project-number-or-id`/locations/`location-id``. The `global` + # location is not supported for batch translation. Only AutoML Translation + # models or glossaries within the same region (have the same location-id) can be + # used, otherwise an INVALID_ARGUMENT (400) error is returned. # @param [Google::Apis::TranslateV3::BatchTranslateTextRequest] batch_translate_text_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -228,14 +218,12 @@ module Google # Detects the language of text within a request. # @param [String] parent - # Required. Project or location to make a call. Must refer to a caller's - # project. - # Format: `projects/`project-number-or-id`/locations/`location-id`` or - # `projects/`project-number-or-id``. - # For global calls, use `projects/`project-number-or-id`/locations/global` or - # `projects/`project-number-or-id``. - # Only models within the same region (has same location-id) can be used. - # Otherwise an INVALID_ARGUMENT (400) error is returned. + # Required. Project or location to make a call. Must refer to a caller's project. + # Format: `projects/`project-number-or-id`/locations/`location-id`` or ` + # projects/`project-number-or-id``. For global calls, use `projects/`project- + # number-or-id`/locations/global` or `projects/`project-number-or-id``. 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 [String] fields # Selector specifying which fields to include in a partial response. @@ -298,29 +286,25 @@ module Google # Returns a list of supported languages for translation. # @param [String] parent - # Required. Project or location to make a call. Must refer to a caller's - # project. - # Format: `projects/`project-number-or-id`` or - # `projects/`project-number-or-id`/locations/`location-id``. - # For global calls, use `projects/`project-number-or-id`/locations/global` or - # `projects/`project-number-or-id``. - # Non-global location is required for AutoML models. - # Only models within the same region (have same location-id) can be used, - # otherwise an INVALID_ARGUMENT (400) error is returned. + # Required. Project or location to make a call. Must refer to a caller's project. + # Format: `projects/`project-number-or-id`` or `projects/`project-number-or-id`/ + # locations/`location-id``. For global calls, use `projects/`project-number-or- + # id`/locations/global` or `projects/`project-number-or-id``. Non-global + # location is required for AutoML models. 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 - # Optional. The language to use to return localized, human readable names - # of supported languages. If missing, then display names are not returned - # in a response. + # Optional. The language to use to return localized, human readable names of + # supported languages. If missing, then display names are not returned in a + # response. # @param [String] model - # Optional. Get supported languages of this model. - # The format depends on model type: - # - AutoML Translation models: - # `projects/`project-number-or-id`/locations/`location-id`/models/`model-id`` - # - General (built-in) models: - # `projects/`project-number-or-id`/locations/`location-id`/models/general/nmt`, - # `projects/`project-number-or-id`/locations/`location-id`/models/general/base` - # Returns languages supported by the specified model. - # If missing, we get supported languages of Google general base (PBMT) model. + # Optional. Get supported languages of this model. The format depends on model + # type: - AutoML Translation models: `projects/`project-number-or-id`/locations/` + # location-id`/models/`model-id`` - General (built-in) models: `projects/` + # project-number-or-id`/locations/`location-id`/models/general/nmt`, `projects/` + # project-number-or-id`/locations/`location-id`/models/general/base` Returns + # languages supported by the specified model. If missing, we get supported + # languages of Google general base (PBMT) model. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -391,16 +375,13 @@ module Google # Translates input text and returns translated text. # @param [String] parent - # Required. Project or location to make a call. Must refer to a caller's - # project. - # Format: `projects/`project-number-or-id`` or - # `projects/`project-number-or-id`/locations/`location-id``. - # For global calls, use `projects/`project-number-or-id`/locations/global` or - # `projects/`project-number-or-id``. - # Non-global location is required for requests using AutoML models or - # custom glossaries. - # Models and glossaries must be within the same region (have same - # location-id), otherwise an INVALID_ARGUMENT (400) error is returned. + # Required. Project or location to make a call. Must refer to a caller's project. + # Format: `projects/`project-number-or-id`` or `projects/`project-number-or-id`/ + # locations/`location-id``. For global calls, use `projects/`project-number-or- + # id`/locations/global` or `projects/`project-number-or-id``. Non-global + # location is required for requests using AutoML models or 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 [String] fields # Selector specifying which fields to include in a partial response. @@ -431,8 +412,8 @@ module Google execute_or_queue_command(command, &block) end - # Creates a glossary and returns the long-running operation. Returns - # NOT_FOUND, if the project doesn't exist. + # Creates a glossary and returns the long-running operation. Returns NOT_FOUND, + # if the project doesn't exist. # @param [String] parent # Required. The project name. # @param [Google::Apis::TranslateV3::Glossary] glossary_object @@ -465,9 +446,8 @@ module Google execute_or_queue_command(command, &block) end - # Deletes a glossary, or cancels glossary construction - # if the glossary isn't created yet. - # Returns NOT_FOUND, if the glossary doesn't exist. + # Deletes a glossary, or cancels glossary construction if the glossary isn't + # created yet. Returns NOT_FOUND, if the glossary doesn't exist. # @param [String] name # Required. The name of the glossary to delete. # @param [String] fields @@ -497,8 +477,7 @@ module Google execute_or_queue_command(command, &block) end - # Gets a glossary. Returns NOT_FOUND, if the glossary doesn't - # exist. + # Gets a glossary. Returns NOT_FOUND, if the glossary doesn't exist. # @param [String] name # Required. The name of the glossary to retrieve. # @param [String] fields @@ -528,35 +507,32 @@ module Google execute_or_queue_command(command, &block) end - # Lists glossaries in a project. Returns NOT_FOUND, if the project doesn't - # exist. + # Lists glossaries in a project. Returns NOT_FOUND, if the project doesn't exist. # @param [String] parent # Required. The name of the project from which to list all of the glossaries. # @param [String] filter - # Optional. Filter specifying constraints of a list operation. - # Specify the constraint by the format of "key=value", where key must be - # "src" or "tgt", and the value must be a valid language code. - # For multiple restrictions, concatenate them by "AND" (uppercase only), - # such as: "src=en-US AND tgt=zh-CN". Notice that the exact match is used - # here, which means using 'en-US' and 'en' can lead to different results, - # which depends on the language code you used when you create the glossary. - # For the unidirectional glossaries, the "src" and "tgt" add restrictions - # on the source and target language code separately. - # For the equivalent term set glossaries, the "src" and/or "tgt" add - # restrictions on the term set. - # For example: "src=en-US AND tgt=zh-CN" will only pick the unidirectional - # glossaries which exactly match the source language code as "en-US" and the - # target language code "zh-CN", but all equivalent term set glossaries which - # contain "en-US" and "zh-CN" in their language set will be picked. - # If missing, no filtering is performed. + # Optional. Filter specifying constraints of a list operation. Specify the + # constraint by the format of "key=value", where key must be "src" or "tgt", and + # the value must be a valid language code. For multiple restrictions, + # concatenate them by "AND" (uppercase only), such as: "src=en-US AND tgt=zh-CN". + # Notice that the exact match is used here, which means using 'en-US' and 'en' + # can lead to different results, which depends on the language code you used + # when you create the glossary. For the unidirectional glossaries, the "src" and + # "tgt" add restrictions on the source and target language code separately. For + # the equivalent term set glossaries, the "src" and/or "tgt" add restrictions on + # the term set. For example: "src=en-US AND tgt=zh-CN" will only pick the + # unidirectional glossaries which exactly match the source language code as "en- + # US" and the target language code "zh-CN", but all equivalent term set + # glossaries which contain "en-US" and "zh-CN" in their language set will be + # picked. If missing, no filtering is performed. # @param [Fixnum] page_size # Optional. Requested page size. The server may return fewer glossaries than # requested. If unspecified, the server picks an appropriate default. # @param [String] page_token # Optional. A token identifying a page of results the server should return. # Typically, this is the value of [ListGlossariesResponse.next_page_token] - # returned from the previous call to `ListGlossaries` method. - # The first page is returned if `page_token`is empty or missing. + # returned from the previous call to `ListGlossaries` method. The first page is + # returned if `page_token`is empty or missing. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -587,15 +563,13 @@ module Google execute_or_queue_command(command, &block) end - # Starts asynchronous cancellation on a long-running operation. The server - # makes a best effort to cancel the operation, but success is not - # guaranteed. If the server doesn't support this method, it returns - # `google.rpc.Code.UNIMPLEMENTED`. Clients can use - # Operations.GetOperation or - # other methods to check whether the cancellation succeeded or whether the - # operation completed despite cancellation. On successful cancellation, - # the operation is not deleted; instead, it becomes an operation with - # an Operation.error value with a google.rpc.Status.code of 1, + # Starts asynchronous cancellation on a long-running operation. The server makes + # a best effort to cancel the operation, but success is not guaranteed. If the + # server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + # Clients can use Operations.GetOperation or other methods to check whether the + # cancellation succeeded or whether the operation completed despite cancellation. + # On successful cancellation, the operation is not deleted; instead, it becomes + # an operation with an Operation.error value with a google.rpc.Status.code of 1, # corresponding to `Code.CANCELLED`. # @param [String] name # The name of the operation resource to be cancelled. @@ -629,10 +603,10 @@ module Google execute_or_queue_command(command, &block) end - # Deletes a long-running operation. This method indicates that the client is - # no longer interested in the operation result. It does not cancel the - # operation. If the server doesn't support this method, it returns - # `google.rpc.Code.UNIMPLEMENTED`. + # Deletes a long-running operation. This method indicates that the client is no + # longer interested in the operation result. It does not cancel the operation. + # If the server doesn't support this method, it returns `google.rpc.Code. + # UNIMPLEMENTED`. # @param [String] name # The name of the operation resource to be deleted. # @param [String] fields @@ -662,9 +636,8 @@ module Google execute_or_queue_command(command, &block) end - # Gets the latest state of a long-running operation. Clients can use this - # method to poll the operation result at intervals as recommended by the API - # service. + # Gets the latest state of a long-running operation. Clients can use this method + # to poll the operation result at intervals as recommended by the API service. # @param [String] name # The name of the operation resource. # @param [String] fields @@ -694,15 +667,14 @@ module Google execute_or_queue_command(command, &block) end - # Lists operations that match the specified filter in the request. If the - # server doesn't support this method, it returns `UNIMPLEMENTED`. - # NOTE: the `name` binding allows API services to override the binding - # to use different resource name schemes, such as `users/*/operations`. To - # override the binding, API services can add a binding such as - # `"/v1/`name=users/*`/operations"` to their service configuration. - # For backwards compatibility, the default name includes the operations - # collection id, however overriding users must ensure the name binding - # is the parent resource, without the operations collection id. + # Lists operations that match the specified filter in the request. If the server + # doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` + # binding allows API services to override the binding to use different resource + # name schemes, such as `users/*/operations`. To override the binding, API + # services can add a binding such as `"/v1/`name=users/*`/operations"` to their + # service configuration. For backwards compatibility, the default name includes + # the operations collection id, however overriding users must ensure the name + # binding is the parent resource, without the operations collection id. # @param [String] name # The name of the operation's parent resource. # @param [String] filter @@ -741,15 +713,14 @@ module Google execute_or_queue_command(command, &block) end - # Waits for the specified long-running operation until it is done or reaches - # at most a specified timeout, returning the latest state. If the operation - # is already done, the latest state is immediately returned. If the timeout - # specified is greater than the default HTTP/RPC timeout, the HTTP/RPC - # timeout is used. If the server does not support this method, it returns - # `google.rpc.Code.UNIMPLEMENTED`. - # Note that this method is on a best-effort basis. It may return the latest - # state before the specified timeout (including immediately), meaning even an - # immediate response is no guarantee that the operation is done. + # Waits for the specified long-running operation until it is done or reaches at + # most a specified timeout, returning the latest state. If the operation is + # already done, the latest state is immediately returned. If the timeout + # specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout + # is used. If the server does not support this method, it returns `google.rpc. + # Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may + # return the latest state before the specified timeout (including immediately), + # meaning even an immediate response is no guarantee that the operation is done. # @param [String] name # The name of the operation resource to wait on. # @param [Google::Apis::TranslateV3::WaitOperationRequest] wait_operation_request_object diff --git a/generated/google/apis/translate_v3beta1.rb b/generated/google/apis/translate_v3beta1.rb index 0e9210544..0c09c184c 100644 --- a/generated/google/apis/translate_v3beta1.rb +++ b/generated/google/apis/translate_v3beta1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/translate/docs/quickstarts module TranslateV3beta1 VERSION = 'V3beta1' - REVISION = '20200730' + REVISION = '20200807' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/translate_v3beta1/classes.rb b/generated/google/apis/translate_v3beta1/classes.rb index befd28f44..6327982c4 100644 --- a/generated/google/apis/translate_v3beta1/classes.rb +++ b/generated/google/apis/translate_v3beta1/classes.rb @@ -26,41 +26,38 @@ module Google class BatchTranslateTextRequest include Google::Apis::Core::Hashable - # Optional. Glossaries to be applied for translation. - # It's keyed by target language code. + # Optional. Glossaries to be applied for translation. It's keyed by target + # language code. # Corresponds to the JSON property `glossaries` # @return [Hash] attr_accessor :glossaries - # Required. Input configurations. - # The total number of files matched should be <= 1000. - # The total content size should be <= 100M Unicode codepoints. - # The files must use UTF-8 encoding. + # Required. Input configurations. The total number of files matched should be <= + # 1000. The total content size should be <= 100M Unicode codepoints. The files + # must use UTF-8 encoding. # Corresponds to the JSON property `inputConfigs` # @return [Array] attr_accessor :input_configs - # Optional. The labels with user-defined metadata for the request. - # Label keys and values can be no longer than 63 characters - # (Unicode codepoints), can only contain lowercase letters, numeric - # characters, underscores and dashes. International characters are allowed. - # Label values are optional. Label keys must start with a letter. - # See https://cloud.google.com/translate/docs/labels for more information. + # Optional. The labels with user-defined metadata for the request. Label keys + # and values can be no longer than 63 characters (Unicode codepoints), can only + # contain lowercase letters, numeric characters, underscores and dashes. + # International characters are allowed. Label values are optional. Label keys + # must start with a letter. See https://cloud.google.com/translate/docs/labels + # for more information. # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels - # Optional. The models to use for translation. Map's key is target language - # code. Map's value is model name. Value can be a built-in general model, - # or an AutoML Translation model. - # The value format depends on model type: - # - AutoML Translation models: - # `projects/`project-number-or-id`/locations/`location-id`/models/`model-id`` - # - General (built-in) models: - # `projects/`project-number-or-id`/locations/`location-id`/models/general/nmt`, - # `projects/`project-number-or-id`/locations/`location-id`/models/general/base` - # If the map is empty or a specific model is - # not requested for a language pair, then default google model (nmt) is used. + # Optional. The models to use for translation. Map's key is target language code. + # Map's value is model name. Value can be a built-in general model, or an + # AutoML Translation model. The value format depends on model type: - AutoML + # Translation models: `projects/`project-number-or-id`/locations/`location-id`/ + # models/`model-id`` - General (built-in) models: `projects/`project-number-or- + # id`/locations/`location-id`/models/general/nmt`, `projects/`project-number-or- + # id`/locations/`location-id`/models/general/base` 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` # @return [Hash] attr_accessor :models @@ -118,30 +115,27 @@ module Google # @return [String] attr_accessor :content - # Optional. The labels with user-defined metadata for the request. - # Label keys and values can be no longer than 63 characters - # (Unicode codepoints), can only contain lowercase letters, numeric - # characters, underscores and dashes. International characters are allowed. - # Label values are optional. Label keys must start with a letter. - # See https://cloud.google.com/translate/docs/labels for more information. + # Optional. The labels with user-defined metadata for the request. Label keys + # and values can be no longer than 63 characters (Unicode codepoints), can only + # contain lowercase letters, numeric characters, underscores and dashes. + # International characters are allowed. Label values are optional. Label keys + # must start with a letter. See https://cloud.google.com/translate/docs/labels + # for more information. # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels - # Optional. The format of the source text, for example, "text/html", - # "text/plain". If left blank, the MIME type defaults to "text/html". + # Optional. The format of the source text, for example, "text/html", "text/plain" + # . If left blank, the MIME type defaults to "text/html". # Corresponds to the JSON property `mimeType` # @return [String] attr_accessor :mime_type - # Optional. The language detection model to be used. - # Format: - # `projects/`project-number-or-id`/locations/`location-id`/models/language- - # detection/`model-id`` - # Only one language detection model is currently supported: - # `projects/`project-number-or-id`/locations/`location-id`/models/language- - # detection/default`. - # If not specified, the default model is used. + # Optional. The language detection model to be used. Format: `projects/`project- + # number-or-id`/locations/`location-id`/models/language-detection/`model-id`` + # Only one language detection model is currently supported: `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` # @return [String] attr_accessor :model @@ -205,13 +199,11 @@ module Google end end - # A generic empty message that you can re-use to avoid defining duplicated - # empty messages in your APIs. A typical example is to use it as the request - # or the response type of an API method. For instance: - # service Foo ` - # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); - # ` - # The JSON representation for `Empty` is empty JSON object ````. + # A generic empty message that you can re-use to avoid defining duplicated empty + # messages in your APIs. A typical example is to use it as the request or the + # response type of an API method. For instance: service Foo ` rpc Bar(google. + # protobuf.Empty) returns (google.protobuf.Empty); ` The JSON representation for + # `Empty` is empty JSON object ````. class Empty include Google::Apis::Core::Hashable @@ -228,9 +220,9 @@ module Google class GcsDestination include Google::Apis::Core::Hashable - # Required. There must be no files under 'output_uri_prefix'. - # 'output_uri_prefix' must end with "/" and start with "gs://", otherwise an - # INVALID_ARGUMENT (400) error is returned. + # Required. There must be no files under 'output_uri_prefix'. 'output_uri_prefix' + # must end with "/" and start with "gs://", otherwise an INVALID_ARGUMENT (400) + # error is returned. # Corresponds to the JSON property `outputUriPrefix` # @return [String] attr_accessor :output_uri_prefix @@ -293,8 +285,8 @@ module Google # @return [Google::Apis::TranslateV3beta1::LanguageCodePair] attr_accessor :language_pair - # Required. The resource name of the glossary. Glossary names have the form - # `projects/`project-number-or-id`/locations/`location-id`/glossaries/`glossary- + # Required. The resource name of the glossary. Glossary names have the form ` + # projects/`project-number-or-id`/locations/`location-id`/glossaries/`glossary- # id``. # Corresponds to the JSON property `name` # @return [String] @@ -349,9 +341,8 @@ module Google # @return [Google::Apis::TranslateV3beta1::GcsSource] attr_accessor :gcs_source - # Optional. Can be "text/plain" or "text/html". - # For `.tsv`, "text/html" is used if mime_type is missing. - # For `.html`, this field must be "text/html" or empty. + # Optional. Can be "text/plain" or "text/html". For `.tsv`, "text/html" is used + # if mime_type is missing. For `.html`, this field must be "text/html" or empty. # For `.txt`, this field must be "text/plain" or empty. # Corresponds to the JSON property `mimeType` # @return [String] @@ -372,14 +363,14 @@ module Google class LanguageCodePair include Google::Apis::Core::Hashable - # Required. The BCP-47 language code of the input text, for example, - # "en-US". Expected to be an exact match for GlossaryTerm.language_code. + # Required. The BCP-47 language code of the input text, for example, "en-US". + # Expected to be an exact match for GlossaryTerm.language_code. # Corresponds to the JSON property `sourceLanguageCode` # @return [String] attr_accessor :source_language_code - # Required. The BCP-47 language code for translation output, for example, - # "zh-CN". Expected to be an exact match for GlossaryTerm.language_code. + # Required. The BCP-47 language code for translation output, for example, "zh-CN" + # . Expected to be an exact match for GlossaryTerm.language_code. # Corresponds to the JSON property `targetLanguageCode` # @return [String] attr_accessor :target_language_code @@ -399,9 +390,9 @@ module Google class LanguageCodesSet include Google::Apis::Core::Hashable - # The BCP-47 language code(s) for terms defined in the glossary. - # All entries are unique. The list contains at least two entries. - # Expected to be an exact match for GlossaryTerm.language_code. + # The BCP-47 language code(s) for terms defined in the glossary. All entries are + # unique. The list contains at least two entries. Expected to be an exact match + # for GlossaryTerm.language_code. # Corresponds to the JSON property `languageCodes` # @return [Array] attr_accessor :language_codes @@ -425,9 +416,9 @@ module Google # @return [Array] attr_accessor :glossaries - # A token to retrieve a page of results. Pass this value in the - # [ListGlossariesRequest.page_token] field in the subsequent call to - # `ListGlossaries` method to retrieve the next page of results. + # A token to retrieve a page of results. Pass this value in the [ + # ListGlossariesRequest.page_token] field in the subsequent call to ` + # ListGlossaries` method to retrieve the next page of results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -497,14 +488,14 @@ module Google class Location include Google::Apis::Core::Hashable - # The friendly name for this location, typically a nearby city name. - # For example, "Tokyo". + # The friendly name for this location, typically a nearby city name. For example, + # "Tokyo". # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name - # Cross-service attributes for the location. For example - # `"cloud.googleapis.com/region": "us-east1"` + # Cross-service attributes for the location. For example `"cloud.googleapis.com/ + # region": "us-east1"` # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels @@ -520,8 +511,8 @@ module Google # @return [Hash] attr_accessor :metadata - # Resource name for the location, which may vary between implementations. - # For example: `"projects/example-project/locations/us-east1"` + # Resource name for the location, which may vary between implementations. For + # example: `"projects/example-project/locations/us-east1"` # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -545,47 +536,45 @@ module Google class Operation include Google::Apis::Core::Hashable - # If the value is `false`, it means the operation is still in progress. - # If `true`, the operation is completed, and either `error` or `response` is - # available. + # If the value is `false`, it means the operation is still in progress. If `true` + # , the operation is completed, and either `error` or `response` is available. # Corresponds to the JSON property `done` # @return [Boolean] attr_accessor :done alias_method :done?, :done - # The `Status` type defines a logical error model that is suitable for - # different programming environments, including REST APIs and RPC APIs. It is - # used by [gRPC](https://github.com/grpc). Each `Status` message contains - # three pieces of data: error code, error message, and error details. - # You can find out more about this error model and how to work with it in the - # [API Design Guide](https://cloud.google.com/apis/design/errors). + # The `Status` type defines a logical error model that is suitable for different + # programming environments, including REST APIs and RPC APIs. It is used by [ + # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of + # data: error code, error message, and error details. You can find out more + # about this error model and how to work with it in the [API Design Guide](https: + # //cloud.google.com/apis/design/errors). # Corresponds to the JSON property `error` # @return [Google::Apis::TranslateV3beta1::Status] attr_accessor :error - # Service-specific metadata associated with the operation. It typically - # contains progress information and common metadata such as create time. - # Some services might not provide such metadata. Any method that returns a - # long-running operation should document the metadata type, if any. + # Service-specific metadata associated with the operation. It typically contains + # progress information and common metadata such as create time. Some services + # might not provide such metadata. Any method that returns a long-running + # operation should document the metadata type, if any. # Corresponds to the JSON property `metadata` # @return [Hash] attr_accessor :metadata # The server-assigned name, which is only unique within the same service that - # originally returns it. If you use the default HTTP mapping, the - # `name` should be a resource name ending with `operations/`unique_id``. + # originally returns it. If you use the default HTTP mapping, the `name` should + # be a resource name ending with `operations/`unique_id``. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # The normal response of the operation in case of success. If the original - # method returns no data on success, such as `Delete`, the response is - # `google.protobuf.Empty`. If the original method is standard - # `Get`/`Create`/`Update`, the response should be the resource. For other - # methods, the response should have the type `XxxResponse`, where `Xxx` - # is the original method name. For example, if the original method name - # is `TakeSnapshot()`, the inferred response type is - # `TakeSnapshotResponse`. + # The normal response of the operation in case of success. If the original + # method returns no data on success, such as `Delete`, the response is `google. + # protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, + # the response should be the resource. For other methods, the response should + # have the type `XxxResponse`, where `Xxx` is the original method name. For + # example, if the original method name is `TakeSnapshot()`, the inferred + # response type is `TakeSnapshotResponse`. # Corresponds to the JSON property `response` # @return [Hash] attr_accessor :response @@ -623,12 +612,12 @@ module Google end end - # The `Status` type defines a logical error model that is suitable for - # different programming environments, including REST APIs and RPC APIs. It is - # used by [gRPC](https://github.com/grpc). Each `Status` message contains - # three pieces of data: error code, error message, and error details. - # You can find out more about this error model and how to work with it in the - # [API Design Guide](https://cloud.google.com/apis/design/errors). + # The `Status` type defines a logical error model that is suitable for different + # programming environments, including REST APIs and RPC APIs. It is used by [ + # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of + # data: error code, error message, and error details. You can find out more + # about this error model and how to work with it in the [API Design Guide](https: + # //cloud.google.com/apis/design/errors). class Status include Google::Apis::Core::Hashable @@ -637,15 +626,15 @@ module Google # @return [Fixnum] attr_accessor :code - # A list of messages that carry the error details. There is a common set of + # A list of messages that carry the error details. There is a common set of # message types for APIs to use. # Corresponds to the JSON property `details` # @return [Array>] attr_accessor :details - # A developer-facing error message, which should be in English. Any - # user-facing error message should be localized and sent in the - # google.rpc.Status.details field, or localized by the client. + # A developer-facing error message, which should be in English. Any user-facing + # error message should be localized and sent in the google.rpc.Status.details + # field, or localized by the client. # Corresponds to the JSON property `message` # @return [String] attr_accessor :message @@ -662,8 +651,8 @@ module Google end end - # A single supported language response corresponds to information related - # to one supported language. + # A single supported language response corresponds to information related to one + # supported language. class SupportedLanguage include Google::Apis::Core::Hashable @@ -673,10 +662,9 @@ module Google # @return [String] attr_accessor :display_name - # Supported language code, generally consisting of its ISO 639-1 - # identifier, for example, 'en', 'ja'. In certain cases, BCP-47 codes - # including language and region identifiers are returned (for example, - # 'zh-TW' and 'zh-CN') + # Supported language code, generally consisting of its ISO 639-1 identifier, for + # example, 'en', 'ja'. In certain cases, BCP-47 codes including language and + # region identifiers are returned (for example, 'zh-TW' and 'zh-CN') # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code @@ -710,8 +698,8 @@ module Google class SupportedLanguages include Google::Apis::Core::Hashable - # A list of supported language responses. This list contains an entry - # for each language the Translation API supports. + # A list of supported language responses. This list contains an entry for each + # language the Translation API supports. # Corresponds to the JSON property `languages` # @return [Array] attr_accessor :languages @@ -726,19 +714,19 @@ module Google end end - # Configures which glossary should be used for a specific target language, - # and defines options for applying that glossary. + # Configures which glossary should be used for a specific target language, and + # defines options for applying that glossary. class TranslateTextGlossaryConfig include Google::Apis::Core::Hashable - # Required. Specifies the glossary used for this translation. Use - # this format: projects/*/locations/*/glossaries/* + # Required. Specifies the glossary used for this translation. Use this format: + # projects/*/locations/*/glossaries/* # Corresponds to the JSON property `glossary` # @return [String] attr_accessor :glossary - # Optional. Indicates match is case-insensitive. - # Default value is false if missing. + # Optional. Indicates match is case-insensitive. Default value is false if + # missing. # Corresponds to the JSON property `ignoreCase` # @return [Boolean] attr_accessor :ignore_case @@ -759,61 +747,57 @@ module Google class TranslateTextRequest include Google::Apis::Core::Hashable - # Required. The content of the input in string format. - # We recommend the total content be less than 30k codepoints. - # Use BatchTranslateText for larger text. + # Required. The content of the input in string format. We recommend the total + # content be less than 30k codepoints. Use BatchTranslateText for larger text. # Corresponds to the JSON property `contents` # @return [Array] attr_accessor :contents - # Configures which glossary should be used for a specific target language, - # and defines options for applying that glossary. + # Configures which glossary should be used for a specific target language, and + # defines options for applying that glossary. # Corresponds to the JSON property `glossaryConfig` # @return [Google::Apis::TranslateV3beta1::TranslateTextGlossaryConfig] attr_accessor :glossary_config - # Optional. The labels with user-defined metadata for the request. - # Label keys and values can be no longer than 63 characters - # (Unicode codepoints), can only contain lowercase letters, numeric - # characters, underscores and dashes. International characters are allowed. - # Label values are optional. Label keys must start with a letter. - # See https://cloud.google.com/translate/docs/labels for more information. + # Optional. The labels with user-defined metadata for the request. Label keys + # and values can be no longer than 63 characters (Unicode codepoints), can only + # contain lowercase letters, numeric characters, underscores and dashes. + # International characters are allowed. Label values are optional. Label keys + # must start with a letter. See https://cloud.google.com/translate/docs/labels + # for more information. # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels - # Optional. The format of the source text, for example, "text/html", - # "text/plain". If left blank, the MIME type defaults to "text/html". + # Optional. The format of the source text, for example, "text/html", "text/plain" + # . If left blank, the MIME type defaults to "text/html". # Corresponds to the JSON property `mimeType` # @return [String] attr_accessor :mime_type - # Optional. The `model` type requested for this translation. - # The format depends on model type: - # - AutoML Translation models: - # `projects/`project-number-or-id`/locations/`location-id`/models/`model-id`` - # - General (built-in) models: - # `projects/`project-number-or-id`/locations/`location-id`/models/general/nmt`, - # `projects/`project-number-or-id`/locations/`location-id`/models/general/base` - # For global (non-regionalized) requests, use `location-id` `global`. - # For example, - # `projects/`project-number-or-id`/locations/global/models/general/nmt`. + # Optional. The `model` type requested for this translation. The format depends + # on model type: - AutoML Translation models: `projects/`project-number-or-id`/ + # locations/`location-id`/models/`model-id`` - General (built-in) models: ` + # projects/`project-number-or-id`/locations/`location-id`/models/general/nmt`, ` + # projects/`project-number-or-id`/locations/`location-id`/models/general/base` + # 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. # Corresponds to the JSON property `model` # @return [String] attr_accessor :model - # Optional. The BCP-47 language code of the input text if - # known, for example, "en-US" or "sr-Latn". Supported language codes are - # listed in Language Support. If the source language isn't specified, the API - # attempts to identify the source language automatically and returns the - # source language within the response. + # Optional. The BCP-47 language code of the input text if known, for example, " + # en-US" or "sr-Latn". Supported language codes are listed in Language Support. + # If the source language isn't specified, the API attempts to identify the + # source language automatically and returns the source language within the + # response. # Corresponds to the JSON property `sourceLanguageCode` # @return [String] attr_accessor :source_language_code - # Required. The BCP-47 language code to use for translation of the input - # text, set to one of the language codes listed in Language Support. + # Required. The BCP-47 language code to use for translation of the input text, + # set to one of the language codes listed in Language Support. # Corresponds to the JSON property `targetLanguageCode` # @return [String] attr_accessor :target_language_code @@ -838,18 +822,15 @@ module Google class TranslateTextResponse include Google::Apis::Core::Hashable - # Text translation responses if a glossary is provided in the request. - # This can be the same as - # `translations` if no terms apply. - # This field has the same length as - # `contents`. + # Text translation responses if a glossary is provided in the request. This can + # be the same as `translations` if no terms apply. This field has the same + # length as `contents`. # Corresponds to the JSON property `glossaryTranslations` # @return [Array] attr_accessor :glossary_translations - # Text translation responses with no glossary applied. - # This field has the same length as - # `contents`. + # Text translation responses with no glossary applied. This field has the same + # length as `contents`. # Corresponds to the JSON property `translations` # @return [Array] attr_accessor :translations @@ -870,26 +851,24 @@ module Google include Google::Apis::Core::Hashable # The BCP-47 language code of source text in the initial request, detected - # automatically, if no source language was passed within the initial - # request. If the source language was passed, auto-detection of the language - # does not occur and this field is empty. + # automatically, if no source language was passed within the initial request. If + # the source language was passed, auto-detection of the language does not occur + # and this field is empty. # Corresponds to the JSON property `detectedLanguageCode` # @return [String] attr_accessor :detected_language_code - # Configures which glossary should be used for a specific target language, - # and defines options for applying that glossary. + # Configures which glossary should be used for a specific target language, and + # defines options for applying that glossary. # Corresponds to the JSON property `glossaryConfig` # @return [Google::Apis::TranslateV3beta1::TranslateTextGlossaryConfig] attr_accessor :glossary_config - # Only present when `model` is present in the request. - # `model` here is normalized to have project number. - # For example: - # If the `model` requested in TranslationTextRequest is - # `projects/`project-id`/locations/`location-id`/models/general/nmt` then - # `model` here would be normalized to - # `projects/`project-number`/locations/`location-id`/models/general/nmt`. + # Only present when `model` is present in the request. `model` here is + # normalized to have project number. For example: If the `model` requested in + # TranslationTextRequest is `projects/`project-id`/locations/`location-id`/ + # models/general/nmt` then `model` here would be normalized to `projects/` + # project-number`/locations/`location-id`/models/general/nmt`. # Corresponds to the JSON property `model` # @return [String] attr_accessor :model @@ -916,9 +895,9 @@ module Google class WaitOperationRequest include Google::Apis::Core::Hashable - # The maximum duration to wait before timing out. If left blank, the wait - # will be at most the time permitted by the underlying HTTP/RPC protocol. - # If RPC context deadline is also specified, the shorter one will be used. + # The maximum duration to wait before timing out. If left blank, the wait will + # be at most the time permitted by the underlying HTTP/RPC protocol. If RPC + # context deadline is also specified, the shorter one will be used. # Corresponds to the JSON property `timeout` # @return [String] attr_accessor :timeout diff --git a/generated/google/apis/translate_v3beta1/service.rb b/generated/google/apis/translate_v3beta1/service.rb index 05f776bb9..572dfebba 100644 --- a/generated/google/apis/translate_v3beta1/service.rb +++ b/generated/google/apis/translate_v3beta1/service.rb @@ -49,14 +49,12 @@ module Google # Detects the language of text within a request. # @param [String] parent - # Required. Project or location to make a call. Must refer to a caller's - # project. - # Format: `projects/`project-number-or-id`/locations/`location-id`` or - # `projects/`project-number-or-id``. - # For global calls, use `projects/`project-number-or-id`/locations/global` or - # `projects/`project-number-or-id``. - # Only models within the same region (has same location-id) can be used. - # Otherwise an INVALID_ARGUMENT (400) error is returned. + # Required. Project or location to make a call. Must refer to a caller's project. + # Format: `projects/`project-number-or-id`/locations/`location-id`` or ` + # projects/`project-number-or-id``. For global calls, use `projects/`project- + # number-or-id`/locations/global` or `projects/`project-number-or-id``. 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 [String] fields # Selector specifying which fields to include in a partial response. @@ -89,29 +87,25 @@ module Google # Returns a list of supported languages for translation. # @param [String] parent - # Required. Project or location to make a call. Must refer to a caller's - # project. - # Format: `projects/`project-number-or-id`` or - # `projects/`project-number-or-id`/locations/`location-id``. - # For global calls, use `projects/`project-number-or-id`/locations/global` or - # `projects/`project-number-or-id``. - # Non-global location is required for AutoML models. - # Only models within the same region (have same location-id) can be used, - # otherwise an INVALID_ARGUMENT (400) error is returned. + # Required. Project or location to make a call. Must refer to a caller's project. + # Format: `projects/`project-number-or-id`` or `projects/`project-number-or-id`/ + # locations/`location-id``. For global calls, use `projects/`project-number-or- + # id`/locations/global` or `projects/`project-number-or-id``. Non-global + # location is required for AutoML models. 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 - # Optional. The language to use to return localized, human readable names - # of supported languages. If missing, then display names are not returned - # in a response. + # Optional. The language to use to return localized, human readable names of + # supported languages. If missing, then display names are not returned in a + # response. # @param [String] model - # Optional. Get supported languages of this model. - # The format depends on model type: - # - AutoML Translation models: - # `projects/`project-number-or-id`/locations/`location-id`/models/`model-id`` - # - General (built-in) models: - # `projects/`project-number-or-id`/locations/`location-id`/models/general/nmt`, - # `projects/`project-number-or-id`/locations/`location-id`/models/general/base` - # Returns languages supported by the specified model. - # If missing, we get supported languages of Google general base (PBMT) model. + # Optional. Get supported languages of this model. The format depends on model + # type: - AutoML Translation models: `projects/`project-number-or-id`/locations/` + # location-id`/models/`model-id`` - General (built-in) models: `projects/` + # project-number-or-id`/locations/`location-id`/models/general/nmt`, `projects/` + # project-number-or-id`/locations/`location-id`/models/general/base` Returns + # languages supported by the specified model. If missing, we get supported + # languages of Google general base (PBMT) model. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -143,16 +137,13 @@ module Google # Translates input text and returns translated text. # @param [String] parent - # Required. Project or location to make a call. Must refer to a caller's - # project. - # Format: `projects/`project-number-or-id`` or - # `projects/`project-number-or-id`/locations/`location-id``. - # For global calls, use `projects/`project-number-or-id`/locations/global` or - # `projects/`project-number-or-id``. - # Non-global location is required for requests using AutoML models or - # custom glossaries. - # Models and glossaries must be within the same region (have same - # location-id), otherwise an INVALID_ARGUMENT (400) error is returned. + # Required. Project or location to make a call. Must refer to a caller's project. + # Format: `projects/`project-number-or-id`` or `projects/`project-number-or-id`/ + # locations/`location-id``. For global calls, use `projects/`project-number-or- + # id`/locations/global` or `projects/`project-number-or-id``. Non-global + # location is required for requests using AutoML models or 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 [String] fields # Selector specifying which fields to include in a partial response. @@ -183,19 +174,18 @@ module Google execute_or_queue_command(command, &block) end - # Translates a large volume of text in asynchronous batch mode. - # This function provides real-time output as the inputs are being processed. - # If caller cancels a request, the partial results (for an input file, it's - # all or nothing) may still be available on the specified output location. - # This call returns immediately and you can - # use google.longrunning.Operation.name to poll the status of the call. + # Translates a large volume of text in asynchronous batch mode. This function + # provides real-time output as the inputs are being processed. If caller cancels + # a request, the partial results (for an input file, it's all or nothing) may + # still be available on the specified output location. This call returns + # immediately and you can use google.longrunning.Operation.name to poll the + # status of the call. # @param [String] parent - # Required. Location to make a call. Must refer to a caller's project. - # Format: `projects/`project-number-or-id`/locations/`location-id``. - # The `global` location is not supported for batch translation. - # Only AutoML Translation models or glossaries within the same region (have - # the same location-id) can be used, otherwise an INVALID_ARGUMENT (400) - # error is returned. + # Required. Location to make a call. Must refer to a caller's project. Format: ` + # projects/`project-number-or-id`/locations/`location-id``. The `global` + # location is not supported for batch translation. Only AutoML Translation + # models or glossaries within the same region (have the same location-id) can be + # used, otherwise an INVALID_ARGUMENT (400) error is returned. # @param [Google::Apis::TranslateV3beta1::BatchTranslateTextRequest] batch_translate_text_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -228,14 +218,12 @@ module Google # Detects the language of text within a request. # @param [String] parent - # Required. Project or location to make a call. Must refer to a caller's - # project. - # Format: `projects/`project-number-or-id`/locations/`location-id`` or - # `projects/`project-number-or-id``. - # For global calls, use `projects/`project-number-or-id`/locations/global` or - # `projects/`project-number-or-id``. - # Only models within the same region (has same location-id) can be used. - # Otherwise an INVALID_ARGUMENT (400) error is returned. + # Required. Project or location to make a call. Must refer to a caller's project. + # Format: `projects/`project-number-or-id`/locations/`location-id`` or ` + # projects/`project-number-or-id``. For global calls, use `projects/`project- + # number-or-id`/locations/global` or `projects/`project-number-or-id``. 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 [String] fields # Selector specifying which fields to include in a partial response. @@ -298,29 +286,25 @@ module Google # Returns a list of supported languages for translation. # @param [String] parent - # Required. Project or location to make a call. Must refer to a caller's - # project. - # Format: `projects/`project-number-or-id`` or - # `projects/`project-number-or-id`/locations/`location-id``. - # For global calls, use `projects/`project-number-or-id`/locations/global` or - # `projects/`project-number-or-id``. - # Non-global location is required for AutoML models. - # Only models within the same region (have same location-id) can be used, - # otherwise an INVALID_ARGUMENT (400) error is returned. + # Required. Project or location to make a call. Must refer to a caller's project. + # Format: `projects/`project-number-or-id`` or `projects/`project-number-or-id`/ + # locations/`location-id``. For global calls, use `projects/`project-number-or- + # id`/locations/global` or `projects/`project-number-or-id``. Non-global + # location is required for AutoML models. 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 - # Optional. The language to use to return localized, human readable names - # of supported languages. If missing, then display names are not returned - # in a response. + # Optional. The language to use to return localized, human readable names of + # supported languages. If missing, then display names are not returned in a + # response. # @param [String] model - # Optional. Get supported languages of this model. - # The format depends on model type: - # - AutoML Translation models: - # `projects/`project-number-or-id`/locations/`location-id`/models/`model-id`` - # - General (built-in) models: - # `projects/`project-number-or-id`/locations/`location-id`/models/general/nmt`, - # `projects/`project-number-or-id`/locations/`location-id`/models/general/base` - # Returns languages supported by the specified model. - # If missing, we get supported languages of Google general base (PBMT) model. + # Optional. Get supported languages of this model. The format depends on model + # type: - AutoML Translation models: `projects/`project-number-or-id`/locations/` + # location-id`/models/`model-id`` - General (built-in) models: `projects/` + # project-number-or-id`/locations/`location-id`/models/general/nmt`, `projects/` + # project-number-or-id`/locations/`location-id`/models/general/base` Returns + # languages supported by the specified model. If missing, we get supported + # languages of Google general base (PBMT) model. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -391,16 +375,13 @@ module Google # Translates input text and returns translated text. # @param [String] parent - # Required. Project or location to make a call. Must refer to a caller's - # project. - # Format: `projects/`project-number-or-id`` or - # `projects/`project-number-or-id`/locations/`location-id``. - # For global calls, use `projects/`project-number-or-id`/locations/global` or - # `projects/`project-number-or-id``. - # Non-global location is required for requests using AutoML models or - # custom glossaries. - # Models and glossaries must be within the same region (have same - # location-id), otherwise an INVALID_ARGUMENT (400) error is returned. + # Required. Project or location to make a call. Must refer to a caller's project. + # Format: `projects/`project-number-or-id`` or `projects/`project-number-or-id`/ + # locations/`location-id``. For global calls, use `projects/`project-number-or- + # id`/locations/global` or `projects/`project-number-or-id``. Non-global + # location is required for requests using AutoML models or 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 [String] fields # Selector specifying which fields to include in a partial response. @@ -431,8 +412,8 @@ module Google execute_or_queue_command(command, &block) end - # Creates a glossary and returns the long-running operation. Returns - # NOT_FOUND, if the project doesn't exist. + # Creates a glossary and returns the long-running operation. Returns NOT_FOUND, + # if the project doesn't exist. # @param [String] parent # Required. The project name. # @param [Google::Apis::TranslateV3beta1::Glossary] glossary_object @@ -465,9 +446,8 @@ module Google execute_or_queue_command(command, &block) end - # Deletes a glossary, or cancels glossary construction - # if the glossary isn't created yet. - # Returns NOT_FOUND, if the glossary doesn't exist. + # Deletes a glossary, or cancels glossary construction if the glossary isn't + # created yet. Returns NOT_FOUND, if the glossary doesn't exist. # @param [String] name # Required. The name of the glossary to delete. # @param [String] fields @@ -497,8 +477,7 @@ module Google execute_or_queue_command(command, &block) end - # Gets a glossary. Returns NOT_FOUND, if the glossary doesn't - # exist. + # Gets a glossary. Returns NOT_FOUND, if the glossary doesn't exist. # @param [String] name # Required. The name of the glossary to retrieve. # @param [String] fields @@ -528,35 +507,32 @@ module Google execute_or_queue_command(command, &block) end - # Lists glossaries in a project. Returns NOT_FOUND, if the project doesn't - # exist. + # Lists glossaries in a project. Returns NOT_FOUND, if the project doesn't exist. # @param [String] parent # Required. The name of the project from which to list all of the glossaries. # @param [String] filter - # Optional. Filter specifying constraints of a list operation. - # Specify the constraint by the format of "key=value", where key must be - # "src" or "tgt", and the value must be a valid language code. - # For multiple restrictions, concatenate them by "AND" (uppercase only), - # such as: "src=en-US AND tgt=zh-CN". Notice that the exact match is used - # here, which means using 'en-US' and 'en' can lead to different results, - # which depends on the language code you used when you create the glossary. - # For the unidirectional glossaries, the "src" and "tgt" add restrictions - # on the source and target language code separately. - # For the equivalent term set glossaries, the "src" and/or "tgt" add - # restrictions on the term set. - # For example: "src=en-US AND tgt=zh-CN" will only pick the unidirectional - # glossaries which exactly match the source language code as "en-US" and the - # target language code "zh-CN", but all equivalent term set glossaries which - # contain "en-US" and "zh-CN" in their language set will be picked. - # If missing, no filtering is performed. + # Optional. Filter specifying constraints of a list operation. Specify the + # constraint by the format of "key=value", where key must be "src" or "tgt", and + # the value must be a valid language code. For multiple restrictions, + # concatenate them by "AND" (uppercase only), such as: "src=en-US AND tgt=zh-CN". + # Notice that the exact match is used here, which means using 'en-US' and 'en' + # can lead to different results, which depends on the language code you used + # when you create the glossary. For the unidirectional glossaries, the "src" and + # "tgt" add restrictions on the source and target language code separately. For + # the equivalent term set glossaries, the "src" and/or "tgt" add restrictions on + # the term set. For example: "src=en-US AND tgt=zh-CN" will only pick the + # unidirectional glossaries which exactly match the source language code as "en- + # US" and the target language code "zh-CN", but all equivalent term set + # glossaries which contain "en-US" and "zh-CN" in their language set will be + # picked. If missing, no filtering is performed. # @param [Fixnum] page_size # Optional. Requested page size. The server may return fewer glossaries than # requested. If unspecified, the server picks an appropriate default. # @param [String] page_token # Optional. A token identifying a page of results the server should return. # Typically, this is the value of [ListGlossariesResponse.next_page_token] - # returned from the previous call to `ListGlossaries` method. - # The first page is returned if `page_token`is empty or missing. + # returned from the previous call to `ListGlossaries` method. The first page is + # returned if `page_token`is empty or missing. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -587,15 +563,13 @@ module Google execute_or_queue_command(command, &block) end - # Starts asynchronous cancellation on a long-running operation. The server - # makes a best effort to cancel the operation, but success is not - # guaranteed. If the server doesn't support this method, it returns - # `google.rpc.Code.UNIMPLEMENTED`. Clients can use - # Operations.GetOperation or - # other methods to check whether the cancellation succeeded or whether the - # operation completed despite cancellation. On successful cancellation, - # the operation is not deleted; instead, it becomes an operation with - # an Operation.error value with a google.rpc.Status.code of 1, + # Starts asynchronous cancellation on a long-running operation. The server makes + # a best effort to cancel the operation, but success is not guaranteed. If the + # server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + # Clients can use Operations.GetOperation or other methods to check whether the + # cancellation succeeded or whether the operation completed despite cancellation. + # On successful cancellation, the operation is not deleted; instead, it becomes + # an operation with an Operation.error value with a google.rpc.Status.code of 1, # corresponding to `Code.CANCELLED`. # @param [String] name # The name of the operation resource to be cancelled. @@ -629,10 +603,10 @@ module Google execute_or_queue_command(command, &block) end - # Deletes a long-running operation. This method indicates that the client is - # no longer interested in the operation result. It does not cancel the - # operation. If the server doesn't support this method, it returns - # `google.rpc.Code.UNIMPLEMENTED`. + # Deletes a long-running operation. This method indicates that the client is no + # longer interested in the operation result. It does not cancel the operation. + # If the server doesn't support this method, it returns `google.rpc.Code. + # UNIMPLEMENTED`. # @param [String] name # The name of the operation resource to be deleted. # @param [String] fields @@ -662,9 +636,8 @@ module Google execute_or_queue_command(command, &block) end - # Gets the latest state of a long-running operation. Clients can use this - # method to poll the operation result at intervals as recommended by the API - # service. + # Gets the latest state of a long-running operation. Clients can use this method + # to poll the operation result at intervals as recommended by the API service. # @param [String] name # The name of the operation resource. # @param [String] fields @@ -694,15 +667,14 @@ module Google execute_or_queue_command(command, &block) end - # Lists operations that match the specified filter in the request. If the - # server doesn't support this method, it returns `UNIMPLEMENTED`. - # NOTE: the `name` binding allows API services to override the binding - # to use different resource name schemes, such as `users/*/operations`. To - # override the binding, API services can add a binding such as - # `"/v1/`name=users/*`/operations"` to their service configuration. - # For backwards compatibility, the default name includes the operations - # collection id, however overriding users must ensure the name binding - # is the parent resource, without the operations collection id. + # Lists operations that match the specified filter in the request. If the server + # doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` + # binding allows API services to override the binding to use different resource + # name schemes, such as `users/*/operations`. To override the binding, API + # services can add a binding such as `"/v1/`name=users/*`/operations"` to their + # service configuration. For backwards compatibility, the default name includes + # the operations collection id, however overriding users must ensure the name + # binding is the parent resource, without the operations collection id. # @param [String] name # The name of the operation's parent resource. # @param [String] filter @@ -741,15 +713,14 @@ module Google execute_or_queue_command(command, &block) end - # Waits for the specified long-running operation until it is done or reaches - # at most a specified timeout, returning the latest state. If the operation - # is already done, the latest state is immediately returned. If the timeout - # specified is greater than the default HTTP/RPC timeout, the HTTP/RPC - # timeout is used. If the server does not support this method, it returns - # `google.rpc.Code.UNIMPLEMENTED`. - # Note that this method is on a best-effort basis. It may return the latest - # state before the specified timeout (including immediately), meaning even an - # immediate response is no guarantee that the operation is done. + # Waits for the specified long-running operation until it is done or reaches at + # most a specified timeout, returning the latest state. If the operation is + # already done, the latest state is immediately returned. If the timeout + # specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout + # is used. If the server does not support this method, it returns `google.rpc. + # Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may + # return the latest state before the specified timeout (including immediately), + # meaning even an immediate response is no guarantee that the operation is done. # @param [String] name # The name of the operation resource to wait on. # @param [Google::Apis::TranslateV3beta1::WaitOperationRequest] wait_operation_request_object diff --git a/generated/google/apis/vectortile_v1.rb b/generated/google/apis/vectortile_v1.rb index 34e0072a0..17b51699f 100644 --- a/generated/google/apis/vectortile_v1.rb +++ b/generated/google/apis/vectortile_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/maps/contact-sales/ module VectortileV1 VERSION = 'V1' - REVISION = '20200622' + REVISION = '20200808' end end end diff --git a/generated/google/apis/vectortile_v1/classes.rb b/generated/google/apis/vectortile_v1/classes.rb index 2c20c6c26..8ef305442 100644 --- a/generated/google/apis/vectortile_v1/classes.rb +++ b/generated/google/apis/vectortile_v1/classes.rb @@ -26,8 +26,8 @@ module Google class Area include Google::Apis::Core::Hashable - # True if the polygon is not entirely internal to the feature that it belongs - # to: that is, some of the edges are bordering another feature. + # True if the polygon is not entirely internal to the feature that it belongs to: + # that is, some of the edges are bordering another feature. # Corresponds to the JSON property `hasExternalEdges` # @return [Boolean] attr_accessor :has_external_edges @@ -35,29 +35,27 @@ module Google # 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. Each value is an index into the vertices array, and - # denotes the start vertex of the internal edge (the next vertex in the - # boundary loop is the end of the edge). If the selected vertex is the last - # vertex in the boundary loop, then the edge between that vertex and the - # starting vertex of the loop is internal. - # This field may be used for styling. For example, building parapets could be - # placed only on the external edges of a building polygon, or water could be - # lighter colored near the external edges of a body of water. - # If has_external_edges is false, all edges are internal and this field will - # be empty. + # another feature. Each value is an index into the vertices array, and denotes + # the start vertex of the internal edge (the next vertex in the boundary loop is + # the end of the edge). If the selected vertex is the last vertex in the + # boundary loop, then the edge between that vertex and the starting vertex of + # the loop is internal. This field may be used for styling. For example, + # building parapets could be placed only on the external edges of a building + # polygon, or water could be lighter colored near the external edges of a body + # of water. If has_external_edges is false, all edges are internal and this + # field will be empty. # Corresponds to the JSON property `internalEdges` # @return [Array] attr_accessor :internal_edges # Identifies the boundary loops of the polygon. Only set for INDEXED_TRIANGLE # polygons. Each value is an index into the vertices array indicating the - # beginning of a loop. For instance, values of [2, 5] would indicate - # loop_data contained 3 loops with indices 0-1, 2-4, and 5-end. - # This may be used in conjunction with the internal_edges field for styling - # polygon boundaries. Note that an edge may be on a polygon boundary but - # still internal to the feature. For example, a feature split across multiple - # tiles will have an internal polygon boundary edge along the edge of the - # tile. + # beginning of a loop. For instance, values of [2, 5] would indicate loop_data + # contained 3 loops with indices 0-1, 2-4, and 5-end. This may be used in + # conjunction with the internal_edges field for styling polygon boundaries. Note + # that an edge may be on a polygon boundary but still internal to the feature. + # For example, a feature split across multiple tiles will have an internal + # polygon boundary edge along the edge of the tile. # Corresponds to the JSON property `loopBreaks` # @return [Array] attr_accessor :loop_breaks @@ -75,21 +73,19 @@ module Google attr_accessor :type # 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 - # (0, 0). - # For example, the list of vertices [(1,1), (2, 2), (1, 2)] would be encoded + # the previous one in local tile coordinates. The first entry is offset from (0, + # 0). 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)]. # Corresponds to the JSON property `vertexOffsets` # @return [Google::Apis::VectortileV1::Vertex2DList] attr_accessor :vertex_offsets # 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 - # anything about the altitude of the line relative to the ground, but it - # can be used to prevent z-fighting during rendering on the client. This - # z-ordering can only be used to compare areas, and cannot be compared with - # the z_order field in the Line message. - # The z-order may be negative or zero. + # beneath areas with a higher z-order. This z-ordering does not imply anything + # about the altitude of the line relative to the ground, but it can be used to + # prevent z-fighting during rendering on the client. This z-ordering can only be + # used to compare areas, and cannot be compared with the z_order field in the + # Line message. The z-order may be negative or zero. # Corresponds to the JSON property `zOrder` # @return [Fixnum] 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 # section. Used to represent extruded buildings. A single building may consist - # of several extruded areas. - # The min_z and max_z fields are scaled to the size of the tile. An extruded - # area with a max_z value of 4096 has the same height as the width of the tile - # that it is on. + # of several extruded areas. The min_z and max_z fields are scaled to the size + # of the tile. An extruded area with a max_z value of 4096 has the same height + # as the width of the tile that it is on. class ExtrudedArea include Google::Apis::Core::Hashable @@ -129,10 +124,9 @@ module Google # @return [Fixnum] attr_accessor :max_z - # The z-value in local tile coordinates where the extruded area begins. This - # is non-zero for extruded areas that begin off the ground. For example, a - # building with a skybridge may have an extruded area component with a - # non-zero min_z. + # The z-value in local tile coordinates where the extruded area begins. This is + # non-zero for extruded areas that begin off the ground. For example, a building + # with a skybridge may have an extruded area component with a non-zero min_z. # Corresponds to the JSON property `minZ` # @return [Fixnum] attr_accessor :min_z @@ -159,19 +153,17 @@ module Google attr_accessor :display_name # 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 - # (upper-left) corner of the tile, and is scaled to 4096 units across each - # edge. The height (Z) axis has the same scale factor: an extruded area with a - # max_z value of 4096 has the same height as the width of the tile that it is - # on. - # There is no clipping boundary, so it is possible that some coordinates will - # lie outside the tile boundaries. + # map. The local tile coordinate system has the origin at the north-west (upper- + # left) corner of the tile, and is scaled to 4096 units across each edge. The + # height (Z) axis has the same scale factor: an extruded area with a max_z value + # of 4096 has the same height as the width of the tile that it is on. There is + # no clipping boundary, so it is possible that some coordinates will lie outside + # the tile boundaries. # Corresponds to the JSON property `geometry` # @return [Google::Apis::VectortileV1::Geometry] attr_accessor :geometry - # Place ID of this feature, suitable for use in Places API details - # requests. + # Place ID of this feature, suitable for use in Places API details requests. # Corresponds to the JSON property `placeId` # @return [String] attr_accessor :place_id @@ -212,20 +204,18 @@ module Google include Google::Apis::Core::Hashable # Global tile coordinates. Global tile coordinates reference a specific tile on - # the map at a specific zoom level. - # The origin of this coordinate system is always at the northwest corner of the - # map, with x values increasing from west to east and y values increasing from - # north to south. Tiles are indexed using x, y coordinates from that origin. - # The zoom level containing the entire world in a tile is 0, and it increases - # as you zoom in. Zoom level n + 1 will contain 4 times as many tiles as zoom - # level n. - # The zoom level controls the level of detail of the data that is returned. In - # particular, this affects the set of feature types returned, their density, - # and geometry simplification. The exact tile contents may change over time, - # but care will be taken to keep supporting the most important use cases. For - # example, zoom level 15 shows roads for orientation and planning in the local - # neighborhood and zoom level 17 shows buildings to give users on foot a sense - # of situational awareness. + # the map at a specific zoom level. The origin of this coordinate system is + # always at the northwest corner of the map, with x values increasing from west + # to east and y values increasing from north to south. Tiles are indexed using x, + # y coordinates from that origin. The zoom level containing the entire world in + # a tile is 0, and it increases as you zoom in. Zoom level n + 1 will contain 4 + # times as many tiles as zoom level n. The zoom level controls the level of + # detail of the data that is returned. In particular, this affects the set of + # feature types returned, their density, and geometry simplification. The exact + # tile contents may change over time, but care will be taken to keep supporting + # the most important use cases. For example, zoom level 15 shows roads for + # orientation and planning in the local neighborhood and zoom level 17 shows + # buildings to give users on foot a sense of situational awareness. # Corresponds to the JSON property `coordinates` # @return [Google::Apis::VectortileV1::TileCoordinates] attr_accessor :coordinates @@ -236,9 +226,9 @@ module Google attr_accessor :features # Resource name of the tile. The tile resource name is prefixed by its - # collection ID `tiles/` followed by the resource ID, which encodes the - # tile's global x and y coordinates and zoom level as `@,,z`. For - # example, `tiles/@1,2,3z`. + # collection ID `tiles/` followed by the resource ID, which encodes the tile's + # global x and y coordinates and zoom level as `@,,z`. For example, `tiles/@1,2, + # 3z`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -253,13 +243,12 @@ module Google # @return [String] attr_accessor :status - # An opaque value, usually less than 30 characters, that contains version - # info about this tile and the data that was used to generate it. - # The client should store this value in its tile cache and pass it back to - # the API in the client_tile_version_id field of subsequent tile requests in - # order to enable the API to detect when the new tile would be the same as - # the one the client already has in its cache. - # Also see STATUS_OK_DATA_UNCHANGED. + # An opaque value, usually less than 30 characters, that contains version info + # about this tile and the data that was used to generate it. The client should + # store this value in its tile cache and pass it back to the API in the + # client_tile_version_id field of subsequent tile requests in order to enable + # the API to detect when the new tile would be the same as the one the client + # already has in its cache. Also see STATUS_OK_DATA_UNCHANGED. # Corresponds to the JSON property `versionId` # @return [String] attr_accessor :version_id @@ -280,29 +269,17 @@ module Google end # A packed representation of a 2D grid of uniformly spaced points containing - # elevation data. Each point within the grid represents the altitude in - # meters above average sea level at that location within the tile. - # Elevations provided are (generally) relative to the EGM96 geoid, however - # some areas will be relative to NAVD88. EGM96 and NAVD88 are off by no more - # than 2 meters. - # The grid is oriented north-west to south-east, as illustrated: - # rows[0].a[0] rows[0].a[m] - # +-----------------+ - # | | - # | N | - # | ^ | - # | | | - # | 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. + # elevation data. Each point within the grid represents the altitude in meters + # above average sea level at that location within the tile. Elevations provided + # are (generally) relative to the EGM96 geoid, however some areas will be + # relative to NAVD88. EGM96 and NAVD88 are off by no more than 2 meters. The + # grid is oriented north-west to south-east, as illustrated: rows[0].a[0] rows[0] + # .a[m] +-----------------+ | | | N | | ^ | | | | | 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 include Google::Apis::Core::Hashable @@ -312,9 +289,9 @@ module Google # @return [Float] attr_accessor :altitude_multiplier - # Rows of points containing altitude data making up the elevation grid. - # Each row is the same length. Rows are ordered from north to south. E.g: - # rows[0] is the north-most row, and rows[n] is the south-most row. + # Rows of points containing altitude data making up the elevation grid. Each row + # is the same length. Rows are ordered from north to south. E.g: rows[0] is the + # north-most row, and rows[n] is the south-most row. # Corresponds to the JSON property `rows` # @return [Array] attr_accessor :rows @@ -331,13 +308,12 @@ module Google end # 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 - # (upper-left) corner of the tile, and is scaled to 4096 units across each - # edge. The height (Z) axis has the same scale factor: an extruded area with a - # max_z value of 4096 has the same height as the width of the tile that it is - # on. - # There is no clipping boundary, so it is possible that some coordinates will - # lie outside the tile boundaries. + # map. The local tile coordinate system has the origin at the north-west (upper- + # left) corner of the tile, and is scaled to 4096 units across each edge. The + # height (Z) axis has the same scale factor: an extruded area with a max_z value + # of 4096 has the same height as the width of the tile that it is on. There is + # no clipping boundary, so it is possible that some coordinates will lie outside + # the tile boundaries. class Geometry include Google::Apis::Core::Hashable @@ -380,22 +356,20 @@ module Google include Google::Apis::Core::Hashable # 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 - # (0, 0). - # For example, the list of vertices [(1,1), (2, 2), (1, 2)] would be encoded + # the previous one in local tile coordinates. The first entry is offset from (0, + # 0). 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)]. # Corresponds to the JSON property `vertexOffsets` # @return [Google::Apis::VectortileV1::Vertex2DList] attr_accessor :vertex_offsets - # The z-order of the line. Lines with a lower z-order should be rendered - # beneath lines with a higher z-order. This z-ordering does not imply - # anything about the altitude of the area relative to the ground, but it - # can be used to prevent z-fighting during rendering on the client. In - # general, larger and more important road features will have a higher z-order - # line associated with them. This z-ordering can only be used to compare - # lines, and cannot be compared with the z_order field in the Area message. - # The z-order may be negative or zero. + # The z-order of the line. Lines with a lower z-order should be rendered beneath + # lines with a higher z-order. This z-ordering does not imply anything about the + # altitude of the area relative to the ground, but it can be used to prevent z- + # fighting during rendering on the client. In general, larger and more important + # road features will have a higher z-order line associated with them. This z- + # ordering can only be used to compare lines, and cannot be compared with the + # z_order field in the Area message. The z-order may be negative or zero. # Corresponds to the JSON property `zOrder` # @return [Fixnum] attr_accessor :z_order @@ -464,8 +438,8 @@ module Google class Relation include Google::Apis::Core::Hashable - # Zero-based index to look up the related feature from the list of features - # in the tile. + # Zero-based index to look up the related feature from the list of features in + # the tile. # Corresponds to the JSON property `relatedFeatureIndex` # @return [Fixnum] attr_accessor :related_feature_index @@ -490,8 +464,8 @@ module Google class RoadInfo include Google::Apis::Core::Hashable - # Road has signage discouraging or prohibiting use by the general public. - # E.g., roads with signs that say "Private", or "No trespassing." + # Road has signage discouraging or prohibiting use by the general public. E.g., + # roads with signs that say "Private", or "No trespassing." # Corresponds to the JSON property `isPrivate` # @return [Boolean] attr_accessor :is_private @@ -507,18 +481,17 @@ module Google end end - # A row of altitude points in the elevation grid, ordered from west to - # east. + # A row of altitude points in the elevation grid, ordered from west to east. class Row include Google::Apis::Core::Hashable - # The difference between each successive pair of altitudes, from west to - # east. The first, westmost point, is just the altitude rather than a - # diff. The units are specified by the altitude_multiplier parameter - # above; the value in meters is given by altitude_multiplier * - # altitude_diffs[n]. The altitude row (in metres above sea level) can be - # reconstructed with: a[0] = altitude_diffs[0] * altitude_multiplier when - # n > 0, a[n] = a[n-1] + altitude_diffs[n-1] * altitude_multiplier. + # The difference between each successive pair of altitudes, from west to east. + # The first, westmost point, is just the altitude rather than a diff. The units + # are specified by the altitude_multiplier parameter above; the value in meters + # is given by altitude_multiplier * altitude_diffs[n]. The altitude row (in + # metres above sea level) can be reconstructed with: a[0] = altitude_diffs[0] * + # altitude_multiplier when n > 0, a[n] = a[n-1] + altitude_diffs[n-1] * + # altitude_multiplier. # Corresponds to the JSON property `altitudeDiffs` # @return [Array] attr_accessor :altitude_diffs @@ -534,35 +507,22 @@ module Google end # A packed representation of a 2D grid of uniformly spaced points containing - # elevation data. Each point within the grid represents the altitude in - # meters above average sea level at that location within the tile. - # Elevations provided are (generally) relative to the EGM96 geoid, however - # some areas will be relative to NAVD88. EGM96 and NAVD88 are off by no more - # than 2 meters. - # The grid is oriented north-west to south-east, as illustrated: - # rows[0].a[0] rows[0].a[m] - # +-----------------+ - # | | - # | N | - # | ^ | - # | | | - # | 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. + # elevation data. Each point within the grid represents the altitude in meters + # above average sea level at that location within the tile. Elevations provided + # are (generally) relative to the EGM96 geoid, however some areas will be + # relative to NAVD88. EGM96 and NAVD88 are off by no more than 2 meters. The + # grid is oriented north-west to south-east, as illustrated: rows[0].a[0] rows[0] + # .a[m] +-----------------+ | | | N | | ^ | | | | | 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 include Google::Apis::Core::Hashable - # A multiplier applied to the elements in the encoded data to extract the - # actual altitudes in meters. + # A multiplier applied to the elements in the encoded data to extract the actual + # altitudes in meters. # Corresponds to the JSON property `altitudeMultiplier` # @return [Float] attr_accessor :altitude_multiplier @@ -573,37 +533,29 @@ module Google # @return [Fixnum] attr_accessor :column_count - # A stream of elements each representing a point on the tile running across - # each row from left to right, top to bottom. - # There will be precisely horizontal_resolution * vertical_resolution - # elements in the stream. - # The elements are not the heights, rather the second order derivative of - # the values one would expect in a stream of height data. - # Each element is a varint with the following encoding: - # ------------------------------------------------------------------------| - # | Head Nibble | - # ------------------------------------------------------------------------| - # | Bit 0 | Bit 1 | Bits 2-3 | - # | Terminator| Sign (1=neg) | Least significant 2 bits of absolute error | - # ------------------------------------------------------------------------| - # | Tail Nibble #1 | - # ------------------------------------------------------------------------| - # | 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 | - # ------------------------------------------------------------------------| + # A stream of elements each representing a point on the tile running across each + # row from left to right, top to bottom. There will be precisely + # horizontal_resolution * vertical_resolution elements in the stream. The + # elements are not the heights, rather the second order derivative of the values + # one would expect in a stream of height data. Each element is a varint with the + # following encoding: ----------------------------------------------------------- + # -------------| | Head Nibble | ------------------------------------------------ + # ------------------------| | Bit 0 | Bit 1 | Bits 2-3 | | Terminator| Sign (1= + # neg) | Least significant 2 bits of absolute error | --------------------------- + # ---------------------------------------------| | Tail Nibble #1 | ------------- + # -----------------------------------------------------------| | 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` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :encoded_data - # The number of rows included in the encoded elevation data (i.e. the - # vertical resolution of the grid). + # The number of rows included in the encoded elevation data (i.e. the vertical + # resolution of the grid). # Corresponds to the JSON property `rowCount` # @return [Fixnum] attr_accessor :row_count @@ -646,85 +598,58 @@ module Google include Google::Apis::Core::Hashable # Global tile coordinates. Global tile coordinates reference a specific tile on - # the map at a specific zoom level. - # The origin of this coordinate system is always at the northwest corner of the - # map, with x values increasing from west to east and y values increasing from - # north to south. Tiles are indexed using x, y coordinates from that origin. - # The zoom level containing the entire world in a tile is 0, and it increases - # as you zoom in. Zoom level n + 1 will contain 4 times as many tiles as zoom - # level n. - # The zoom level controls the level of detail of the data that is returned. In - # particular, this affects the set of feature types returned, their density, - # and geometry simplification. The exact tile contents may change over time, - # but care will be taken to keep supporting the most important use cases. For - # example, zoom level 15 shows roads for orientation and planning in the local - # neighborhood and zoom level 17 shows buildings to give users on foot a sense - # of situational awareness. + # the map at a specific zoom level. The origin of this coordinate system is + # always at the northwest corner of the map, with x values increasing from west + # to east and y values increasing from north to south. Tiles are indexed using x, + # y coordinates from that origin. The zoom level containing the entire world in + # a tile is 0, and it increases as you zoom in. Zoom level n + 1 will contain 4 + # times as many tiles as zoom level n. The zoom level controls the level of + # detail of the data that is returned. In particular, this affects the set of + # feature types returned, their density, and geometry simplification. The exact + # tile contents may change over time, but care will be taken to keep supporting + # the most important use cases. For example, zoom level 15 shows roads for + # orientation and planning in the local neighborhood and zoom level 17 shows + # buildings to give users on foot a sense of situational awareness. # Corresponds to the JSON property `coordinates` # @return [Google::Apis::VectortileV1::TileCoordinates] attr_accessor :coordinates # A packed representation of a 2D grid of uniformly spaced points containing - # elevation data. Each point within the grid represents the altitude in - # meters above average sea level at that location within the tile. - # Elevations provided are (generally) relative to the EGM96 geoid, however - # some areas will be relative to NAVD88. EGM96 and NAVD88 are off by no more - # than 2 meters. - # The grid is oriented north-west to south-east, as illustrated: - # rows[0].a[0] rows[0].a[m] - # +-----------------+ - # | | - # | N | - # | ^ | - # | | | - # | 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. + # elevation data. Each point within the grid represents the altitude in meters + # above average sea level at that location within the tile. Elevations provided + # are (generally) relative to the EGM96 geoid, however some areas will be + # relative to NAVD88. EGM96 and NAVD88 are off by no more than 2 meters. The + # grid is oriented north-west to south-east, as illustrated: rows[0].a[0] rows[0] + # .a[m] +-----------------+ | | | N | | ^ | | | | | 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` # @return [Google::Apis::VectortileV1::FirstDerivativeElevationGrid] attr_accessor :first_derivative # Resource name of the tile. The tile resource name is prefixed by its - # collection ID `terrain/` followed by the resource ID, which encodes the - # tile's global x and y coordinates and zoom level as `@,,z`. - # For example, `terrain/@1,2,3z`. + # collection ID `terrain/` followed by the resource ID, which encodes the tile's + # global x and y coordinates and zoom level as `@,,z`. For example, `terrain/@1, + # 2,3z`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # A packed representation of a 2D grid of uniformly spaced points containing - # elevation data. Each point within the grid represents the altitude in - # meters above average sea level at that location within the tile. - # Elevations provided are (generally) relative to the EGM96 geoid, however - # some areas will be relative to NAVD88. EGM96 and NAVD88 are off by no more - # than 2 meters. - # The grid is oriented north-west to south-east, as illustrated: - # rows[0].a[0] rows[0].a[m] - # +-----------------+ - # | | - # | N | - # | ^ | - # | | | - # | 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. + # elevation data. Each point within the grid represents the altitude in meters + # above average sea level at that location within the tile. Elevations provided + # are (generally) relative to the EGM96 geoid, however some areas will be + # relative to NAVD88. EGM96 and NAVD88 are off by no more than 2 meters. The + # grid is oriented north-west to south-east, as illustrated: rows[0].a[0] rows[0] + # .a[m] +-----------------+ | | | N | | ^ | | | | | 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` # @return [Google::Apis::VectortileV1::SecondDerivativeElevationGrid] attr_accessor :second_derivative @@ -743,20 +668,18 @@ module Google end # Global tile coordinates. Global tile coordinates reference a specific tile on - # the map at a specific zoom level. - # The origin of this coordinate system is always at the northwest corner of the - # map, with x values increasing from west to east and y values increasing from - # north to south. Tiles are indexed using x, y coordinates from that origin. - # The zoom level containing the entire world in a tile is 0, and it increases - # as you zoom in. Zoom level n + 1 will contain 4 times as many tiles as zoom - # level n. - # The zoom level controls the level of detail of the data that is returned. In - # particular, this affects the set of feature types returned, their density, - # and geometry simplification. The exact tile contents may change over time, - # but care will be taken to keep supporting the most important use cases. For - # example, zoom level 15 shows roads for orientation and planning in the local - # neighborhood and zoom level 17 shows buildings to give users on foot a sense - # of situational awareness. + # the map at a specific zoom level. The origin of this coordinate system is + # always at the northwest corner of the map, with x values increasing from west + # to east and y values increasing from north to south. Tiles are indexed using x, + # y coordinates from that origin. The zoom level containing the entire world in + # a tile is 0, and it increases as you zoom in. Zoom level n + 1 will contain 4 + # times as many tiles as zoom level n. The zoom level controls the level of + # detail of the data that is returned. In particular, this affects the set of + # feature types returned, their density, and geometry simplification. The exact + # tile contents may change over time, but care will be taken to keep supporting + # the most important use cases. For example, zoom level 15 shows roads for + # orientation and planning in the local neighborhood and zoom level 17 shows + # buildings to give users on foot a sense of situational awareness. class TileCoordinates include Google::Apis::Core::Hashable @@ -788,14 +711,10 @@ module Google end # 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, - # with each vertex labeled with its index in the vertex_index array. - # (1)-----(3) - # / \ / \ - # / \ / \ - # / \ / \ - # (0)-----(2)-----(4) - # Vertices may be in either clockwise or counter-clockwise order. + # previous one. The following diagram shows an example of a triangle strip, with + # each vertex labeled with its index in the vertex_index array. (1)-----(3) / \ / + # \ / \ / \ / \ / \ (0)-----(2)-----(4) Vertices may be in either clockwise or + # counter-clockwise order. class TriangleStrip include Google::Apis::Core::Hashable @@ -816,9 +735,8 @@ module Google end # 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 - # (0, 0). - # For example, the list of vertices [(1,1), (2, 2), (1, 2)] would be encoded + # the previous one in local tile coordinates. The first entry is offset from (0, + # 0). 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)]. class Vertex2DList include Google::Apis::Core::Hashable diff --git a/generated/google/apis/vectortile_v1/service.rb b/generated/google/apis/vectortile_v1/service.rb index 0218ed5cc..fe9e29db3 100644 --- a/generated/google/apis/vectortile_v1/service.rb +++ b/generated/google/apis/vectortile_v1/service.rb @@ -49,73 +49,69 @@ module Google # Gets a feature tile by its tile resource name. # @param [String] name - # Required. Resource name of the tile. The tile resource name is prefixed by - # its collection ID `tiles/` followed by the resource ID, which encodes the - # tile's global x and y coordinates and zoom level as `@,,z`. - # For example, `tiles/@1,2,3z`. + # Required. Resource name of the tile. The tile resource name is prefixed by its + # collection ID `tiles/` followed by the resource ID, which encodes the tile's + # global x and y coordinates and zoom level as `@,,z`. For example, `tiles/@1,2, + # 3z`. # @param [String] client_info_api_client - # API client name and version. For example, the SDK calling the API. The - # exact format is up to the client. + # API client name and version. For example, the SDK calling the API. The exact + # format is up to the client. # @param [String] client_info_application_id - # Application ID, such as the package name on Android and the bundle - # identifier on iOS platforms. + # Application ID, such as the package name on Android and the bundle identifier + # on iOS platforms. # @param [String] client_info_application_version - # Application version number, such as "1.2.3". The exact format is - # application-dependent. + # Application version number, such as "1.2.3". The exact format is application- + # dependent. # @param [String] client_info_device_model - # Device model as reported by the device. The exact format is - # platform-dependent. + # Device model as reported by the device. The exact format is platform-dependent. # @param [String] client_info_operating_system - # Operating system name and version as reported by the OS. For example, - # "Mac OS X 10.10.4". The exact format is platform-dependent. + # Operating system name and version as reported by the OS. For example, "Mac OS + # X 10.10.4". The exact format is platform-dependent. # @param [String] client_info_platform # Platform where the application is running. # @param [String] client_info_user_id - # A client-generated user ID. The ID should be generated and persisted during - # the first user session or whenever a pre-existing ID is not found. The + # Required. A client-generated user ID. The ID should be generated and persisted + # 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 - # GetFeatureTileRequest (whether via the header or - # GetFeatureTileRequest.client_info). + # GetFeatureTileRequest (whether via the header or GetFeatureTileRequest. + # client_info). # @param [String] client_tile_version_id - # Optional version id identifying the tile that is already in the client's - # cache. This field should be populated with the most recent version_id value - # returned by the API for the requested tile. - # If the version id is empty the server always returns a newly rendered tile. - # If it is provided the server checks if the tile contents would be identical - # to one that's already on the client, and if so, returns a stripped-down - # response tile with STATUS_OK_DATA_UNCHANGED instead. + # Optional version id identifying the tile that is already in the client's cache. + # This field should be populated with the most recent version_id value returned + # by the API for the requested tile. If the version id is empty the server + # always returns a newly rendered tile. If it is provided the server checks if + # the tile contents would be identical to one that's already on the client, and + # if so, returns a stripped-down response tile with STATUS_OK_DATA_UNCHANGED + # instead. # @param [Boolean] enable_detailed_highway_types - # Flag indicating whether detailed highway types should be returned. If this - # is set, the CONTROLLED_ACCESS_HIGHWAY type may be returned. If not, then - # these highways will have the generic HIGHWAY type. - # This exists for backwards compatibility reasons. + # Flag indicating whether detailed highway types should be returned. If this is + # set, the CONTROLLED_ACCESS_HIGHWAY type may be returned. If not, then these + # highways will have the generic HIGHWAY type. This exists for backwards + # compatibility reasons. # @param [Boolean] enable_feature_names - # Flag indicating whether human-readable names should be returned for - # features. If this is set, the display_name field on the feature will be - # filled out. + # Flag indicating whether human-readable names should be returned for features. + # If this is set, the display_name field on the feature will be filled out. # @param [Boolean] enable_modeled_volumes - # Flag indicating whether 3D building models should be enabled. If this is - # set structures will be returned as 3D modeled volumes rather than 2.5D - # extruded areas where possible. + # Flag indicating whether 3D building models should be enabled. If this is set + # structures will be returned as 3D modeled volumes rather than 2.5D extruded + # areas where possible. # @param [Boolean] enable_political_features # Flag indicating whether political features should be returned. # @param [Boolean] enable_private_roads - # Flag indicating whether the returned tile will contain road features that - # are marked private. Private roads are indicated by the - # Feature.segment_info.road_info.is_private field. + # Flag indicating whether the returned tile will contain road features that are + # marked private. Private roads are indicated by the Feature.segment_info. + # road_info.is_private field. # @param [Boolean] enable_unclipped_buildings - # Flag indicating whether unclipped buildings should be returned. If this is - # set, building render ops will extend beyond the tile boundary. Buildings - # will only be returned on the tile that contains their centroid. + # Flag indicating whether unclipped buildings should be returned. If this is set, + # building render ops will extend beyond the tile boundary. Buildings will only + # be returned on the tile that contains their centroid. # @param [String] language_code - # Required. The BCP-47 language code corresponding to the language in which - # the name was requested, such as "en-US" or "sr-Latn". - # For more information, see + # Required. The BCP-47 language code corresponding to the language in which the + # name was requested, such as "en-US" or "sr-Latn". For more information, see # http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. # @param [String] region_code # Required. The Unicode country/region code (CLDR) of the location from which - # the request is coming from, such as "US" and "419". - # For more information, see + # the request is coming from, such as "US" and "419". For more information, see # http://www.unicode.org/reports/tr35/#unicode_region_subtag. # @param [String] fields # 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. # @param [String] name - # Required. Resource name of the tile. The tile resource name is prefixed by - # its collection ID `terraintiles/` followed by the resource ID, which - # encodes the tile's global x and y coordinates and zoom level as - # `@,,z`. For example, `terraintiles/@1,2,3z`. + # Required. Resource name of the tile. The tile resource name is prefixed by its + # collection ID `terraintiles/` followed by the resource ID, which encodes the + # tile's global x and y coordinates and zoom level as `@,,z`. For example, ` + # terraintiles/@1,2,3z`. # @param [Fixnum] altitude_precision_centimeters - # The precision of terrain altitudes in centimeters. - # Possible values: between 1 (cm level precision) and 1,000,000 (10-kilometer - # level precision). + # The precision of terrain altitudes in centimeters. Possible values: between 1 ( + # cm level precision) and 1,000,000 (10-kilometer level precision). # @param [String] client_info_api_client - # API client name and version. For example, the SDK calling the API. The - # exact format is up to the client. + # API client name and version. For example, the SDK calling the API. The exact + # format is up to the client. # @param [String] client_info_application_id - # Application ID, such as the package name on Android and the bundle - # identifier on iOS platforms. + # Application ID, such as the package name on Android and the bundle identifier + # on iOS platforms. # @param [String] client_info_application_version - # Application version number, such as "1.2.3". The exact format is - # application-dependent. + # Application version number, such as "1.2.3". The exact format is application- + # dependent. # @param [String] client_info_device_model - # Device model as reported by the device. The exact format is - # platform-dependent. + # Device model as reported by the device. The exact format is platform-dependent. # @param [String] client_info_operating_system - # Operating system name and version as reported by the OS. For example, - # "Mac OS X 10.10.4". The exact format is platform-dependent. + # Operating system name and version as reported by the OS. For example, "Mac OS + # X 10.10.4". The exact format is platform-dependent. # @param [String] client_info_platform # Platform where the application is running. # @param [String] client_info_user_id - # A client-generated user ID. The ID should be generated and persisted during - # the first user session or whenever a pre-existing ID is not found. The + # Required. A client-generated user ID. The ID should be generated and persisted + # 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 - # GetFeatureTileRequest (whether via the header or - # GetFeatureTileRequest.client_info). + # GetFeatureTileRequest (whether via the header or GetFeatureTileRequest. + # client_info). # @param [Fixnum] max_elevation_resolution_cells - # The maximum allowed resolution for the returned elevation heightmap. - # Possible values: between 1 and 1024 (and not less than - # min_elevation_resolution_cells). - # Over-sized heightmaps will be non-uniformly down-sampled such that each - # edge is no longer than this value. Non-uniformity is chosen to maximise the - # amount of preserved data. - # For example: - # Original resolution: 100px (width) * 30px (height) - # max_elevation_resolution: 30 - # New resolution: 30px (width) * 30px (height) + # The maximum allowed resolution for the returned elevation heightmap. Possible + # values: between 1 and 1024 (and not less than min_elevation_resolution_cells). + # Over-sized heightmaps will be non-uniformly down-sampled such that each edge + # is no longer than this value. Non-uniformity is chosen to maximise the amount + # of preserved data. For example: Original resolution: 100px (width) * 30px ( + # height) max_elevation_resolution: 30 New resolution: 30px (width) * 30px ( + # height) # @param [Fixnum] min_elevation_resolution_cells - # The minimum allowed resolution for the returned elevation heightmap. - # Possible values: between 0 and 1024 (and not more than - # max_elevation_resolution_cells). Zero is supported for backward - # compatibility. - # Under-sized heightmaps will be non-uniformly up-sampled - # such that each edge is no shorter than this value. Non-uniformity is chosen - # to maximise the amount of preserved data. - # For example: - # Original resolution: 30px (width) * 10px (height) - # min_elevation_resolution: 30 - # New resolution: 30px (width) * 30px (height) + # The minimum allowed resolution for the returned elevation heightmap. Possible + # values: between 0 and 1024 (and not more than max_elevation_resolution_cells). + # Zero is supported for backward compatibility. Under-sized heightmaps will be + # non-uniformly up-sampled such that each edge is no shorter than this value. + # Non-uniformity is chosen to maximise the amount of preserved data. For example: + # Original resolution: 30px (width) * 10px (height) min_elevation_resolution: + # 30 New resolution: 30px (width) * 30px (height) # @param [Array, String] terrain_formats # Terrain formats that the client understands. # @param [String] fields diff --git a/generated/google/apis/youtube_partner_v1.rb b/generated/google/apis/youtube_partner_v1.rb index 0ca7af29c..7c5379c3b 100644 --- a/generated/google/apis/youtube_partner_v1.rb +++ b/generated/google/apis/youtube_partner_v1.rb @@ -26,7 +26,7 @@ module Google # @see https://devsite.googleplex.com/youtube/partner/docs/v1/ module YoutubePartnerV1 VERSION = 'V1' - REVISION = '20200803' + REVISION = '20200807' # View and manage your assets and associated content on YouTube AUTH_YOUTUBEPARTNER = 'https://www.googleapis.com/auth/youtubepartner'