From b7c94d8355f00e2ba4916144749b690029374fd0 Mon Sep 17 00:00:00 2001 From: Steve Bazyl Date: Mon, 14 Dec 2015 14:27:57 -0800 Subject: [PATCH] Update generated APIs --- generated/google/apis/adexchangebuyer_v1_3.rb | 2 +- generated/google/apis/admin_directory_v1.rb | 8 +- .../google/apis/admin_directory_v1/classes.rb | 97 + .../admin_directory_v1/representations.rb | 32 + .../google/apis/admin_directory_v1/service.rb | 241 ++ generated/google/apis/adsense_v1_4.rb | 2 +- generated/google/apis/adsensehost_v4_1.rb | 2 +- generated/google/apis/analytics_v3.rb | 2 +- generated/google/apis/appsactivity_v1.rb | 2 +- generated/google/apis/appstate_v1.rb | 2 +- generated/google/apis/bigquery_v2.rb | 2 +- generated/google/apis/calendar_v3.rb | 2 +- .../google/apis/cloudmonitoring_v2beta2.rb | 2 +- .../apis/cloudresourcemanager_v1beta1.rb | 4 +- .../cloudresourcemanager_v1beta1/classes.rb | 50 +- .../cloudresourcemanager_v1beta1/service.rb | 110 +- generated/google/apis/cloudtrace_v1.rb | 6 +- .../google/apis/cloudtrace_v1/classes.rb | 58 +- .../google/apis/cloudtrace_v1/service.rb | 94 +- generated/google/apis/compute_v1.rb | 2 +- generated/google/apis/compute_v1/classes.rb | 860 +++++-- .../google/apis/compute_v1/representations.rb | 1 + generated/google/apis/compute_v1/service.rb | 2040 +++++++++++------ generated/google/apis/content_v2.rb | 2 +- generated/google/apis/content_v2/classes.rb | 19 +- .../google/apis/content_v2/representations.rb | 4 + generated/google/apis/deploymentmanager_v2.rb | 2 +- .../apis/deploymentmanager_v2/classes.rb | 88 +- .../deploymentmanager_v2/representations.rb | 1 + .../apis/deploymentmanager_v2/service.rb | 190 +- generated/google/apis/doubleclicksearch_v2.rb | 2 +- .../apis/doubleclicksearch_v2/classes.rb | 16 +- generated/google/apis/drive_v2.rb | 2 +- generated/google/apis/drive_v2/classes.rb | 23 +- generated/google/apis/drive_v3.rb | 55 + generated/google/apis/drive_v3/classes.rb | 1534 +++++++++++++ .../google/apis/drive_v3/representations.rb | 497 ++++ generated/google/apis/drive_v3/service.rb | 1541 +++++++++++++ .../games_configuration_v1configuration.rb | 2 +- .../apis/games_management_v1management.rb | 2 +- generated/google/apis/games_v1.rb | 2 +- generated/google/apis/games_v1/classes.rb | 27 + .../google/apis/games_v1/representations.rb | 12 + generated/google/apis/games_v1/service.rb | 36 + generated/google/apis/genomics_v1.rb | 8 +- generated/google/apis/genomics_v1/classes.rb | 321 ++- .../apis/genomics_v1/representations.rb | 55 + generated/google/apis/genomics_v1/service.rb | 99 +- generated/google/apis/licensing_v1.rb | 2 +- generated/google/apis/mapsengine_v1.rb | 2 +- generated/google/apis/mirror_v1.rb | 2 +- generated/google/apis/plus_domains_v1.rb | 2 +- generated/google/apis/plus_v1.rb | 2 +- generated/google/apis/sqladmin_v1beta4.rb | 2 +- generated/google/apis/storage_v1.rb | 2 +- generated/google/apis/youtube_analytics_v1.rb | 2 +- .../apis/youtube_analytics_v1/classes.rb | 6 + .../youtube_analytics_v1/representations.rb | 1 + .../apis/youtube_analytics_v1/service.rb | 7 +- generated/google/apis/youtube_v3.rb | 2 +- 60 files changed, 6804 insertions(+), 1389 deletions(-) create mode 100644 generated/google/apis/drive_v3.rb create mode 100644 generated/google/apis/drive_v3/classes.rb create mode 100644 generated/google/apis/drive_v3/representations.rb create mode 100644 generated/google/apis/drive_v3/service.rb diff --git a/generated/google/apis/adexchangebuyer_v1_3.rb b/generated/google/apis/adexchangebuyer_v1_3.rb index 0c1395f03..3cbdb8b0f 100644 --- a/generated/google/apis/adexchangebuyer_v1_3.rb +++ b/generated/google/apis/adexchangebuyer_v1_3.rb @@ -26,7 +26,7 @@ module Google # @see https://developers.google.com/ad-exchange/buyer-rest module AdexchangebuyerV1_3 VERSION = 'V1_3' - REVISION = '20151102' + REVISION = '20151209' # Manage your Ad Exchange buyer account configuration AUTH_ADEXCHANGE_BUYER = 'https://www.googleapis.com/auth/adexchange.buyer' diff --git a/generated/google/apis/admin_directory_v1.rb b/generated/google/apis/admin_directory_v1.rb index adc15a195..c417e11c6 100644 --- a/generated/google/apis/admin_directory_v1.rb +++ b/generated/google/apis/admin_directory_v1.rb @@ -26,7 +26,7 @@ module Google # @see https://developers.google.com/admin-sdk/directory/ module AdminDirectoryV1 VERSION = 'DirectoryV1' - REVISION = '20151005' + REVISION = '20151208' # View and manage customer related information AUTH_ADMIN_DIRECTORY_CUSTOMER = 'https://www.googleapis.com/auth/admin.directory.customer' @@ -76,6 +76,12 @@ module Google # View organization units on your domain AUTH_ADMIN_DIRECTORY_ORGUNIT_READONLY = 'https://www.googleapis.com/auth/admin.directory.orgunit.readonly' + # View and manage the provisioning of calendar resources on your domain + AUTH_ADMIN_DIRECTORY_RESOURCE_CALENDAR = 'https://www.googleapis.com/auth/admin.directory.resource.calendar' + + # View calendar resources on your domain + AUTH_ADMIN_DIRECTORY_RESOURCE_CALENDAR_READONLY = 'https://www.googleapis.com/auth/admin.directory.resource.calendar.readonly' + # Manage delegated admin roles for your domain AUTH_ADMIN_DIRECTORY_ROLEMANAGEMENT = 'https://www.googleapis.com/auth/admin.directory.rolemanagement' diff --git a/generated/google/apis/admin_directory_v1/classes.rb b/generated/google/apis/admin_directory_v1/classes.rb index 92cd5aa8e..d79e3e3b5 100644 --- a/generated/google/apis/admin_directory_v1/classes.rb +++ b/generated/google/apis/admin_directory_v1/classes.rb @@ -183,6 +183,103 @@ module Google end end + # JSON template for Calendar Resource object in Directory API. + class CalendarResource + include Google::Apis::Core::Hashable + + # ETag of the resource. + # Corresponds to the JSON property `etags` + # @return [String] + attr_accessor :etags + + # The type of the resource. For calendar resources, the value is admin#directory# + # resources#calendars#CalendarResource. + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # The brief description of the calendar resource. + # Corresponds to the JSON property `resourceDescription` + # @return [String] + attr_accessor :resource_description + + # The read-only email ID for the calendar resource. Generated as part of + # creating a new calendar resource. + # Corresponds to the JSON property `resourceEmail` + # @return [String] + attr_accessor :resource_email + + # The unique ID for the calendar resource. + # Corresponds to the JSON property `resourceId` + # @return [String] + attr_accessor :resource_id + + # The name of the calendar resource. For example, Training Room 1A + # Corresponds to the JSON property `resourceName` + # @return [String] + attr_accessor :resource_name + + # The type of the calendar resource. Used for grouping resources in the calendar + # user interface. + # Corresponds to the JSON property `resourceType` + # @return [String] + attr_accessor :resource_type + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @etags = args[:etags] unless args[:etags].nil? + @kind = args[:kind] unless args[:kind].nil? + @resource_description = args[:resource_description] unless args[:resource_description].nil? + @resource_email = args[:resource_email] unless args[:resource_email].nil? + @resource_id = args[:resource_id] unless args[:resource_id].nil? + @resource_name = args[:resource_name] unless args[:resource_name].nil? + @resource_type = args[:resource_type] unless args[:resource_type].nil? + end + end + + # JSON template for Calendar Resource List Response object in Directory API. + class CalendarResources + include Google::Apis::Core::Hashable + + # ETag of the resource. + # Corresponds to the JSON property `etag` + # @return [String] + attr_accessor :etag + + # The CalendarResources in this page of results. + # Corresponds to the JSON property `items` + # @return [Array] + attr_accessor :items + + # Identifies this as a collection of CalendarResources. This is always admin# + # directory#resources#calendars#calendarResourcesList. + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # The continuation token, used to page through large result sets. Provide this + # value in a subsequent request to return the next page of results. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @etag = args[:etag] unless args[:etag].nil? + @items = args[:items] unless args[:items].nil? + @kind = args[:kind] unless args[:kind].nil? + @next_page_token = args[:next_page_token] unless args[:next_page_token].nil? + end + end + # An notification channel used to watch for resource changes. class Channel 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 d6210ee67..7c480774c 100644 --- a/generated/google/apis/admin_directory_v1/representations.rb +++ b/generated/google/apis/admin_directory_v1/representations.rb @@ -38,6 +38,14 @@ module Google class Representation < Google::Apis::Core::JsonRepresentation; end end + class CalendarResource + class Representation < Google::Apis::Core::JsonRepresentation; end + end + + class CalendarResources + class Representation < Google::Apis::Core::JsonRepresentation; end + end + class Channel class Representation < Google::Apis::Core::JsonRepresentation; end end @@ -294,6 +302,30 @@ module Google end end + class CalendarResource + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :etags, as: 'etags' + property :kind, as: 'kind' + property :resource_description, as: 'resourceDescription' + property :resource_email, as: 'resourceEmail' + property :resource_id, as: 'resourceId' + property :resource_name, as: 'resourceName' + property :resource_type, as: 'resourceType' + end + end + + class CalendarResources + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :etag, as: 'etag' + collection :items, as: 'items', class: Google::Apis::AdminDirectoryV1::CalendarResource, decorator: Google::Apis::AdminDirectoryV1::CalendarResource::Representation + + property :kind, as: 'kind' + property :next_page_token, as: 'nextPageToken' + end + end + class Channel # @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 26338ad9e..b9b8561c8 100644 --- a/generated/google/apis/admin_directory_v1/service.rb +++ b/generated/google/apis/admin_directory_v1/service.rb @@ -2017,6 +2017,247 @@ module Google execute_or_queue_command(command, &block) end + # Deletes a calendar resource. + # @param [String] customer + # The unique ID for the customer's Google account. As an account administrator, + # you can also use the my_customer alias to represent your account's customer ID. + # @param [String] calendar_resource_id + # The unique ID of the calendar resource to delete. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [NilClass] No result returned for this method + # @yieldparam err [StandardError] error object if request failed + # + # @return [void] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_resource_calendar(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) + 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 + + # Retrieves a calendar resource. + # @param [String] customer + # The unique ID for the customer's Google account. As an account administrator, + # you can also use the my_customer alias to represent your account's customer ID. + # @param [String] calendar_resource_id + # The unique ID of the calendar resource to retrieve. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::AdminDirectoryV1::CalendarResource] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::AdminDirectoryV1::CalendarResource] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @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_calendar(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) + 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 + + # Inserts a calendar resource. + # @param [String] customer + # The unique ID for the customer's Google account. As an account administrator, + # you can also use the my_customer alias to represent your account's customer ID. + # @param [Google::Apis::AdminDirectoryV1::CalendarResource] calendar_resource_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::AdminDirectoryV1::CalendarResource] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::AdminDirectoryV1::CalendarResource] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_calendar(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) + command.request_representation = Google::Apis::AdminDirectoryV1::CalendarResource::Representation + command.request_object = calendar_resource_object + command.response_representation = Google::Apis::AdminDirectoryV1::CalendarResource::Representation + command.response_class = Google::Apis::AdminDirectoryV1::CalendarResource + 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 + + # Retrieves a list of calendar resources for an account. + # @param [String] customer + # The unique ID for the customer's Google account. As an account administrator, + # you can also use the my_customer alias to represent your account's customer ID. + # @param [Fixnum] max_results + # Maximum number of results to return. + # @param [String] page_token + # Token to specify the next page in the list. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::AdminDirectoryV1::CalendarResources] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::AdminDirectoryV1::CalendarResources] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @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_calendars(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/calendars', options) + command.response_representation = Google::Apis::AdminDirectoryV1::CalendarResources::Representation + command.response_class = Google::Apis::AdminDirectoryV1::CalendarResources + command.params['customer'] = customer unless customer.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 calendar resource. This method supports patch semantics. + # @param [String] customer + # The unique ID for the customer's Google account. As an account administrator, + # you can also use the my_customer alias to represent your account's customer ID. + # @param [String] calendar_resource_id + # The unique ID of the calendar resource to update. + # @param [Google::Apis::AdminDirectoryV1::CalendarResource] calendar_resource_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::AdminDirectoryV1::CalendarResource] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::AdminDirectoryV1::CalendarResource] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_calendar(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) + command.request_representation = Google::Apis::AdminDirectoryV1::CalendarResource::Representation + command.request_object = calendar_resource_object + 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 + + # Updates a calendar resource. + # @param [String] customer + # The unique ID for the customer's Google account. As an account administrator, + # you can also use the my_customer alias to represent your account's customer ID. + # @param [String] calendar_resource_id + # The unique ID of the calendar resource to update. + # @param [Google::Apis::AdminDirectoryV1::CalendarResource] calendar_resource_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::AdminDirectoryV1::CalendarResource] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::AdminDirectoryV1::CalendarResource] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_calendar(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) + command.request_representation = Google::Apis::AdminDirectoryV1::CalendarResource::Representation + command.request_object = calendar_resource_object + 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 + # Deletes a role assignment. # @param [String] customer # Immutable ID of the Google Apps account. diff --git a/generated/google/apis/adsense_v1_4.rb b/generated/google/apis/adsense_v1_4.rb index 3da869556..80dc58c7a 100644 --- a/generated/google/apis/adsense_v1_4.rb +++ b/generated/google/apis/adsense_v1_4.rb @@ -26,7 +26,7 @@ module Google # @see https://developers.google.com/adsense/management/ module AdsenseV1_4 VERSION = 'V1_4' - REVISION = '20151127' + REVISION = '20151206' # View and manage your AdSense data AUTH_ADSENSE = 'https://www.googleapis.com/auth/adsense' diff --git a/generated/google/apis/adsensehost_v4_1.rb b/generated/google/apis/adsensehost_v4_1.rb index 32aa690e4..51e8a8926 100644 --- a/generated/google/apis/adsensehost_v4_1.rb +++ b/generated/google/apis/adsensehost_v4_1.rb @@ -26,7 +26,7 @@ module Google # @see https://developers.google.com/adsense/host/ module AdsensehostV4_1 VERSION = 'V4_1' - REVISION = '20151127' + REVISION = '20151206' # View and manage your AdSense host data and associated accounts AUTH_ADSENSEHOST = 'https://www.googleapis.com/auth/adsensehost' diff --git a/generated/google/apis/analytics_v3.rb b/generated/google/apis/analytics_v3.rb index 386893f5a..ffe09fb04 100644 --- a/generated/google/apis/analytics_v3.rb +++ b/generated/google/apis/analytics_v3.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/analytics/ module AnalyticsV3 VERSION = 'V3' - REVISION = '20151030' + REVISION = '20151124' # View and manage your Google Analytics data AUTH_ANALYTICS = 'https://www.googleapis.com/auth/analytics' diff --git a/generated/google/apis/appsactivity_v1.rb b/generated/google/apis/appsactivity_v1.rb index dab295b88..02f08dcd7 100644 --- a/generated/google/apis/appsactivity_v1.rb +++ b/generated/google/apis/appsactivity_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/google-apps/activity/ module AppsactivityV1 VERSION = 'V1' - REVISION = '20150326' + REVISION = '20150417' # View the activity history of your Google Apps AUTH_ACTIVITY = 'https://www.googleapis.com/auth/activity' diff --git a/generated/google/apis/appstate_v1.rb b/generated/google/apis/appstate_v1.rb index 89fbdaac9..878fe45ec 100644 --- a/generated/google/apis/appstate_v1.rb +++ b/generated/google/apis/appstate_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/games/services/web/api/states module AppstateV1 VERSION = 'V1' - REVISION = '20151125' + REVISION = '20151202' # View and manage your data for this application AUTH_APPSTATE = 'https://www.googleapis.com/auth/appstate' diff --git a/generated/google/apis/bigquery_v2.rb b/generated/google/apis/bigquery_v2.rb index 13ccfe296..a1d26c6aa 100644 --- a/generated/google/apis/bigquery_v2.rb +++ b/generated/google/apis/bigquery_v2.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/bigquery/ module BigqueryV2 VERSION = 'V2' - REVISION = '20151116' + REVISION = '20151208' # View and manage your data in Google BigQuery AUTH_BIGQUERY = 'https://www.googleapis.com/auth/bigquery' diff --git a/generated/google/apis/calendar_v3.rb b/generated/google/apis/calendar_v3.rb index 9ba3f3e2e..c393f36e6 100644 --- a/generated/google/apis/calendar_v3.rb +++ b/generated/google/apis/calendar_v3.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/google-apps/calendar/firstapp module CalendarV3 VERSION = 'V3' - REVISION = '20151122' + REVISION = '20151206' # Manage your calendars AUTH_CALENDAR = 'https://www.googleapis.com/auth/calendar' diff --git a/generated/google/apis/cloudmonitoring_v2beta2.rb b/generated/google/apis/cloudmonitoring_v2beta2.rb index 53d7e6ffe..57b437be6 100644 --- a/generated/google/apis/cloudmonitoring_v2beta2.rb +++ b/generated/google/apis/cloudmonitoring_v2beta2.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/monitoring/v2beta2/ module CloudmonitoringV2beta2 VERSION = 'V2beta2' - REVISION = '20151130' + REVISION = '20151206' # 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/cloudresourcemanager_v1beta1.rb b/generated/google/apis/cloudresourcemanager_v1beta1.rb index 30d5778c7..e8490f993 100644 --- a/generated/google/apis/cloudresourcemanager_v1beta1.rb +++ b/generated/google/apis/cloudresourcemanager_v1beta1.rb @@ -21,12 +21,12 @@ module Google # Google Cloud Resource Manager API # # The Google Cloud Resource Manager API provides methods for creating, reading, - # and updating of project metadata. + # and updating project metadata. # # @see https://cloud.google.com/resource-manager module CloudresourcemanagerV1beta1 VERSION = 'V1beta1' - REVISION = '20151117' + REVISION = '20151211' # 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/cloudresourcemanager_v1beta1/classes.rb b/generated/google/apis/cloudresourcemanager_v1beta1/classes.rb index 0fb0b3993..c520ebbda 100644 --- a/generated/google/apis/cloudresourcemanager_v1beta1/classes.rb +++ b/generated/google/apis/cloudresourcemanager_v1beta1/classes.rb @@ -32,19 +32,19 @@ module Google # @return [String] attr_accessor :project_number - # The unique, user-assigned ID of the project. It must be 6 to 30 lowercase + # The unique, user-assigned ID of the Project. It must be 6 to 30 lowercase # letters, digits, or hyphens. It must start with a letter. Trailing hyphens are # prohibited. Example: tokyo-rain-123 Read-only after creation. # Corresponds to the JSON property `projectId` # @return [String] attr_accessor :project_id - # The project lifecycle state. Read-only. + # The Project lifecycle state. Read-only. # Corresponds to the JSON property `lifecycleState` # @return [String] attr_accessor :lifecycle_state - # The user-assigned name of the project. It must be 4 to 30 characters. Allowed + # The user-assigned name of the Project. It must be 4 to 30 characters. Allowed # characters are: lowercase and uppercase letters, numbers, hyphen, single-quote, # double-quote, space, and exclamation point. Example: My Project Read-write. # Corresponds to the JSON property `name` @@ -56,7 +56,7 @@ module Google # @return [String] attr_accessor :create_time - # The labels associated with this project. Label keys must be between 1 and 63 + # The labels associated with this Project. Label keys must be between 1 and 63 # characters long and must conform to the following regular expression: \[a-z\](\ # [-a-z0-9\]*\[a-z0-9\])?. Label values must be between 0 and 63 characters long # and must conform to the regular expression (\[a-z\](\[-a-z0-9\]*\[a-z0-9\])?)?. @@ -68,10 +68,10 @@ module Google # @return [Hash] attr_accessor :labels - # A container to reference an id for any resource type. A 'resource' in Google + # A container to reference an id for any resource type. A `resource` in Google # Cloud Platform is a generic term for something you (a developer) may want to # interact with through one of our API's. Some examples are an AppEngine app, a - # Compute Engine instance, Cloud SQL database, ... + # Compute Engine instance, a Cloud SQL database, and so on. # Corresponds to the JSON property `parent` # @return [Google::Apis::CloudresourcemanagerV1beta1::ResourceId] attr_accessor :parent @@ -92,10 +92,10 @@ module Google end end - # A container to reference an id for any resource type. A 'resource' in Google + # A container to reference an id for any resource type. A `resource` in Google # Cloud Platform is a generic term for something you (a developer) may want to # interact with through one of our API's. Some examples are an AppEngine app, a - # Compute Engine instance, Cloud SQL database, ... + # Compute Engine instance, a Cloud SQL database, and so on. class ResourceId include Google::Apis::Core::Hashable @@ -128,7 +128,7 @@ module Google class ListProjectsResponse include Google::Apis::Core::Hashable - # The list of projects that matched the list filter. This list can be paginated. + # The list of Projects that matched the list filter. This list can be paginated. # Corresponds to the JSON property `projects` # @return [Array] attr_accessor :projects @@ -197,9 +197,7 @@ module Google class Policy include Google::Apis::Core::Hashable - # Version of the `Policy`. The default version is 0. 0 = - # resourcemanager_projects only support legacy roles. 1 = supports non-legacy - # roles 2 = supports AuditConfig + # Version of the `Policy`. The default version is 0. # Corresponds to the JSON property `version` # @return [Fixnum] attr_accessor :version @@ -211,12 +209,14 @@ module Google # @return [Array] attr_accessor :bindings - # The etag is used for optimistic concurrency control as a way to help prevent + # `etag` is used for optimistic concurrency control as a way to help prevent # simultaneous updates of a policy from overwriting each other. It is strongly - # suggested that systems make use of the etag in the read-modify-write cycle to - # perform policy updates in order to avoid race conditions. If no etag is - # provided in the call to SetIamPolicy, then the existing policy is overwritten - # blindly. + # suggested that systems make use of the `etag` in the read-modify-write cycle + # to perform policy updates in order to avoid race conditions: An `etag` is + # returned in the response to `getIamPolicy`, and systems are expected to put + # that etag in the request to `setIamPolicy` to ensure that their change will be + # applied to the same version of the policy. If no `etag` is provided in the + # call to `setIamPolicy`, then the existing policy is overwritten blindly. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag @@ -244,7 +244,7 @@ module Google attr_accessor :role # Specifies the identities requesting access for a Cloud Platform resource. ` - # members` can have the following formats: * `allUsers`: A special identifier + # members` can have the following values: * `allUsers`: A special identifier # that represents anyone who is on the internet; with or without a Google # account. * `allAuthenticatedUsers`: A special identifier that represents # anyone who is authenticated with a Google account or a service account. * ` @@ -337,7 +337,7 @@ module Google end end - # The response returned from the ListOrganizations method. + # The response returned from the `ListOrganizations` method. class ListOrganizationsResponse include Google::Apis::Core::Hashable @@ -384,9 +384,9 @@ module Google attr_accessor :display_name # The entity that owns an Organization. The lifetime of the Organization and all - # of its descendants are bound to the OrganizationOwner. If the - # OrganizationOwner is deleted, the Organization and all its descendants will be - # deleted. + # of its descendants are bound to the `OrganizationOwner`. If the ` + # OrganizationOwner` is deleted, the Organization and all its descendants will + # be deleted. # Corresponds to the JSON property `owner` # @return [Google::Apis::CloudresourcemanagerV1beta1::OrganizationOwner] attr_accessor :owner @@ -411,9 +411,9 @@ module Google end # The entity that owns an Organization. The lifetime of the Organization and all - # of its descendants are bound to the OrganizationOwner. If the - # OrganizationOwner is deleted, the Organization and all its descendants will be - # deleted. + # of its descendants are bound to the `OrganizationOwner`. If the ` + # OrganizationOwner` is deleted, the Organization and all its descendants will + # be deleted. class OrganizationOwner include Google::Apis::Core::Hashable diff --git a/generated/google/apis/cloudresourcemanager_v1beta1/service.rb b/generated/google/apis/cloudresourcemanager_v1beta1/service.rb index 9d0cfb86d..baf2763e9 100644 --- a/generated/google/apis/cloudresourcemanager_v1beta1/service.rb +++ b/generated/google/apis/cloudresourcemanager_v1beta1/service.rb @@ -23,7 +23,7 @@ module Google # Google Cloud Resource Manager API # # The Google Cloud Resource Manager API provides methods for creating, reading, - # and updating of project metadata. + # and updating project metadata. # # @example # require 'google/apis/cloudresourcemanager_v1beta1' @@ -47,10 +47,10 @@ module Google super('https://cloudresourcemanager.googleapis.com/', '') end - # Creates a project resource. Initially, the project resource is owned by its + # Creates a Project resource. Initially, the Project resource is owned by its # creator exclusively. The creator can later grant permission to others to read - # or update the project. Several APIs are activated automatically for the - # project, including Google Cloud Storage. + # or update the Project. Several APIs are activated automatically for the + # Project, including Google Cloud Storage. # @param [Google::Apis::CloudresourcemanagerV1beta1::Project] project_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -80,15 +80,15 @@ module Google execute_or_queue_command(command, &block) end - # Lists projects that are visible to the user and satisfy the specified filter. - # This method returns projects in an unspecified order. New projects do not + # Lists Projects that are visible to the user and satisfy the specified filter. + # This method returns Projects in an unspecified order. New Projects do not # necessarily appear at the end of the list. # @param [String] page_token - # A pagination token returned from a previous call to ListProject that indicates - # from where listing should continue. Optional. + # A pagination token returned from a previous call to ListProjects that + # indicates from where listing should continue. Optional. # @param [Fixnum] page_size # The maximum number of Projects to return in the response. The server can - # return fewer projects than requested. If unspecified, server picks an + # return fewer Projects than requested. If unspecified, server picks an # appropriate default. Optional. # @param [String] filter # An expression for filtering the results of the request. Filter rules are case @@ -129,10 +129,10 @@ module Google execute_or_queue_command(command, &block) end - # Retrieves the project identified by the specified `project_id` (for example, ` - # my-project-123`). The caller must have read permissions for this project. + # Retrieves the Project identified by the specified `project_id` (for example, ` + # my-project-123`). The caller must have read permissions for this Project. # @param [String] project_id - # The project ID (for example, `my-project-123`). Required. + # The Project ID (for example, `my-project-123`). Required. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -160,9 +160,9 @@ module Google execute_or_queue_command(command, &block) end - # Updates the attributes of the project identified by the specified `project_id` + # Updates the attributes of the Project identified by the specified `project_id` # (for example, `my-project-123`). The caller must have modify permissions for - # this project. + # this Project. # @param [String] project_id # The project ID (for example, `my-project-123`). Required. # @param [Google::Apis::CloudresourcemanagerV1beta1::Project] project_object @@ -195,20 +195,20 @@ module Google execute_or_queue_command(command, &block) end - # Marks the project identified by the specified `project_id` (for example, `my- - # project-123`) for deletion. This method will only affect the project if the - # following criteria are met: + The project does not have a billing account - # associated with it. + The project has a lifecycle state of ACTIVE. This method - # changes the project's lifecycle state from ACTIVE to DELETE_REQUESTED. The + # Marks the Project identified by the specified `project_id` (for example, `my- + # project-123`) for deletion. This method will only affect the Project if the + # following criteria are met: + The Project does not have a billing account + # associated with it. + The Project has a lifecycle state of ACTIVE. This method + # changes the Project's lifecycle state from ACTIVE to DELETE_REQUESTED. The # deletion starts at an unspecified time, at which point the lifecycle state # changes to DELETE_IN_PROGRESS. Until the deletion completes, you can check the - # lifecycle state checked by retrieving the project with GetProject, and the - # project remains visible to ListProjects. However, you cannot update the - # project. After the deletion completes, the project is not retrievable by the + # lifecycle state checked by retrieving the Project with GetProject, and the + # Project remains visible to ListProjects. However, you cannot update the + # project. After the deletion completes, the Project is not retrievable by the # GetProject and ListProjects methods. The caller must have modify permissions - # for this project. + # for this Project. # @param [String] project_id - # The project ID (for example, `foo-bar-123`). Required. + # The Project ID (for example, `foo-bar-123`). Required. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -236,11 +236,11 @@ module Google execute_or_queue_command(command, &block) end - # Restores the project identified by the specified `project_id` (for example, ` - # my-project-123`). You can only use this method for a project that has a + # Restores the Project identified by the specified `project_id` (for example, ` + # my-project-123`). You can only use this method for a Project that has a # lifecycle state of DELETE_REQUESTED. After deletion starts, as indicated by a - # lifecycle state of DELETE_IN_PROGRESS, the project cannot be restored. The - # caller must have modify permissions for this project. + # lifecycle state of DELETE_IN_PROGRESS, the Project cannot be restored. The + # caller must have modify permissions for this Project. # @param [String] project_id # The project ID (for example, `foo-bar-123`). Required. # @param [String] fields @@ -270,12 +270,13 @@ module Google execute_or_queue_command(command, &block) end - # Returns the IAM access control policy for specified project. + # Returns the IAM access control policy for the specified Project. Permission is + # denied if the policy or the resource does not exist. # @param [String] resource # REQUIRED: The resource for which policy is being requested. `resource` is # usually specified as a path, such as, `projects/`project`/zones/`zone`/disks/` # disk``. The format for the path specified in this value is resource specific - # and is specified in the documentation for the respective GetIamPolicy rpc. + # and is specified in the `getIamPolicy` documentation. # @param [Google::Apis::CloudresourcemanagerV1beta1::GetIamPolicyRequest] get_iam_policy_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -306,14 +307,24 @@ module Google execute_or_queue_command(command, &block) end - # Sets the IAM access control policy for the specified project. We do not - # currently support 'domain:' prefixed members in a Binding of a Policy. Calling - # this method requires enabling the App Engine Admin API. + # Sets the IAM access control policy for the specified Project. Replaces any + # existing policy. The following constraints apply when using `setIamPolicy()`: + + # Project currently supports only `user:`emailid`` and `serviceAccount:`emailid` + # ` members in a `Binding` of a `Policy`. + To be added as an `owner`, a user + # must be invited via Cloud Platform console and must accept the invitation. + + # Members cannot be added to more than one role in the same policy. + There must + # be at least one owner who has accepted the Terms of Service (ToS) agreement in + # the policy. Calling `setIamPolicy()` to to remove the last ToS-accepted owner + # from the policy will fail. + Calling this method requires enabling the App + # Engine Admin API. Note: Removing service accounts from policies or changing + # their roles can render services completely inoperable. It is important to + # understand how the service account is being used before removing or updating + # its roles. # @param [String] resource # REQUIRED: The resource for which policy is being specified. `resource` is # usually specified as a path, such as, `projects/`project`/zones/`zone`/disks/` # disk``. The format for the path specified in this value is resource specific - # and is specified in the documentation for the respective SetIamPolicy rpc. + # and is specified in the `setIamPolicy` documentation. # @param [Google::Apis::CloudresourcemanagerV1beta1::SetIamPolicyRequest] set_iam_policy_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -344,14 +355,12 @@ module Google execute_or_queue_command(command, &block) end - # Tests the specified permissions against the IAM access control policy for the - # specified project. + # Returns permissions that a caller has on the specified Project. # @param [String] resource # REQUIRED: The resource for which policy detail is being requested. `resource` # is usually specified as a path, such as, `projects/`project`/zones/`zone`/ # disks/`disk``. The format for the path specified in this value is resource - # specific and is specified in the documentation for the respective - # TestIamPermissions rpc. + # specific and is specified in the `testIamPermissions` documentation. rpc. # @param [Google::Apis::CloudresourcemanagerV1beta1::TestIamPermissionsRequest] test_iam_permissions_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -382,15 +391,17 @@ module Google execute_or_queue_command(command, &block) end - # Query Organization resources. + # Lists Organization resources that are visible to the user and satisfy the + # specified filter. This method returns Organizations in an unspecified order. + # New Organizations do not necessarily appear at the end of the list. # @param [Fixnum] page_size # The maximum number of Organizations to return in the response. This field is # optional. # @param [String] page_token - # A pagination token returned from a previous call to ListOrganizations that + # A pagination token returned from a previous call to `ListOrganizations` that # indicates from where listing should continue. This field is optional. # @param [String] filter - # An optional query string used to filter the Organizations to be return in the + # An optional query string used to filter the Organizations to return in the # response. Filter rules are case-insensitive. Organizations may be filtered by ` # owner.directoryCustomerId` or by `domain`, where the domain is a Google for # Work domain, for example: |Filter|Description| |------|-----------| |owner. @@ -426,7 +437,7 @@ module Google execute_or_queue_command(command, &block) end - # Fetches an Organization resource by id. + # Fetches an Organization resource identified by the specified `organization_id`. # @param [String] organization_id # The id of the Organization resource to fetch. # @param [String] fields @@ -456,7 +467,7 @@ module Google execute_or_queue_command(command, &block) end - # Updates an Organization resource. + # Updates an Organization resource identified by the specified `organization_id`. # @param [String] organization_id # An immutable id for the Organization that is assigned on creation. This should # be omitted when creating a new Organization. This field is read-only. @@ -490,13 +501,13 @@ module Google execute_or_queue_command(command, &block) end - # Sets the access control policy on a Organization resource. Replaces any + # Sets the access control policy on an Organization resource. Replaces any # existing policy. # @param [String] resource # REQUIRED: The resource for which policy is being specified. `resource` is # usually specified as a path, such as, `projects/`project`/zones/`zone`/disks/` # disk``. The format for the path specified in this value is resource specific - # and is specified in the documentation for the respective SetIamPolicy rpc. + # and is specified in the `setIamPolicy` documentation. # @param [Google::Apis::CloudresourcemanagerV1beta1::SetIamPolicyRequest] set_iam_policy_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -527,13 +538,13 @@ module Google execute_or_queue_command(command, &block) end - # Gets the access control policy for a Organization resource. May be empty if no - # such policy or resource exists. + # Gets the access control policy for an Organization resource. May be empty if + # no such policy or resource exists. # @param [String] resource # REQUIRED: The resource for which policy is being requested. `resource` is # usually specified as a path, such as, `projects/`project`/zones/`zone`/disks/` # disk``. The format for the path specified in this value is resource specific - # and is specified in the documentation for the respective GetIamPolicy rpc. + # and is specified in the `getIamPolicy` documentation. # @param [Google::Apis::CloudresourcemanagerV1beta1::GetIamPolicyRequest] get_iam_policy_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -569,8 +580,7 @@ module Google # REQUIRED: The resource for which policy detail is being requested. `resource` # is usually specified as a path, such as, `projects/`project`/zones/`zone`/ # disks/`disk``. The format for the path specified in this value is resource - # specific and is specified in the documentation for the respective - # TestIamPermissions rpc. + # specific and is specified in the `testIamPermissions` documentation. rpc. # @param [Google::Apis::CloudresourcemanagerV1beta1::TestIamPermissionsRequest] test_iam_permissions_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. diff --git a/generated/google/apis/cloudtrace_v1.rb b/generated/google/apis/cloudtrace_v1.rb index 454d5e22b..1ded3e0a9 100644 --- a/generated/google/apis/cloudtrace_v1.rb +++ b/generated/google/apis/cloudtrace_v1.rb @@ -20,13 +20,13 @@ module Google module Apis # Google Cloud Trace API # - # The Google Cloud Trace API provides services for reading and writing runtime - # trace data for Cloud applications. + # The Cloud Trace API allows you to send traces to and retrieve traces from + # Google Cloud Trace. # # @see https://cloud.google.com/tools/cloud-trace module CloudtraceV1 VERSION = 'V1' - REVISION = '20150825' + REVISION = '20151207' # 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/cloudtrace_v1/classes.rb b/generated/google/apis/cloudtrace_v1/classes.rb index 0212d0932..719458a3b 100644 --- a/generated/google/apis/cloudtrace_v1/classes.rb +++ b/generated/google/apis/cloudtrace_v1/classes.rb @@ -22,17 +22,18 @@ module Google module Apis module CloudtraceV1 - # The response message for the ListTraces method. + # The response message for the `ListTraces` method. class ListTracesResponse include Google::Apis::Core::Hashable - # The list of trace records returned. + # List of trace records returned. # Corresponds to the JSON property `traces` # @return [Array] attr_accessor :traces - # If defined, indicates that there are more topics that match the request, and - # this value should be passed to the next ListTopicsRequest to continue. + # If defined, indicates that there are more traces that match the request and + # that this value should be passed to the next request to continue retrieving + # additional traces. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -48,24 +49,24 @@ module Google end end - # A Trace is a collection of spans describing the execution timings of a single - # operation. + # A trace describes how long it takes for an application to perform an operation. + # It consists of a set of spans, each of which represent a single timed event + # within the operation. class Trace include Google::Apis::Core::Hashable - # The Project ID of the Google Cloud project. + # Project ID of the Cloud project where the trace data is stored. # Corresponds to the JSON property `projectId` # @return [String] attr_accessor :project_id - # A 128-bit numeric value, formatted as a 32-byte hex string, that represents a - # trace. Each trace should have an identifier that is globally unique. + # Globally unique identifier for the trace. This identifier is a 128-bit numeric + # value formatted as a 32-byte hex string. # Corresponds to the JSON property `traceId` # @return [String] attr_accessor :trace_id - # The collection of span records within this trace. Spans that appear in calls - # to PatchTraces may be incomplete or partial. + # Collection of spans in the trace. # Corresponds to the JSON property `spans` # @return [Array] attr_accessor :spans @@ -82,48 +83,51 @@ module Google end end - # A span is the data recorded with a single span. + # A span represents a single timed event within a trace. Spans can be nested and + # form a trace tree. Often, a trace contains a root span that describes the end- + # to-end latency of an operation and, optionally, one or more subspans for its + # suboperations. Spans do not need to be contiguous. There may be gaps between + # spans in a trace. class TraceSpan include Google::Apis::Core::Hashable - # Identifier of the span within the trace. Each span should have an identifier - # that is unique per trace. + # Identifier for the span. This identifier must be unique within a trace. # Corresponds to the JSON property `spanId` # @return [String] attr_accessor :span_id - # SpanKind distinguishes spans generated in a particular context. For example, - # two spans with the same name, one with the kind RPC_CLIENT, and the other with - # RPC_SERVER can indicate the queueing latency associated with the span. + # Distinguishes between spans generated in a particular context. For example, + # two spans with the same name may be distinguished using `RPC_CLIENT` and ` + # RPC_SERVER` to identify queueing latency associated with the span. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # The name of the trace. This is sanitized and displayed on the UI. This may be - # a method name or some other per-callsite name. For the same binary and the - # same call point, it is a good practice to choose a consistent name in order to + # Name of the trace. The trace name is sanitized and displayed in the Cloud + # Trace tool in the Google Developers Console. The name may be a method name or + # some other per-call site name. For the same executable and the same call point, + # a best practice is to use a consistent name, which makes it easier to # correlate cross-trace spans. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # The start time of the span in nanoseconds from the UNIX epoch. + # Start time of the span in nanoseconds from the UNIX epoch. # Corresponds to the JSON property `startTime` # @return [String] attr_accessor :start_time - # The end time of the span in nanoseconds from the UNIX epoch. + # End time of the span in nanoseconds from the UNIX epoch. # Corresponds to the JSON property `endTime` # @return [String] attr_accessor :end_time - # Identifies the parent of the current span. May be missing. Serialized bytes - # representation of SpanId. + # ID of the parent span, if any. Optional. # Corresponds to the JSON property `parentSpanId` # @return [String] attr_accessor :parent_span_id - # Annotations via labels. + # Collection of labels associated with the span. # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels @@ -144,11 +148,11 @@ module Google end end - # A list of traces for the PatchTraces method. + # List of new or updated traces. class Traces include Google::Apis::Core::Hashable - # A list of traces. + # List of traces. # Corresponds to the JSON property `traces` # @return [Array] attr_accessor :traces diff --git a/generated/google/apis/cloudtrace_v1/service.rb b/generated/google/apis/cloudtrace_v1/service.rb index fb2ccec70..874ea707c 100644 --- a/generated/google/apis/cloudtrace_v1/service.rb +++ b/generated/google/apis/cloudtrace_v1/service.rb @@ -22,8 +22,8 @@ module Google module CloudtraceV1 # Google Cloud Trace API # - # The Google Cloud Trace API provides services for reading and writing runtime - # trace data for Cloud applications. + # The Cloud Trace API allows you to send traces to and retrieve traces from + # Google Cloud Trace. # # @example # require 'google/apis/cloudtrace_v1' @@ -47,12 +47,13 @@ module Google super('https://cloudtrace.googleapis.com/', '') end - # Updates the existing traces specified by PatchTracesRequest and inserts the - # new traces. Any existing trace or span fields included in an update are - # overwritten by the update, and any additional fields in an update are merged - # with the existing trace data. + # Sends new traces to Cloud Trace or updates existing traces. If the ID of a + # trace that you send matches that of an existing trace, any fields in the + # existing trace and its spans are overwritten by the provided values, and any + # new fields provided are merged with the existing trace data. If the ID does + # not match, a new trace is created. # @param [String] project_id - # The project id of the trace to patch. + # ID of the Cloud project where the trace data is stored. # @param [Google::Apis::CloudtraceV1::Traces] traces_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -83,32 +84,33 @@ module Google execute_or_queue_command(command, &block) end - # List traces matching the filter expression. + # Returns of a list of traces that match the specified filter conditions. # @param [String] project_id - # The stringified-version of the project id. + # ID of the Cloud project where the trace data is stored. # @param [String] view - # ViewType specifies the projection of the result. + # Type of data returned for traces in the list. Optional. Default is `MINIMAL`. # @param [Fixnum] page_size - # Maximum number of topics to return. If not specified or <= 0, the - # implementation will select a reasonable value. The implemenation may always - # return fewer than the requested page_size. + # Maximum number of traces to return. If not specified or <= 0, the + # implementation selects a reasonable value. The implementation may return fewer + # traces than the requested page size. Optional. # @param [String] page_token - # The token identifying the page of results to return from the ListTraces method. - # If present, this value is should be taken from the next_page_token field of a - # previous ListTracesResponse. + # Token identifying the page of results to return. If provided, use the value of + # the `next_page_token` field from a previous request. Optional. # @param [String] start_time - # End of the time interval (inclusive). + # End of the time interval (inclusive) during which the trace data was collected + # from the application. # @param [String] end_time - # Start of the time interval (exclusive). + # Start of the time interval (inclusive) during which the trace data was + # collected from the application. # @param [String] filter # An optional filter for the request. # @param [String] order_by - # The trace field used to establish the order of traces returned by the - # ListTraces method. Possible options are: trace_id name (name field of root - # span) duration (different between end_time and start_time fields of root span) - # start (start_time field of root span) Descending order can be specified by - # appending "desc" to the sort field: name desc Only one sort field is permitted, - # though this may change in the future. + # Field used to sort the returned traces. Optional. Can be one of the following: + # * `trace_id` * `name` (`name` field of root span in the trace) * `duration` ( + # difference between `end_time` and `start_time` fields of the root span) * ` + # start` (`start_time` field of the root span) Descending order can be specified + # by appending `desc` to the sort field (for example, `name desc`). Only one + # sort field is permitted. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -143,11 +145,11 @@ module Google execute_or_queue_command(command, &block) end - # Gets one trace by id. + # Gets a single trace by its ID. # @param [String] project_id - # The project id of the trace to return. + # ID of the Cloud project where the trace data is stored. # @param [String] trace_id - # The trace id of the trace to return. + # ID of the trace to return. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -175,44 +177,6 @@ module Google command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end - - # Returns a discovery document in the specified `format`. The typeurl in the - # returned google.protobuf.Any value depends on the requested format. - # @param [String] format - # The format requested for discovery. - # @param [Array, String] labels - # A list of labels (like visibility) influencing the scope of the requested doc. - # @param [String] version - # The API version of the requested discovery doc. - # @param [Array, String] args - # Any additional arguments. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @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 get_discovery(format: nil, labels: nil, version: nil, args: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'v1/discovery', options) - command.query['format'] = format unless format.nil? - command.query['labels'] = labels unless labels.nil? - command.query['version'] = version unless version.nil? - command.query['args'] = args unless args.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end protected diff --git a/generated/google/apis/compute_v1.rb b/generated/google/apis/compute_v1.rb index dad1e3fb7..38e5605b1 100644 --- a/generated/google/apis/compute_v1.rb +++ b/generated/google/apis/compute_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/compute/docs/reference/latest/ module ComputeV1 VERSION = 'V1' - REVISION = '20151116' + REVISION = '20151208' # 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/compute_v1/classes.rb b/generated/google/apis/compute_v1/classes.rb index bd2fd1949..db5479101 100644 --- a/generated/google/apis/compute_v1/classes.rb +++ b/generated/google/apis/compute_v1/classes.rb @@ -78,13 +78,14 @@ module Google # @return [String] attr_accessor :creation_timestamp - # An optional textual description of the resource; provided by the client when - # the resource is created. + # An optional description of this resource. Provide this property when you + # create the resource. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description - # [Output Only] Unique identifier for the resource; defined by the server. + # [Output Only] The unique identifier for the resource. This identifier is + # defined by the server. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id @@ -167,7 +168,11 @@ module Google # @return [String] attr_accessor :kind - # [Output Only] A token used to continue a truncated list request. + # [Output Only] This token allows you to get the next page of results for list + # requests. If the number of results is larger than maxResults, use the + # nextPageToken as a value for the query parameter pageToken in the next list + # request. Subsequent list requests will have their own nextPageToken to + # continue paging through the results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -195,7 +200,8 @@ module Google class AddressList include Google::Apis::Core::Hashable - # [Output Only] Unique identifier for the resource; defined by the server. + # [Output Only] The unique identifier for the resource. This identifier is + # defined by the server. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id @@ -211,7 +217,11 @@ module Google # @return [String] attr_accessor :kind - # [Output Only] A token used to continue a truncated list request. + # [Output Only] This token allows you to get the next page of results for list + # requests. If the number of results is larger than maxResults, use the + # nextPageToken as a value for the query parameter pageToken in the next list + # request. Subsequent list requests will have their own nextPageToken to + # continue paging through the results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -265,17 +275,19 @@ module Google class Warning include Google::Apis::Core::Hashable - # [Output Only] The warning type identifier for this warning. + # [Output Only] A warning code, if applicable. For example, Compute Engine + # returns NO_RESULTS_ON_PAGE if there are no results in the response. # Corresponds to the JSON property `code` # @return [String] attr_accessor :code - # [Output Only] Metadata for this warning in key: value format. + # [Output Only] Metadata about this warning in key: value format. For example: + # "data": [ ` "key": "scope", "value": "zones/us-east1-d" ` # Corresponds to the JSON property `data` # @return [Array] attr_accessor :data - # [Output Only] Optional human-readable details for this warning. + # [Output Only] A human-readable description of the warning code. # Corresponds to the JSON property `message` # @return [String] attr_accessor :message @@ -295,7 +307,13 @@ module Google class Datum include Google::Apis::Core::Hashable - # [Output Only] A key for the warning data. + # [Output Only] A key that provides more detail on the warning being returned. + # For example, for warnings where there are no results in a list request for a + # particular zone, this key might be scope and the key value might be the zone + # name. Other examples might be a key indicating a deprecated resource, and a + # suggested replacement, or a warning about invalid network settings (for + # example, if an instance attempts to perform IP forwarding but is not enabled + # for IP forwarding). # Corresponds to the JSON property `key` # @return [String] attr_accessor :key @@ -495,13 +513,14 @@ module Google # @return [String] attr_accessor :creation_timestamp - # An optional textual description of the resource; provided by the client when - # the resource is created. + # An optional description of this resource. Provide this property when you + # create the resource. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description - # [Output Only] Unique identifier for the resource; defined by the server. + # [Output Only] The unique identifier for the resource. This identifier is + # defined by the server. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id @@ -559,7 +578,8 @@ module Google class AutoscalerAggregatedList include Google::Apis::Core::Hashable - # [Output Only] Unique identifier for the resource; defined by the server. + # [Output Only] The unique identifier for the resource. This identifier is + # defined by the server. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id @@ -574,7 +594,11 @@ module Google # @return [String] attr_accessor :kind - # [Output Only] A token used to continue a truncated list request. + # [Output Only] This token allows you to get the next page of results for list + # requests. If the number of results is larger than maxResults, use the + # nextPageToken as a value for the query parameter pageToken in the next list + # request. Subsequent list requests will have their own nextPageToken to + # continue paging through the results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -602,7 +626,8 @@ module Google class AutoscalerList include Google::Apis::Core::Hashable - # [Output Only] Unique identifier for the resource; defined by the server. + # [Output Only] The unique identifier for the resource. This identifier is + # defined by the server. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id @@ -617,7 +642,11 @@ module Google # @return [String] attr_accessor :kind - # [Output Only] A token used to continue a truncated list request. + # [Output Only] This token allows you to get the next page of results for list + # requests. If the number of results is larger than maxResults, use the + # nextPageToken as a value for the query parameter pageToken in the next list + # request. Subsequent list requests will have their own nextPageToken to + # continue paging through the results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -671,17 +700,19 @@ module Google class Warning include Google::Apis::Core::Hashable - # [Output Only] The warning type identifier for this warning. + # [Output Only] A warning code, if applicable. For example, Compute Engine + # returns NO_RESULTS_ON_PAGE if there are no results in the response. # Corresponds to the JSON property `code` # @return [String] attr_accessor :code - # [Output Only] Metadata for this warning in key: value format. + # [Output Only] Metadata about this warning in key: value format. For example: + # "data": [ ` "key": "scope", "value": "zones/us-east1-d" ` # Corresponds to the JSON property `data` # @return [Array] attr_accessor :data - # [Output Only] Optional human-readable details for this warning. + # [Output Only] A human-readable description of the warning code. # Corresponds to the JSON property `message` # @return [String] attr_accessor :message @@ -701,7 +732,13 @@ module Google class Datum include Google::Apis::Core::Hashable - # [Output Only] A key for the warning data. + # [Output Only] A key that provides more detail on the warning being returned. + # For example, for warnings where there are no results in a list request for a + # particular zone, this key might be scope and the key value might be the zone + # name. Other examples might be a key indicating a deprecated resource, and a + # suggested replacement, or a warning about invalid network settings (for + # example, if an instance attempts to perform IP forwarding but is not enabled + # for IP forwarding). # Corresponds to the JSON property `key` # @return [String] attr_accessor :key @@ -883,8 +920,8 @@ module Google # @return [Float] attr_accessor :capacity_scaler - # An optional textual description of the resource. Provided by the client when - # the resource is created. + # An optional description of this resource. Provide this property when you + # create the resource. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description @@ -950,8 +987,8 @@ module Google # @return [String] attr_accessor :creation_timestamp - # An optional textual description of the resource. Provided by the client when - # the resource is created. + # An optional description of this resource. Provide this property when you + # create the resource. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description @@ -971,7 +1008,8 @@ module Google # @return [Array] attr_accessor :health_checks - # [Output Only] Unique identifier for the resource; defined by the server. + # [Output Only] The unique identifier for the resource. This identifier is + # defined by the server. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id @@ -1072,7 +1110,8 @@ module Google class BackendServiceList include Google::Apis::Core::Hashable - # [Output Only] Unique identifier for the resource; defined by the server. + # [Output Only] The unique identifier for the resource. This identifier is + # defined by the server. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id @@ -1088,7 +1127,11 @@ module Google # @return [String] attr_accessor :kind - # [Output Only] A token used to continue a truncated list request. + # [Output Only] This token allows you to get the next page of results for list + # requests. If the number of results is larger than maxResults, use the + # nextPageToken as a value for the query parameter pageToken in the next list + # request. Subsequent list requests will have their own nextPageToken to + # continue paging through the results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -1173,13 +1216,14 @@ module Google # @return [String] attr_accessor :creation_timestamp - # An optional textual description of the resource; provided by the client when - # the resource is created. + # An optional description of this resource. Provide this property when you + # create the resource. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description - # [Output Only] Unique identifier for the resource; defined by the server. + # [Output Only] The unique identifier for the resource. This identifier is + # defined by the server. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id @@ -1335,7 +1379,8 @@ module Google class DiskAggregatedList include Google::Apis::Core::Hashable - # [Output Only] Unique identifier for the resource; defined by the server. + # [Output Only] The unique identifier for the resource. This identifier is + # defined by the server. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id @@ -1351,7 +1396,11 @@ module Google # @return [String] attr_accessor :kind - # [Output Only] A token used to continue a truncated list request. + # [Output Only] This token allows you to get the next page of results for list + # requests. If the number of results is larger than maxResults, use the + # nextPageToken as a value for the query parameter pageToken in the next list + # request. Subsequent list requests will have their own nextPageToken to + # continue paging through the results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -1379,7 +1428,8 @@ module Google class DiskList include Google::Apis::Core::Hashable - # [Output Only] Unique identifier for the resource; defined by the server. + # [Output Only] The unique identifier for the resource. This identifier is + # defined by the server. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id @@ -1394,7 +1444,11 @@ module Google # @return [String] attr_accessor :kind - # [Output Only] A token used to continue a truncated list request. + # [Output Only] This token allows you to get the next page of results for list + # requests. If the number of results is larger than maxResults, use the + # nextPageToken as a value for the query parameter pageToken in the next list + # request. Subsequent list requests will have their own nextPageToken to + # continue paging through the results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -1470,12 +1524,13 @@ module Google # @return [Google::Apis::ComputeV1::DeprecationStatus] attr_accessor :deprecated - # [Output Only] An optional textual description of the resource. + # [Output Only] An optional description of this resource. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description - # [Output Only] Unique identifier for the resource; defined by the server. + # [Output Only] The unique identifier for the resource. This identifier is + # defined by the server. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id @@ -1529,7 +1584,8 @@ module Google class DiskTypeAggregatedList include Google::Apis::Core::Hashable - # [Output Only] Unique identifier for the resource; defined by the server. + # [Output Only] The unique identifier for the resource. This identifier is + # defined by the server. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id @@ -1544,7 +1600,11 @@ module Google # @return [String] attr_accessor :kind - # [Output Only] A token used to continue a truncated list request. + # [Output Only] This token allows you to get the next page of results for list + # requests. If the number of results is larger than maxResults, use the + # nextPageToken as a value for the query parameter pageToken in the next list + # request. Subsequent list requests will have their own nextPageToken to + # continue paging through the results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -1572,7 +1632,8 @@ module Google class DiskTypeList include Google::Apis::Core::Hashable - # [Output Only] Unique identifier for the resource; defined by the server. + # [Output Only] The unique identifier for the resource. This identifier is + # defined by the server. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id @@ -1587,7 +1648,11 @@ module Google # @return [String] attr_accessor :kind - # [Output Only] A token used to continue a truncated list request. + # [Output Only] This token allows you to get the next page of results for list + # requests. If the number of results is larger than maxResults, use the + # nextPageToken as a value for the query parameter pageToken in the next list + # request. Subsequent list requests will have their own nextPageToken to + # continue paging through the results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -1641,17 +1706,19 @@ module Google class Warning include Google::Apis::Core::Hashable - # [Output Only] The warning type identifier for this warning. + # [Output Only] A warning code, if applicable. For example, Compute Engine + # returns NO_RESULTS_ON_PAGE if there are no results in the response. # Corresponds to the JSON property `code` # @return [String] attr_accessor :code - # [Output Only] Metadata for this warning in key: value format. + # [Output Only] Metadata about this warning in key: value format. For example: + # "data": [ ` "key": "scope", "value": "zones/us-east1-d" ` # Corresponds to the JSON property `data` # @return [Array] attr_accessor :data - # [Output Only] Optional human-readable details for this warning. + # [Output Only] A human-readable description of the warning code. # Corresponds to the JSON property `message` # @return [String] attr_accessor :message @@ -1671,7 +1738,13 @@ module Google class Datum include Google::Apis::Core::Hashable - # [Output Only] A key for the warning data. + # [Output Only] A key that provides more detail on the warning being returned. + # For example, for warnings where there are no results in a list request for a + # particular zone, this key might be scope and the key value might be the zone + # name. Other examples might be a key indicating a deprecated resource, and a + # suggested replacement, or a warning about invalid network settings (for + # example, if an instance attempts to perform IP forwarding but is not enabled + # for IP forwarding). # Corresponds to the JSON property `key` # @return [String] attr_accessor :key @@ -1724,17 +1797,19 @@ module Google class Warning include Google::Apis::Core::Hashable - # [Output Only] The warning type identifier for this warning. + # [Output Only] A warning code, if applicable. For example, Compute Engine + # returns NO_RESULTS_ON_PAGE if there are no results in the response. # Corresponds to the JSON property `code` # @return [String] attr_accessor :code - # [Output Only] Metadata for this warning in key: value format. + # [Output Only] Metadata about this warning in key: value format. For example: + # "data": [ ` "key": "scope", "value": "zones/us-east1-d" ` # Corresponds to the JSON property `data` # @return [Array] attr_accessor :data - # [Output Only] Optional human-readable details for this warning. + # [Output Only] A human-readable description of the warning code. # Corresponds to the JSON property `message` # @return [String] attr_accessor :message @@ -1754,7 +1829,13 @@ module Google class Datum include Google::Apis::Core::Hashable - # [Output Only] A key for the warning data. + # [Output Only] A key that provides more detail on the warning being returned. + # For example, for warnings where there are no results in a list request for a + # particular zone, this key might be scope and the key value might be the zone + # name. Other examples might be a key indicating a deprecated resource, and a + # suggested replacement, or a warning about invalid network settings (for + # example, if an instance attempts to perform IP forwarding but is not enabled + # for IP forwarding). # Corresponds to the JSON property `key` # @return [String] attr_accessor :key @@ -1792,13 +1873,14 @@ module Google # @return [String] attr_accessor :creation_timestamp - # An optional textual description of the resource; provided by the client when - # the resource is created. + # An optional description of this resource. Provide this property when you + # create the resource. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description - # [Output Only] Unique identifier for the resource; defined by the server. + # [Output Only] The unique identifier for the resource. This identifier is + # defined by the server. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id @@ -1918,7 +2000,8 @@ module Google class FirewallList include Google::Apis::Core::Hashable - # [Output Only] Unique identifier for the resource; defined by the server. + # [Output Only] The unique identifier for the resource. This identifier is + # defined by the server. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id @@ -1934,7 +2017,11 @@ module Google # @return [String] attr_accessor :kind - # [Output Only] A token used to continue a truncated list request. + # [Output Only] This token allows you to get the next page of results for list + # requests. If the number of results is larger than maxResults, use the + # nextPageToken as a value for the query parameter pageToken in the next list + # request. Subsequent list requests will have their own nextPageToken to + # continue paging through the results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -1984,18 +2071,20 @@ module Google # @return [String] attr_accessor :creation_timestamp - # An optional textual description of the resource; provided by the client when - # the resource is created. + # An optional description of this resource. Provide this property when you + # create the resource. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description - # [Output Only] Unique identifier for the resource; defined by the server. + # [Output Only] The unique identifier for the resource. This identifier is + # defined by the server. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id - # [Output Only] Type of the resource. Always compute#forwardingRule. + # [Output Only] Type of the resource. Always compute#forwardingRule for + # Forwarding Rule resources. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -2060,7 +2149,8 @@ module Google class ForwardingRuleAggregatedList include Google::Apis::Core::Hashable - # [Output Only] Unique identifier for the resource; defined by the server. + # [Output Only] The unique identifier for the resource. This identifier is + # defined by the server. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id @@ -2075,7 +2165,11 @@ module Google # @return [String] attr_accessor :kind - # [Output Only] A token used to continue a truncated list request. + # [Output Only] This token allows you to get the next page of results for list + # requests. If the number of results is larger than maxResults, use the + # nextPageToken as a value for the query parameter pageToken in the next list + # request. Subsequent list requests will have their own nextPageToken to + # continue paging through the results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -2118,7 +2212,11 @@ module Google # @return [String] attr_accessor :kind - # [Output Only] A token used to continue a truncated list request. + # [Output Only] This token allows you to get the next page of results for list + # requests. If the number of results is larger than maxResults, use the + # nextPageToken as a value for the query parameter pageToken in the next list + # request. Subsequent list requests will have their own nextPageToken to + # continue paging through the results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -2172,17 +2270,19 @@ module Google class Warning include Google::Apis::Core::Hashable - # [Output Only] The warning type identifier for this warning. + # [Output Only] A warning code, if applicable. For example, Compute Engine + # returns NO_RESULTS_ON_PAGE if there are no results in the response. # Corresponds to the JSON property `code` # @return [String] attr_accessor :code - # [Output Only] Metadata for this warning in key: value format. + # [Output Only] Metadata about this warning in key: value format. For example: + # "data": [ ` "key": "scope", "value": "zones/us-east1-d" ` # Corresponds to the JSON property `data` # @return [Array] attr_accessor :data - # [Output Only] Optional human-readable details for this warning. + # [Output Only] A human-readable description of the warning code. # Corresponds to the JSON property `message` # @return [String] attr_accessor :message @@ -2202,7 +2302,13 @@ module Google class Datum include Google::Apis::Core::Hashable - # [Output Only] A key for the warning data. + # [Output Only] A key that provides more detail on the warning being returned. + # For example, for warnings where there are no results in a list request for a + # particular zone, this key might be scope and the key value might be the zone + # name. Other examples might be a key indicating a deprecated resource, and a + # suggested replacement, or a warning about invalid network settings (for + # example, if an instance attempts to perform IP forwarding but is not enabled + # for IP forwarding). # Corresponds to the JSON property `key` # @return [String] attr_accessor :key @@ -2286,7 +2392,8 @@ module Google class HostRule include Google::Apis::Core::Hashable - # An optional textual description. + # An optional description of this resource. Provide this property when you + # create the resource. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description @@ -2331,8 +2438,8 @@ module Google # @return [String] attr_accessor :creation_timestamp - # An optional textual description of the resource; provided by the client when - # the resource is created. + # An optional description of this resource. Provide this property when you + # create the resource. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description @@ -2350,7 +2457,8 @@ module Google # @return [String] attr_accessor :host - # [Output Only] Unique identifier for the resource. Defined by the server. + # [Output Only] The unique identifier for the resource. This identifier is + # defined by the server. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id @@ -2439,7 +2547,11 @@ module Google # @return [String] attr_accessor :kind - # [Output Only] A token used to continue a truncated list request. + # [Output Only] This token allows you to get the next page of results for list + # requests. If the number of results is larger than maxResults, use the + # nextPageToken as a value for the query parameter pageToken in the next list + # request. Subsequent list requests will have their own nextPageToken to + # continue paging through the results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -2478,8 +2590,8 @@ module Google # @return [String] attr_accessor :creation_timestamp - # An optional textual description of the resource; provided by the client when - # the resource is created. + # An optional description of this resource. Provide this property when you + # create the resource. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description @@ -2497,7 +2609,8 @@ module Google # @return [String] attr_accessor :host - # [Output Only] Unique identifier for the resource; defined by the server. + # [Output Only] The unique identifier for the resource. This identifier is + # defined by the server. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id @@ -2587,7 +2700,11 @@ module Google # @return [String] attr_accessor :kind - # [Output Only] A token used to continue a truncated list request. + # [Output Only] This token allows you to get the next page of results for list + # requests. If the number of results is larger than maxResults, use the + # nextPageToken as a value for the query parameter pageToken in the next list + # request. Subsequent list requests will have their own nextPageToken to + # continue paging through the results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -2630,8 +2747,8 @@ module Google # @return [Google::Apis::ComputeV1::DeprecationStatus] attr_accessor :deprecated - # Textual description of the resource; provided by the client when the resource - # is created. + # An optional description of this resource. Provide this property when you + # create the resource. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description @@ -2641,7 +2758,8 @@ module Google # @return [String] attr_accessor :disk_size_gb - # [Output Only] Unique identifier for the resource; defined by the server. + # [Output Only] The unique identifier for the resource. This identifier is + # defined by the server. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id @@ -2771,7 +2889,8 @@ module Google class ImageList include Google::Apis::Core::Hashable - # [Output Only] Unique identifier for the resource; defined by the server. + # [Output Only] The unique identifier for the resource. This identifier is + # defined by the server. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id @@ -2786,7 +2905,11 @@ module Google # @return [String] attr_accessor :kind - # [Output Only] A token used to continue a truncated list request. + # [Output Only] This token allows you to get the next page of results for list + # requests. If the number of results is larger than maxResults, use the + # nextPageToken as a value for the query parameter pageToken in the next list + # request. Subsequent list requests will have their own nextPageToken to + # continue paging through the results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -2844,7 +2967,8 @@ module Google # @return [Array] attr_accessor :disks - # [Output Only] Unique identifier for the resource; defined by the server. + # [Output Only] Unique identifier for the resource. This identifier is defined + # by the server. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id @@ -2854,10 +2978,19 @@ module Google # @return [String] attr_accessor :kind - # Full or partial URL of the machine type resource to use for this instance. - # This is provided by the client when the instance is created. For example, the - # following is a valid partial url: - # zones/zone/machineTypes/machine-type + # Full or partial URL of the machine type resource to use for this instance, in + # the format: zones/zone/machineTypes/ machine-type. This is provided by the + # client when the instance is created. For example, the following is a valid + # partial url to a predefined machine type: + # zones/us-central1-f/machineTypes/n1-standard-1 + # To create a custom machine type, provide a URL to a machine type in the + # following format, where CPUS is 1 or an even number up to 32 (2, 4, 6, ... 24, + # etc), and MEMORY is the total memory for this instance. Memory must be a + # multiple of 256 MB and must be supplied in MB (e.g. 5 GB of memory is 5120 MB): + # zones/zone/machineTypes/custom-CPUS-MEMORY + # For example: zones/us-central1-f/machineTypes/custom-4-5120 + # For a full list of restrictions, read the Specifications for custom machine + # types. # Corresponds to the JSON property `machineType` # @return [String] attr_accessor :machine_type @@ -2954,7 +3087,8 @@ module Google class InstanceAggregatedList include Google::Apis::Core::Hashable - # [Output Only] Unique identifier for the resource; defined by the server. + # [Output Only] The unique identifier for the resource. This identifier is + # defined by the server. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id @@ -3004,7 +3138,8 @@ module Google # @return [String] attr_accessor :creation_timestamp - # An optional text description for the instance group. + # An optional description of this resource. Provide this property when you + # create the resource. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description @@ -3105,7 +3240,11 @@ module Google # @return [String] attr_accessor :kind - # [Output Only] A token that is used to continue a truncated list request. + # [Output Only] This token allows you to get the next page of results for list + # requests. If the number of results is larger than maxResults, use the + # nextPageToken as a value for the query parameter pageToken in the next list + # request. Subsequent list requests will have their own nextPageToken to + # continue paging through the results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -3150,7 +3289,11 @@ module Google # @return [String] attr_accessor :kind - # [Output Only] A token that is used to continue a truncated list request. + # [Output Only] This token allows you to get the next page of results for list + # requests. If the number of results is larger than maxResults, use the + # nextPageToken as a value for the query parameter pageToken in the next list + # request. Subsequent list requests will have their own nextPageToken to + # continue paging through the results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -3199,7 +3342,8 @@ module Google # @return [Google::Apis::ComputeV1::InstanceGroupManagerActionsSummary] attr_accessor :current_actions - # An optional text description for the managed instance group. + # An optional description of this resource. Provide this property when you + # create the resource. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description @@ -3384,7 +3528,11 @@ module Google # @return [String] attr_accessor :kind - # [Output Only] A token that is used to continue a truncated list request. + # [Output Only] This token allows you to get the next page of results for list + # requests. If the number of results is larger than maxResults, use the + # nextPageToken as a value for the query parameter pageToken in the next list + # request. Subsequent list requests will have their own nextPageToken to + # continue paging through the results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -3429,7 +3577,11 @@ module Google # @return [String] attr_accessor :kind - # [Output Only] A token that is used to continue a truncated list request. + # [Output Only] This token allows you to get the next page of results for list + # requests. If the number of results is larger than maxResults, use the + # nextPageToken as a value for the query parameter pageToken in the next list + # request. Subsequent list requests will have their own nextPageToken to + # continue paging through the results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -3561,17 +3713,19 @@ module Google class Warning include Google::Apis::Core::Hashable - # [Output Only] The warning type identifier for this warning. + # [Output Only] A warning code, if applicable. For example, Compute Engine + # returns NO_RESULTS_ON_PAGE if there are no results in the response. # Corresponds to the JSON property `code` # @return [String] attr_accessor :code - # [Output Only] Metadata for this warning in key: value format. + # [Output Only] Metadata about this warning in key: value format. For example: + # "data": [ ` "key": "scope", "value": "zones/us-east1-d" ` # Corresponds to the JSON property `data` # @return [Array] attr_accessor :data - # [Output Only] Optional human-readable details for this warning. + # [Output Only] A human-readable description of the warning code. # Corresponds to the JSON property `message` # @return [String] attr_accessor :message @@ -3591,7 +3745,13 @@ module Google class Datum include Google::Apis::Core::Hashable - # [Output Only] A key for the warning data. + # [Output Only] A key that provides more detail on the warning being returned. + # For example, for warnings where there are no results in a list request for a + # particular zone, this key might be scope and the key value might be the zone + # name. Other examples might be a key indicating a deprecated resource, and a + # suggested replacement, or a warning about invalid network settings (for + # example, if an instance attempts to perform IP forwarding but is not enabled + # for IP forwarding). # Corresponds to the JSON property `key` # @return [String] attr_accessor :key @@ -3708,7 +3868,11 @@ module Google # @return [String] attr_accessor :kind - # [Output Only] A token that is used to continue a truncated list request. + # [Output Only] This token allows you to get the next page of results for list + # requests. If the number of results is larger than maxResults, use the + # nextPageToken as a value for the query parameter pageToken in the next list + # request. Subsequent list requests will have their own nextPageToken to + # continue paging through the results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -3803,17 +3967,19 @@ module Google class Warning include Google::Apis::Core::Hashable - # [Output Only] The warning type identifier for this warning. + # [Output Only] A warning code, if applicable. For example, Compute Engine + # returns NO_RESULTS_ON_PAGE if there are no results in the response. # Corresponds to the JSON property `code` # @return [String] attr_accessor :code - # [Output Only] Metadata for this warning in key: value format. + # [Output Only] Metadata about this warning in key: value format. For example: + # "data": [ ` "key": "scope", "value": "zones/us-east1-d" ` # Corresponds to the JSON property `data` # @return [Array] attr_accessor :data - # [Output Only] Optional human-readable details for this warning. + # [Output Only] A human-readable description of the warning code. # Corresponds to the JSON property `message` # @return [String] attr_accessor :message @@ -3833,7 +3999,13 @@ module Google class Datum include Google::Apis::Core::Hashable - # [Output Only] A key for the warning data. + # [Output Only] A key that provides more detail on the warning being returned. + # For example, for warnings where there are no results in a list request for a + # particular zone, this key might be scope and the key value might be the zone + # name. Other examples might be a key indicating a deprecated resource, and a + # suggested replacement, or a warning about invalid network settings (for + # example, if an instance attempts to perform IP forwarding but is not enabled + # for IP forwarding). # Corresponds to the JSON property `key` # @return [String] attr_accessor :key @@ -3890,7 +4062,8 @@ module Google class InstanceList include Google::Apis::Core::Hashable - # [Output Only] Unique identifier for the resource; defined by the server. + # [Output Only] The unique identifier for the resource. This identifier is + # defined by the server. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id @@ -4070,7 +4243,8 @@ module Google # @return [String] attr_accessor :creation_timestamp - # An optional text description for the instance template. + # An optional description of this resource. Provide this property when you + # create the resource. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description @@ -4144,7 +4318,11 @@ module Google # @return [String] attr_accessor :kind - # [Output Only] A token that is used to continue a truncated list request. + # [Output Only] This token allows you to get the next page of results for list + # requests. If the number of results is larger than maxResults, use the + # nextPageToken as a value for the query parameter pageToken in the next list + # request. Subsequent list requests will have their own nextPageToken to + # continue paging through the results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -4230,17 +4408,19 @@ module Google class Warning include Google::Apis::Core::Hashable - # [Output Only] The warning type identifier for this warning. + # [Output Only] A warning code, if applicable. For example, Compute Engine + # returns NO_RESULTS_ON_PAGE if there are no results in the response. # Corresponds to the JSON property `code` # @return [String] attr_accessor :code - # [Output Only] Metadata for this warning in key: value format. + # [Output Only] Metadata about this warning in key: value format. For example: + # "data": [ ` "key": "scope", "value": "zones/us-east1-d" ` # Corresponds to the JSON property `data` # @return [Array] attr_accessor :data - # [Output Only] Optional human-readable details for this warning. + # [Output Only] A human-readable description of the warning code. # Corresponds to the JSON property `message` # @return [String] attr_accessor :message @@ -4260,7 +4440,13 @@ module Google class Datum include Google::Apis::Core::Hashable - # [Output Only] A key for the warning data. + # [Output Only] A key that provides more detail on the warning being returned. + # For example, for warnings where there are no results in a list request for a + # particular zone, this key might be scope and the key value might be the zone + # name. Other examples might be a key indicating a deprecated resource, and a + # suggested replacement, or a warning about invalid network settings (for + # example, if an instance attempts to perform IP forwarding but is not enabled + # for IP forwarding). # Corresponds to the JSON property `key` # @return [String] attr_accessor :key @@ -4287,8 +4473,8 @@ module Google class License include Google::Apis::Core::Hashable - # If true, the customer will be charged license fee for running software that - # contains this license on an instance. + # [Output Only] If true, the customer will be charged license fee for running + # software that contains this license on an instance. # Corresponds to the JSON property `chargesUseFee` # @return [Boolean] attr_accessor :charges_use_fee @@ -4342,12 +4528,13 @@ module Google # @return [String] attr_accessor :description - # [Output Only] The tumber of CPUs exposed to the instance. + # [Output Only] The number of virtual CPUs that are available to the instance. # Corresponds to the JSON property `guestCpus` # @return [Fixnum] attr_accessor :guest_cpus - # [Output Only] Unique identifier for the resource; defined by the server. + # [Output Only] The unique identifier for the resource. This identifier is + # defined by the server. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id @@ -4358,7 +4545,8 @@ module Google # @return [Fixnum] attr_accessor :image_space_gb - # Type of the resource. + # [Output Only] The type of the resource. Always compute#machineType for machine + # types. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -4446,7 +4634,8 @@ module Google class MachineTypeAggregatedList include Google::Apis::Core::Hashable - # [Output Only] Unique identifier for the resource; defined by the server. + # [Output Only] The unique identifier for the resource. This identifier is + # defined by the server. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id @@ -4462,7 +4651,11 @@ module Google # @return [String] attr_accessor :kind - # [Output Only] A token used to continue a truncated list request. + # [Output Only] This token allows you to get the next page of results for list + # requests. If the number of results is larger than maxResults, use the + # nextPageToken as a value for the query parameter pageToken in the next list + # request. Subsequent list requests will have their own nextPageToken to + # continue paging through the results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -4490,7 +4683,8 @@ module Google class MachineTypeList include Google::Apis::Core::Hashable - # [Output Only] Unique identifier for the resource; defined by the server. + # [Output Only] The unique identifier for the resource. This identifier is + # defined by the server. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id @@ -4506,7 +4700,11 @@ module Google # @return [String] attr_accessor :kind - # [Output Only] A token used to continue a truncated list request. + # [Output Only] This token allows you to get the next page of results for list + # requests. If the number of results is larger than maxResults, use the + # nextPageToken as a value for the query parameter pageToken in the next list + # request. Subsequent list requests will have their own nextPageToken to + # continue paging through the results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -4560,17 +4758,19 @@ module Google class Warning include Google::Apis::Core::Hashable - # [Output Only] The warning type identifier for this warning. + # [Output Only] A warning code, if applicable. For example, Compute Engine + # returns NO_RESULTS_ON_PAGE if there are no results in the response. # Corresponds to the JSON property `code` # @return [String] attr_accessor :code - # [Output Only] Metadata for this warning in key: value format. + # [Output Only] Metadata about this warning in key: value format. For example: + # "data": [ ` "key": "scope", "value": "zones/us-east1-d" ` # Corresponds to the JSON property `data` # @return [Array] attr_accessor :data - # [Output Only] Optional human-readable details for this warning. + # [Output Only] A human-readable description of the warning code. # Corresponds to the JSON property `message` # @return [String] attr_accessor :message @@ -4590,7 +4790,13 @@ module Google class Datum include Google::Apis::Core::Hashable - # [Output Only] A key for the warning data. + # [Output Only] A key that provides more detail on the warning being returned. + # For example, for warnings where there are no results in a list request for a + # particular zone, this key might be scope and the key value might be the zone + # name. Other examples might be a key indicating a deprecated resource, and a + # suggested replacement, or a warning about invalid network settings (for + # example, if an instance attempts to perform IP forwarding but is not enabled + # for IP forwarding). # Corresponds to the JSON property `key` # @return [String] attr_accessor :key @@ -4854,8 +5060,8 @@ module Google # @return [String] attr_accessor :creation_timestamp - # An optional textual description of the resource. Provided by the client when - # the resource is created. + # An optional description of this resource. Provide this property when you + # create the resource. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description @@ -4867,7 +5073,8 @@ module Google # @return [String] attr_accessor :gateway_i_pv4 - # [Output Only] Unique identifier for the resource. Defined by the server. + # [Output Only] The unique identifier for the resource. This identifier is + # defined by the server. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id @@ -4963,7 +5170,8 @@ module Google class NetworkList include Google::Apis::Core::Hashable - # [Output Only] Unique identifier for the resource. Defined by the server. + # [Output Only] The unique identifier for the resource. This identifier is + # defined by the server. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id @@ -4979,7 +5187,11 @@ module Google # @return [String] attr_accessor :kind - # [Output Only] A token used to continue a truncated list request. + # [Output Only] This token allows you to get the next page of results for list + # requests. If the number of results is larger than maxResults, use the + # nextPageToken as a value for the query parameter pageToken in the next list + # request. Subsequent list requests will have their own nextPageToken to + # continue paging through the results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -5007,8 +5219,7 @@ module Google class Operation include Google::Apis::Core::Hashable - # [Output Only] An optional identifier specified by the client when the mutation - # was initiated. Must be unique for all Operation resources in the project. + # [Output Only] A unique client ID generated by the server. # Corresponds to the JSON property `clientOperationId` # @return [String] attr_accessor :client_operation_id @@ -5018,8 +5229,14 @@ module Google # @return [String] attr_accessor :creation_timestamp - # [Output Only] The time that this operation was completed. This is in RFC3339 - # text format. + # [Output Only] A textual description of the operation, which is set when the + # operation is created. + # Corresponds to the JSON property `description` + # @return [String] + attr_accessor :description + + # [Output Only] The time that this operation was completed. This value is in + # RFC3339 text format. # Corresponds to the JSON property `endTime` # @return [String] attr_accessor :end_time @@ -5037,18 +5254,19 @@ module Google attr_accessor :http_error_message # [Output Only] If the operation fails, this field contains the HTTP error - # message that was returned, such as 404. + # message that was returned. For example, a 404 means the resource was not found. # Corresponds to the JSON property `httpErrorStatusCode` # @return [Fixnum] attr_accessor :http_error_status_code - # [Output Only] Unique identifier for the resource; defined by the server. + # [Output Only] The unique identifier for the resource. This identifier is + # defined by the server. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id - # [Output Only] The time that this operation was requested. This is in RFC3339 - # text format. + # [Output Only] The time that this operation was requested. This value is in + # RFC3339 text format. # Corresponds to the JSON property `insertTime` # @return [String] attr_accessor :insert_time @@ -5064,8 +5282,7 @@ module Google # @return [String] attr_accessor :name - # [Output Only] Type of the operation, such as insert, compute.instanceGroups. - # update, or compute.instanceGroups.delete. + # [Output Only] The type of operation, which can be insert, update, or delete. # Corresponds to the JSON property `operationType` # @return [String] attr_accessor :operation_type @@ -5089,14 +5306,14 @@ module Google # @return [String] attr_accessor :self_link - # [Output Only] The time that this operation was started by the server. This is - # in RFC3339 text format. + # [Output Only] The time that this operation was started by the server. This + # value is in RFC3339 text format. # Corresponds to the JSON property `startTime` # @return [String] attr_accessor :start_time - # [Output Only] Status of the operation. Can be one of the following: PENDING, - # RUNNING, or DONE. + # [Output Only] The status of the operation, which can be one of the following: + # PENDING, RUNNING, or DONE. # Corresponds to the JSON property `status` # @return [String] attr_accessor :status @@ -5107,13 +5324,13 @@ module Google # @return [String] attr_accessor :status_message - # [Output Only] Unique target ID which identifies a particular incarnation of - # the target. + # [Output Only] The unique target ID, which identifies a specific incarnation of + # the target resource. # Corresponds to the JSON property `targetId` # @return [String] attr_accessor :target_id - # [Output Only] URL of the resource the operation is mutating. + # [Output Only] The URL of the resource that the operation is modifying. # Corresponds to the JSON property `targetLink` # @return [String] attr_accessor :target_link @@ -5142,6 +5359,7 @@ module Google def update!(**args) @client_operation_id = args[:client_operation_id] unless args[:client_operation_id].nil? @creation_timestamp = args[:creation_timestamp] unless args[:creation_timestamp].nil? + @description = args[:description] unless args[:description].nil? @end_time = args[:end_time] unless args[:end_time].nil? @error = args[:error] unless args[:error].nil? @http_error_message = args[:http_error_message] unless args[:http_error_message].nil? @@ -5220,17 +5438,19 @@ module Google class Warning include Google::Apis::Core::Hashable - # [Output Only] The warning type identifier for this warning. + # [Output Only] A warning code, if applicable. For example, Compute Engine + # returns NO_RESULTS_ON_PAGE if there are no results in the response. # Corresponds to the JSON property `code` # @return [String] attr_accessor :code - # [Output Only] Metadata for this warning in key: value format. + # [Output Only] Metadata about this warning in key: value format. For example: + # "data": [ ` "key": "scope", "value": "zones/us-east1-d" ` # Corresponds to the JSON property `data` # @return [Array] attr_accessor :data - # [Output Only] Optional human-readable details for this warning. + # [Output Only] A human-readable description of the warning code. # Corresponds to the JSON property `message` # @return [String] attr_accessor :message @@ -5250,7 +5470,13 @@ module Google class Datum include Google::Apis::Core::Hashable - # [Output Only] A key for the warning data. + # [Output Only] A key that provides more detail on the warning being returned. + # For example, for warnings where there are no results in a list request for a + # particular zone, this key might be scope and the key value might be the zone + # name. Other examples might be a key indicating a deprecated resource, and a + # suggested replacement, or a warning about invalid network settings (for + # example, if an instance attempts to perform IP forwarding but is not enabled + # for IP forwarding). # Corresponds to the JSON property `key` # @return [String] attr_accessor :key @@ -5277,7 +5503,8 @@ module Google class OperationAggregatedList include Google::Apis::Core::Hashable - # [Output Only] Unique identifier for the resource; defined by the server. + # [Output Only] The unique identifier for the resource. This identifier is + # defined by the server. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id @@ -5293,7 +5520,11 @@ module Google # @return [String] attr_accessor :kind - # [Output Only] A token used to continue a truncated list request. + # [Output Only] This token allows you to get the next page of results for list + # requests. If the number of results is larger than maxResults, use the + # nextPageToken as a value for the query parameter pageToken in the next list + # request. Subsequent list requests will have their own nextPageToken to + # continue paging through the results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -5321,7 +5552,8 @@ module Google class OperationList include Google::Apis::Core::Hashable - # [Output Only] Unique identifier for the resource; defined by the server. + # [Output Only] The unique identifier for the resource. This identifier is + # defined by the server. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id @@ -5337,7 +5569,11 @@ module Google # @return [String] attr_accessor :kind - # [Output Only] A token used to continue a truncate. + # [Output Only] This token allows you to get the next page of results for list + # requests. If the number of results is larger than maxResults, use the + # nextPageToken as a value for the query parameter pageToken in the next list + # request. Subsequent list requests will have their own nextPageToken to + # continue paging through the results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -5391,17 +5627,19 @@ module Google class Warning include Google::Apis::Core::Hashable - # [Output Only] The warning type identifier for this warning. + # [Output Only] A warning code, if applicable. For example, Compute Engine + # returns NO_RESULTS_ON_PAGE if there are no results in the response. # Corresponds to the JSON property `code` # @return [String] attr_accessor :code - # [Output Only] Metadata for this warning in key: value format. + # [Output Only] Metadata about this warning in key: value format. For example: + # "data": [ ` "key": "scope", "value": "zones/us-east1-d" ` # Corresponds to the JSON property `data` # @return [Array] attr_accessor :data - # [Output Only] Optional human-readable details for this warning. + # [Output Only] A human-readable description of the warning code. # Corresponds to the JSON property `message` # @return [String] attr_accessor :message @@ -5421,7 +5659,13 @@ module Google class Datum include Google::Apis::Core::Hashable - # [Output Only] A key for the warning data. + # [Output Only] A key that provides more detail on the warning being returned. + # For example, for warnings where there are no results in a list request for a + # particular zone, this key might be scope and the key value might be the zone + # name. Other examples might be a key indicating a deprecated resource, and a + # suggested replacement, or a warning about invalid network settings (for + # example, if an instance attempts to perform IP forwarding but is not enabled + # for IP forwarding). # Corresponds to the JSON property `key` # @return [String] attr_accessor :key @@ -5450,12 +5694,14 @@ module Google class PathMatcher include Google::Apis::Core::Hashable - # + # The URL to the BackendService resource. This will be used if none of the + # pathRules defined by this PathMatcher is met by the URL's path portion. # Corresponds to the JSON property `defaultService` # @return [String] attr_accessor :default_service - # An optional textual description of the resource. + # An optional description of this resource. Provide this property when you + # create the resource. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description @@ -5537,7 +5783,9 @@ module Google # @return [Array] attr_accessor :enabled_features - # [Output Only] Unique identifier for the resource; defined by the server. + # [Output Only] The unique identifier for the resource. This identifier is + # defined by the server. This is not the project ID, and is just a unique ID + # used by Compute Engine to identify resources. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id @@ -5547,7 +5795,8 @@ module Google # @return [String] attr_accessor :kind - # Name of the resource. + # The project ID. For example: my-example-project. Use the project ID to make + # requests to Compute Engine. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -5637,7 +5886,8 @@ module Google # @return [String] attr_accessor :description - # [Output Only] Unique identifier for the resource; defined by the server . + # [Output Only] The unique identifier for the resource. This identifier is + # defined by the server. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id @@ -5696,7 +5946,8 @@ module Google class RegionList include Google::Apis::Core::Hashable - # [Output Only] Unique identifier for the resource; defined by the server. + # [Output Only] The unique identifier for the resource. This identifier is + # defined by the server. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id @@ -5711,7 +5962,11 @@ module Google # @return [String] attr_accessor :kind - # [Output Only] A token used to continue a truncated list request. + # [Output Only] This token allows you to get the next page of results for list + # requests. If the number of results is larger than maxResults, use the + # nextPageToken as a value for the query parameter pageToken in the next list + # request. Subsequent list requests will have their own nextPageToken to + # continue paging through the results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -5775,8 +6030,8 @@ module Google # @return [String] attr_accessor :creation_timestamp - # An optional textual description of the resource. Provided by the client when - # the resource is created. + # An optional description of this resource. Provide this property when you + # create the resource. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description @@ -5786,7 +6041,8 @@ module Google # @return [String] attr_accessor :dest_range - # [Output Only] Unique identifier for the resource. Defined by the server. + # [Output Only] The unique identifier for the resource. This identifier is + # defined by the server. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id @@ -5891,17 +6147,19 @@ module Google class Warning include Google::Apis::Core::Hashable - # [Output Only] The warning type identifier for this warning. + # [Output Only] A warning code, if applicable. For example, Compute Engine + # returns NO_RESULTS_ON_PAGE if there are no results in the response. # Corresponds to the JSON property `code` # @return [String] attr_accessor :code - # [Output Only] Metadata for this warning in key: value format. + # [Output Only] Metadata about this warning in key: value format. For example: + # "data": [ ` "key": "scope", "value": "zones/us-east1-d" ` # Corresponds to the JSON property `data` # @return [Array] attr_accessor :data - # [Output Only] Optional human-readable details for this warning. + # [Output Only] A human-readable description of the warning code. # Corresponds to the JSON property `message` # @return [String] attr_accessor :message @@ -5921,7 +6179,13 @@ module Google class Datum include Google::Apis::Core::Hashable - # [Output Only] A key for the warning data. + # [Output Only] A key that provides more detail on the warning being returned. + # For example, for warnings where there are no results in a list request for a + # particular zone, this key might be scope and the key value might be the zone + # name. Other examples might be a key indicating a deprecated resource, and a + # suggested replacement, or a warning about invalid network settings (for + # example, if an instance attempts to perform IP forwarding but is not enabled + # for IP forwarding). # Corresponds to the JSON property `key` # @return [String] attr_accessor :key @@ -5963,7 +6227,11 @@ module Google # @return [String] attr_accessor :kind - # [Output Only] A token used to continue a truncated list request. + # [Output Only] This token allows you to get the next page of results for list + # requests. If the number of results is larger than maxResults, use the + # nextPageToken as a value for the query parameter pageToken in the next list + # request. Subsequent list requests will have their own nextPageToken to + # continue paging through the results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -6092,8 +6360,8 @@ module Google # @return [String] attr_accessor :creation_timestamp - # An optional textual description of the resource; provided by the client when - # the resource is created. + # An optional description of this resource. Provide this property when you + # create the resource. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description @@ -6103,7 +6371,8 @@ module Google # @return [String] attr_accessor :disk_size_gb - # [Output Only] Unique identifier for the resource; defined by the server. + # [Output Only] The unique identifier for the resource. This identifier is + # defined by the server. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id @@ -6190,7 +6459,8 @@ module Google class SnapshotList include Google::Apis::Core::Hashable - # [Output Only] Unique identifier for the resource. Defined by the server. + # [Output Only] The unique identifier for the resource. This identifier is + # defined by the server. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id @@ -6205,7 +6475,11 @@ module Google # @return [String] attr_accessor :kind - # [Output Only] A token used to continue a truncated list request. + # [Output Only] This token allows you to get the next page of results for list + # requests. If the number of results is larger than maxResults, use the + # nextPageToken as a value for the query parameter pageToken in the next list + # request. Subsequent list requests will have their own nextPageToken to + # continue paging through the results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -6247,13 +6521,14 @@ module Google # @return [String] attr_accessor :creation_timestamp - # An optional textual description of the resource. Provided by the client when - # the resource is created. + # An optional description of this resource. Provide this property when you + # create the resource. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description - # [Output Only] Unique identifier for the resource. Defined by the server. + # [Output Only] The unique identifier for the resource. This identifier is + # defined by the server. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id @@ -6321,7 +6596,11 @@ module Google # @return [String] attr_accessor :kind - # [Output Only] A token used to continue a truncated list request. + # [Output Only] This token allows you to get the next page of results for list + # requests. If the number of results is larger than maxResults, use the + # nextPageToken as a value for the query parameter pageToken in the next list + # request. Subsequent list requests will have their own nextPageToken to + # continue paging through the results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -6385,19 +6664,20 @@ module Google # @return [String] attr_accessor :creation_timestamp - # An optional textual description of the resource; provided by the client when - # the resource is created. + # An optional description of this resource. Provide this property when you + # create the resource. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description - # [Output Only] Unique identifier for the resource. Defined by the server. + # [Output Only] The unique identifier for the resource. This identifier is + # defined by the server. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id - # [Output Only] Type of resource. Always compute#operation for Operation - # resources. + # [Output Only] Type of resource. Always compute#targetHttpProxy for target HTTP + # proxies. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -6443,7 +6723,8 @@ module Google class TargetHttpProxyList include Google::Apis::Core::Hashable - # [Output Only] Unique identifier for the resource; defined by the server. + # [Output Only] The unique identifier for the resource. This identifier is + # defined by the server. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id @@ -6459,7 +6740,11 @@ module Google # @return [String] attr_accessor :kind - # [Output Only] A token used to continue a truncated list request. + # [Output Only] This token allows you to get the next page of results for list + # requests. If the number of results is larger than maxResults, use the + # nextPageToken as a value for the query parameter pageToken in the next list + # request. Subsequent list requests will have their own nextPageToken to + # continue paging through the results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -6512,18 +6797,20 @@ module Google # @return [String] attr_accessor :creation_timestamp - # An optional textual description of the resource. Provided by the client when - # the resource is created. + # An optional description of this resource. Provide this property when you + # create the resource. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description - # [Output Only] Unique identifier for the resource; defined by the server. + # [Output Only] The unique identifier for the resource. This identifier is + # defined by the server. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id - # Type of the resource. + # [Output Only] Type of the resource. Always compute#targetHttpsProxy for target + # HTTPS proxies. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -6576,7 +6863,8 @@ module Google class TargetHttpsProxyList include Google::Apis::Core::Hashable - # [Output Only] Unique identifier for the resource; defined by the server. + # [Output Only] The unique identifier for the resource. This identifier is + # defined by the server. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id @@ -6591,7 +6879,11 @@ module Google # @return [String] attr_accessor :kind - # [Output Only] A token used to continue a truncated list request. + # [Output Only] This token allows you to get the next page of results for list + # requests. If the number of results is larger than maxResults, use the + # nextPageToken as a value for the query parameter pageToken in the next list + # request. Subsequent list requests will have their own nextPageToken to + # continue paging through the results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -6625,13 +6917,14 @@ module Google # @return [String] attr_accessor :creation_timestamp - # An optional textual description of the resource; provided by the client when - # the resource is created. + # An optional description of this resource. Provide this property when you + # create the resource. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description - # [Output Only] Unique identifier for the resource; defined by the server. + # [Output Only] The unique identifier for the resource. This identifier is + # defined by the server. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id @@ -6641,7 +6934,8 @@ module Google # @return [String] attr_accessor :instance - # Type of the resource. + # [Output Only] The type of the resource. Always compute#targetInstance for + # target instances. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -6709,7 +7003,11 @@ module Google # @return [String] attr_accessor :kind - # [Output Only] A token used to continue a truncated list request. + # [Output Only] This token allows you to get the next page of results for list + # requests. If the number of results is larger than maxResults, use the + # nextPageToken as a value for the query parameter pageToken in the next list + # request. Subsequent list requests will have their own nextPageToken to + # continue paging through the results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -6737,7 +7035,8 @@ module Google class TargetInstanceList include Google::Apis::Core::Hashable - # [Output Only] Unique identifier for the resource; defined by the server. + # [Output Only] The unique identifier for the resource. This identifier is + # defined by the server. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id @@ -6752,7 +7051,11 @@ module Google # @return [String] attr_accessor :kind - # [Output Only] A token used to continue a truncated list request. + # [Output Only] This token allows you to get the next page of results for list + # requests. If the number of results is larger than maxResults, use the + # nextPageToken as a value for the query parameter pageToken in the next list + # request. Subsequent list requests will have their own nextPageToken to + # continue paging through the results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -6806,17 +7109,19 @@ module Google class Warning include Google::Apis::Core::Hashable - # [Output Only] The warning type identifier for this warning. + # [Output Only] A warning code, if applicable. For example, Compute Engine + # returns NO_RESULTS_ON_PAGE if there are no results in the response. # Corresponds to the JSON property `code` # @return [String] attr_accessor :code - # [Output Only] Metadata for this warning in key: value format. + # [Output Only] Metadata about this warning in key: value format. For example: + # "data": [ ` "key": "scope", "value": "zones/us-east1-d" ` # Corresponds to the JSON property `data` # @return [Array] attr_accessor :data - # [Output Only] Optional human-readable details for this warning. + # [Output Only] A human-readable description of the warning code. # Corresponds to the JSON property `message` # @return [String] attr_accessor :message @@ -6836,7 +7141,13 @@ module Google class Datum include Google::Apis::Core::Hashable - # [Output Only] A key for the warning data. + # [Output Only] A key that provides more detail on the warning being returned. + # For example, for warnings where there are no results in a list request for a + # particular zone, this key might be scope and the key value might be the zone + # name. Other examples might be a key indicating a deprecated resource, and a + # suggested replacement, or a warning about invalid network settings (for + # example, if an instance attempts to perform IP forwarding but is not enabled + # for IP forwarding). # Corresponds to the JSON property `key` # @return [String] attr_accessor :key @@ -6885,8 +7196,8 @@ module Google # @return [String] attr_accessor :creation_timestamp - # An optional textual description of the resource; provided by the client when - # the resource is created. + # An optional description of this resource. Provide this property when you + # create the resource. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description @@ -6913,7 +7224,8 @@ module Google # @return [Array] attr_accessor :health_checks - # [Output Only] Unique identifier for the resource; defined by the server. + # [Output Only] The unique identifier for the resource. This identifier is + # defined by the server. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id @@ -6924,7 +7236,7 @@ module Google # @return [Array] attr_accessor :instances - # Type of the resource. + # [Output Only] Type of the resource. Always compute#targetPool for target pools. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -6999,7 +7311,11 @@ module Google # @return [String] attr_accessor :kind - # [Output Only] A token used to continue a truncated list request. + # [Output Only] This token allows you to get the next page of results for list + # requests. If the number of results is larger than maxResults, use the + # nextPageToken as a value for the query parameter pageToken in the next list + # request. Subsequent list requests will have their own nextPageToken to + # continue paging through the results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -7067,7 +7383,11 @@ module Google # @return [String] attr_accessor :kind - # [Output Only] A token used to continue a truncated list request. + # [Output Only] This token allows you to get the next page of results for list + # requests. If the number of results is larger than maxResults, use the + # nextPageToken as a value for the query parameter pageToken in the next list + # request. Subsequent list requests will have their own nextPageToken to + # continue paging through the results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -7197,17 +7517,19 @@ module Google class Warning include Google::Apis::Core::Hashable - # [Output Only] The warning type identifier for this warning. + # [Output Only] A warning code, if applicable. For example, Compute Engine + # returns NO_RESULTS_ON_PAGE if there are no results in the response. # Corresponds to the JSON property `code` # @return [String] attr_accessor :code - # [Output Only] Metadata for this warning in key: value format. + # [Output Only] Metadata about this warning in key: value format. For example: + # "data": [ ` "key": "scope", "value": "zones/us-east1-d" ` # Corresponds to the JSON property `data` # @return [Array] attr_accessor :data - # [Output Only] Optional human-readable details for this warning. + # [Output Only] A human-readable description of the warning code. # Corresponds to the JSON property `message` # @return [String] attr_accessor :message @@ -7227,7 +7549,13 @@ module Google class Datum include Google::Apis::Core::Hashable - # [Output Only] A key for the warning data. + # [Output Only] A key that provides more detail on the warning being returned. + # For example, for warnings where there are no results in a list request for a + # particular zone, this key might be scope and the key value might be the zone + # name. Other examples might be a key indicating a deprecated resource, and a + # suggested replacement, or a warning about invalid network settings (for + # example, if an instance attempts to perform IP forwarding but is not enabled + # for IP forwarding). # Corresponds to the JSON property `key` # @return [String] attr_accessor :key @@ -7278,8 +7606,8 @@ module Google # @return [String] attr_accessor :creation_timestamp - # An optional textual description of the resource. Provided by the client when - # the resource is created. + # An optional description of this resource. Provide this property when you + # create the resource. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description @@ -7291,7 +7619,8 @@ module Google # @return [Array] attr_accessor :forwarding_rules - # [Output Only] Unique identifier for the resource. Defined by the server. + # [Output Only] The unique identifier for the resource. This identifier is + # defined by the server. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id @@ -7363,7 +7692,8 @@ module Google class TargetVpnGatewayAggregatedList include Google::Apis::Core::Hashable - # [Output Only] Unique identifier for the resource. Defined by the server. + # [Output Only] The unique identifier for the resource. This identifier is + # defined by the server. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id @@ -7379,7 +7709,11 @@ module Google # @return [String] attr_accessor :kind - # [Output Only] A token used to continue a truncated list request. + # [Output Only] This token allows you to get the next page of results for list + # requests. If the number of results is larger than maxResults, use the + # nextPageToken as a value for the query parameter pageToken in the next list + # request. Subsequent list requests will have their own nextPageToken to + # continue paging through the results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -7407,7 +7741,8 @@ module Google class TargetVpnGatewayList include Google::Apis::Core::Hashable - # [Output Only] Unique identifier for the resource. Defined by the server. + # [Output Only] The unique identifier for the resource. This identifier is + # defined by the server. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id @@ -7423,7 +7758,11 @@ module Google # @return [String] attr_accessor :kind - # [Output Only] A token used to continue a truncated list request. + # [Output Only] This token allows you to get the next page of results for list + # requests. If the number of results is larger than maxResults, use the + # nextPageToken as a value for the query parameter pageToken in the next list + # request. Subsequent list requests will have their own nextPageToken to + # continue paging through the results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -7477,17 +7816,19 @@ module Google class Warning include Google::Apis::Core::Hashable - # [Output Only] The warning type identifier for this warning. + # [Output Only] A warning code, if applicable. For example, Compute Engine + # returns NO_RESULTS_ON_PAGE if there are no results in the response. # Corresponds to the JSON property `code` # @return [String] attr_accessor :code - # [Output Only] Metadata for this warning in key: value format. + # [Output Only] Metadata about this warning in key: value format. For example: + # "data": [ ` "key": "scope", "value": "zones/us-east1-d" ` # Corresponds to the JSON property `data` # @return [Array] attr_accessor :data - # [Output Only] Optional human-readable details for this warning. + # [Output Only] A human-readable description of the warning code. # Corresponds to the JSON property `message` # @return [String] attr_accessor :message @@ -7507,7 +7848,13 @@ module Google class Datum include Google::Apis::Core::Hashable - # [Output Only] A key for the warning data. + # [Output Only] A key that provides more detail on the warning being returned. + # For example, for warnings where there are no results in a list request for a + # particular zone, this key might be scope and the key value might be the zone + # name. Other examples might be a key indicating a deprecated resource, and a + # suggested replacement, or a warning about invalid network settings (for + # example, if an instance attempts to perform IP forwarding but is not enabled + # for IP forwarding). # Corresponds to the JSON property `key` # @return [String] attr_accessor :key @@ -7583,8 +7930,8 @@ module Google # @return [String] attr_accessor :default_service - # An optional textual description of the resource. Provided by the client when - # the resource is created. + # An optional description of this resource. Provide this property when you + # create the resource. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description @@ -7602,12 +7949,13 @@ module Google # @return [Array] attr_accessor :host_rules - # [Output Only] Unique identifier for the resource. Set by the server. + # [Output Only] The unique identifier for the resource. This identifier is + # defined by the server. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id - # Type of the resource. + # [Output Only] Type of the resource. Always compute#urlMaps for url maps. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -7677,7 +8025,11 @@ module Google # @return [String] attr_accessor :kind - # [Output Only] A token used to continue a truncated list request. + # [Output Only] This token allows you to get the next page of results for list + # requests. If the number of results is larger than maxResults, use the + # nextPageToken as a value for the query parameter pageToken in the next list + # request. Subsequent list requests will have their own nextPageToken to + # continue paging through the results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -7880,8 +8232,8 @@ module Google # @return [String] attr_accessor :creation_timestamp - # An optional textual description of the resource. Provided by the client when - # the resource is created. + # An optional description of this resource. Provide this property when you + # create the resource. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description @@ -7891,7 +8243,8 @@ module Google # @return [String] attr_accessor :detailed_status - # [Output Only] Unique identifier for the resource. Defined by the server. + # [Output Only] The unique identifier for the resource. This identifier is + # defined by the server. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id @@ -7981,7 +8334,8 @@ module Google class VpnTunnelAggregatedList include Google::Apis::Core::Hashable - # [Output Only] Unique identifier for the resource; defined by the server. + # [Output Only] The unique identifier for the resource. This identifier is + # defined by the server. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id @@ -7996,7 +8350,11 @@ module Google # @return [String] attr_accessor :kind - # [Output Only] A token used to continue a truncated list request. + # [Output Only] This token allows you to get the next page of results for list + # requests. If the number of results is larger than maxResults, use the + # nextPageToken as a value for the query parameter pageToken in the next list + # request. Subsequent list requests will have their own nextPageToken to + # continue paging through the results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -8024,7 +8382,8 @@ module Google class VpnTunnelList include Google::Apis::Core::Hashable - # [Output Only] Unique identifier for the resource; defined by the server. + # [Output Only] The unique identifier for the resource. This identifier is + # defined by the server. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id @@ -8039,7 +8398,11 @@ module Google # @return [String] attr_accessor :kind - # [Output Only] A token used to continue a truncated list request. + # [Output Only] This token allows you to get the next page of results for list + # requests. If the number of results is larger than maxResults, use the + # nextPageToken as a value for the query parameter pageToken in the next list + # request. Subsequent list requests will have their own nextPageToken to + # continue paging through the results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -8093,17 +8456,19 @@ module Google class Warning include Google::Apis::Core::Hashable - # [Output Only] The warning type identifier for this warning. + # [Output Only] A warning code, if applicable. For example, Compute Engine + # returns NO_RESULTS_ON_PAGE if there are no results in the response. # Corresponds to the JSON property `code` # @return [String] attr_accessor :code - # [Output Only] Metadata for this warning in key: value format. + # [Output Only] Metadata about this warning in key: value format. For example: + # "data": [ ` "key": "scope", "value": "zones/us-east1-d" ` # Corresponds to the JSON property `data` # @return [Array] attr_accessor :data - # [Output Only] Optional human-readable details for this warning. + # [Output Only] A human-readable description of the warning code. # Corresponds to the JSON property `message` # @return [String] attr_accessor :message @@ -8123,7 +8488,13 @@ module Google class Datum include Google::Apis::Core::Hashable - # [Output Only] A key for the warning data. + # [Output Only] A key that provides more detail on the warning being returned. + # For example, for warnings where there are no results in a list request for a + # particular zone, this key might be scope and the key value might be the zone + # name. Other examples might be a key indicating a deprecated resource, and a + # suggested replacement, or a warning about invalid network settings (for + # example, if an instance attempts to perform IP forwarding but is not enabled + # for IP forwarding). # Corresponds to the JSON property `key` # @return [String] attr_accessor :key @@ -8165,12 +8536,13 @@ module Google # @return [String] attr_accessor :description - # [Output Only] Unique identifier for the resource; defined by the server. + # [Output Only] The unique identifier for the resource. This identifier is + # defined by the server. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id - # [Output Only] Type of the resource. Always kind#zone for zones. + # [Output Only] Type of the resource. Always compute#zone for zones. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -8277,7 +8649,11 @@ module Google # @return [String] attr_accessor :kind - # [Output Only] A token used to continue a truncated list request. + # [Output Only] This token allows you to get the next page of results for list + # requests. If the number of results is larger than maxResults, use the + # nextPageToken as a value for the query parameter pageToken in the next list + # request. Subsequent list requests will have their own nextPageToken to + # continue paging through the results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token diff --git a/generated/google/apis/compute_v1/representations.rb b/generated/google/apis/compute_v1/representations.rb index 376a0d4ef..b3f831db9 100644 --- a/generated/google/apis/compute_v1/representations.rb +++ b/generated/google/apis/compute_v1/representations.rb @@ -2032,6 +2032,7 @@ module Google class Representation < Google::Apis::Core::JsonRepresentation property :client_operation_id, as: 'clientOperationId' property :creation_timestamp, as: 'creationTimestamp' + property :description, as: 'description' property :end_time, as: 'endTime' property :error, as: 'error', class: Google::Apis::ComputeV1::Operation::Error, decorator: Google::Apis::ComputeV1::Operation::Error::Representation diff --git a/generated/google/apis/compute_v1/service.rb b/generated/google/apis/compute_v1/service.rb index 6ce4409f6..7a70d5cda 100644 --- a/generated/google/apis/compute_v1/service.rb +++ b/generated/google/apis/compute_v1/service.rb @@ -57,22 +57,34 @@ module Google # Project ID for this request. # @param [String] filter # Sets a filter expression for filtering listed resources, in the form filter=` - # expression`. Your `expression` must be in the format: FIELD_NAME - # COMPARISON_STRING LITERAL_STRING. - # The FIELD_NAME is the name of the field you want to compare. Only atomic field - # types are supported (string, number, boolean). The COMPARISON_STRING must be - # either eq (equals) or ne (not equals). The LITERAL_STRING is the string value - # to filter to. The literal value must be valid for the type of field (string, - # number, boolean). For string fields, the literal value is interpreted as a - # regular expression using RE2 syntax. The literal value must match the entire - # field. + # expression`. Your `expression` must be in the format: field_name + # comparison_string literal_string. + # The field_name is the name of the field you want to compare. Only atomic field + # types are supported (string, number, boolean). The comparison_string must be + # either eq (equals) or ne (not equals). The literal_string is the string value + # to filter to. The literal value must be valid for the type of field you are + # filtering by (string, number, boolean). For string fields, the literal value + # is interpreted as a regular expression using RE2 syntax. The literal value + # must match the entire field. # For example, filter=name ne example-instance. + # Compute Engine Beta API Only: If you use filtering in the Beta API, you can + # also filter on nested fields. For example, you could filter on instances that + # have set the scheduling.automaticRestart field to true. In particular, use + # filtering on nested fields to take advantage of instance labels to organize + # and filter results based on label values. + # The Beta API also supports filtering on multiple expressions by providing each + # separate expression within parentheses. For example, (scheduling. + # automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are + # treated as AND expressions meaning that resources must match all expressions + # to pass the filters. # @param [Fixnum] max_results - # Maximum count of results to be returned. + # The maximum number of results per page that Compute Engine should return. If + # the number of available results is larger than maxResults, Compute Engine + # returns a nextPageToken that can be used to get the next page of results in + # subsequent list requests. # @param [String] page_token - # Specifies a page token to use. Use this parameter if you want to list the next - # page of results. Set pageToken to the nextPageToken returned by a previous - # list request. + # Specifies a page token to use. Set pageToken to the nextPageToken returned by + # a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -239,22 +251,34 @@ module Google # The name of the region for this request. # @param [String] filter # Sets a filter expression for filtering listed resources, in the form filter=` - # expression`. Your `expression` must be in the format: FIELD_NAME - # COMPARISON_STRING LITERAL_STRING. - # The FIELD_NAME is the name of the field you want to compare. Only atomic field - # types are supported (string, number, boolean). The COMPARISON_STRING must be - # either eq (equals) or ne (not equals). The LITERAL_STRING is the string value - # to filter to. The literal value must be valid for the type of field (string, - # number, boolean). For string fields, the literal value is interpreted as a - # regular expression using RE2 syntax. The literal value must match the entire - # field. + # expression`. Your `expression` must be in the format: field_name + # comparison_string literal_string. + # The field_name is the name of the field you want to compare. Only atomic field + # types are supported (string, number, boolean). The comparison_string must be + # either eq (equals) or ne (not equals). The literal_string is the string value + # to filter to. The literal value must be valid for the type of field you are + # filtering by (string, number, boolean). For string fields, the literal value + # is interpreted as a regular expression using RE2 syntax. The literal value + # must match the entire field. # For example, filter=name ne example-instance. + # Compute Engine Beta API Only: If you use filtering in the Beta API, you can + # also filter on nested fields. For example, you could filter on instances that + # have set the scheduling.automaticRestart field to true. In particular, use + # filtering on nested fields to take advantage of instance labels to organize + # and filter results based on label values. + # The Beta API also supports filtering on multiple expressions by providing each + # separate expression within parentheses. For example, (scheduling. + # automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are + # treated as AND expressions meaning that resources must match all expressions + # to pass the filters. # @param [Fixnum] max_results - # Maximum count of results to be returned. + # The maximum number of results per page that Compute Engine should return. If + # the number of available results is larger than maxResults, Compute Engine + # returns a nextPageToken that can be used to get the next page of results in + # subsequent list requests. # @param [String] page_token - # Specifies a page token to use. Use this parameter if you want to list the next - # page of results. Set pageToken to the nextPageToken returned by a previous - # list request. + # Specifies a page token to use. Set pageToken to the nextPageToken returned by + # a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -293,25 +317,37 @@ module Google # Retrieves the list of autoscalers grouped by scope. # @param [String] project - # Name of the project scoping this request. + # Project ID for this request. # @param [String] filter # Sets a filter expression for filtering listed resources, in the form filter=` - # expression`. Your `expression` must be in the format: FIELD_NAME - # COMPARISON_STRING LITERAL_STRING. - # The FIELD_NAME is the name of the field you want to compare. Only atomic field - # types are supported (string, number, boolean). The COMPARISON_STRING must be - # either eq (equals) or ne (not equals). The LITERAL_STRING is the string value - # to filter to. The literal value must be valid for the type of field (string, - # number, boolean). For string fields, the literal value is interpreted as a - # regular expression using RE2 syntax. The literal value must match the entire - # field. + # expression`. Your `expression` must be in the format: field_name + # comparison_string literal_string. + # The field_name is the name of the field you want to compare. Only atomic field + # types are supported (string, number, boolean). The comparison_string must be + # either eq (equals) or ne (not equals). The literal_string is the string value + # to filter to. The literal value must be valid for the type of field you are + # filtering by (string, number, boolean). For string fields, the literal value + # is interpreted as a regular expression using RE2 syntax. The literal value + # must match the entire field. # For example, filter=name ne example-instance. + # Compute Engine Beta API Only: If you use filtering in the Beta API, you can + # also filter on nested fields. For example, you could filter on instances that + # have set the scheduling.automaticRestart field to true. In particular, use + # filtering on nested fields to take advantage of instance labels to organize + # and filter results based on label values. + # The Beta API also supports filtering on multiple expressions by providing each + # separate expression within parentheses. For example, (scheduling. + # automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are + # treated as AND expressions meaning that resources must match all expressions + # to pass the filters. # @param [Fixnum] max_results - # Maximum count of results to be returned. + # The maximum number of results per page that Compute Engine should return. If + # the number of available results is larger than maxResults, Compute Engine + # returns a nextPageToken that can be used to get the next page of results in + # subsequent list requests. # @param [String] page_token - # Specifies a page token to use. Use this parameter if you want to list the next - # page of results. Set pageToken to the nextPageToken returned by a previous - # list request. + # Specifies a page token to use. Set pageToken to the nextPageToken returned by + # a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -349,7 +385,7 @@ module Google # Deletes the specified autoscaler resource. # @param [String] project - # Name of the project scoping this request. + # Project ID for this request. # @param [String] zone # Name of the zone scoping this request. # @param [String] autoscaler @@ -390,7 +426,7 @@ module Google # Returns the specified autoscaler resource. # @param [String] project - # Name of the project scoping this request. + # Project ID for this request. # @param [String] zone # Name of the zone scoping this request. # @param [String] autoscaler @@ -432,7 +468,7 @@ module Google # Creates an autoscaler resource in the specified project using the data # included in the request. # @param [String] project - # Name of the project scoping this request. + # Project ID for this request. # @param [String] zone # Name of the zone scoping this request. # @param [Google::Apis::ComputeV1::Autoscaler] autoscaler_object @@ -473,27 +509,39 @@ module Google # Retrieves the list of autoscaler resources contained within the specified zone. # @param [String] project - # Name of the project scoping this request. + # Project ID for this request. # @param [String] zone # Name of the zone scoping this request. # @param [String] filter # Sets a filter expression for filtering listed resources, in the form filter=` - # expression`. Your `expression` must be in the format: FIELD_NAME - # COMPARISON_STRING LITERAL_STRING. - # The FIELD_NAME is the name of the field you want to compare. Only atomic field - # types are supported (string, number, boolean). The COMPARISON_STRING must be - # either eq (equals) or ne (not equals). The LITERAL_STRING is the string value - # to filter to. The literal value must be valid for the type of field (string, - # number, boolean). For string fields, the literal value is interpreted as a - # regular expression using RE2 syntax. The literal value must match the entire - # field. + # expression`. Your `expression` must be in the format: field_name + # comparison_string literal_string. + # The field_name is the name of the field you want to compare. Only atomic field + # types are supported (string, number, boolean). The comparison_string must be + # either eq (equals) or ne (not equals). The literal_string is the string value + # to filter to. The literal value must be valid for the type of field you are + # filtering by (string, number, boolean). For string fields, the literal value + # is interpreted as a regular expression using RE2 syntax. The literal value + # must match the entire field. # For example, filter=name ne example-instance. + # Compute Engine Beta API Only: If you use filtering in the Beta API, you can + # also filter on nested fields. For example, you could filter on instances that + # have set the scheduling.automaticRestart field to true. In particular, use + # filtering on nested fields to take advantage of instance labels to organize + # and filter results based on label values. + # The Beta API also supports filtering on multiple expressions by providing each + # separate expression within parentheses. For example, (scheduling. + # automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are + # treated as AND expressions meaning that resources must match all expressions + # to pass the filters. # @param [Fixnum] max_results - # Maximum count of results to be returned. + # The maximum number of results per page that Compute Engine should return. If + # the number of available results is larger than maxResults, Compute Engine + # returns a nextPageToken that can be used to get the next page of results in + # subsequent list requests. # @param [String] page_token - # Specifies a page token to use. Use this parameter if you want to list the next - # page of results. Set pageToken to the nextPageToken returned by a previous - # list request. + # Specifies a page token to use. Set pageToken to the nextPageToken returned by + # a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -533,7 +581,7 @@ module Google # Updates an autoscaler resource in the specified project using the data # included in the request. This method supports patch semantics. # @param [String] project - # Name of the project scoping this request. + # Project ID for this request. # @param [String] zone # Name of the zone scoping this request. # @param [String] autoscaler @@ -578,7 +626,7 @@ module Google # Updates an autoscaler resource in the specified project using the data # included in the request. # @param [String] project - # Name of the project scoping this request. + # Project ID for this request. # @param [String] zone # Name of the zone scoping this request. # @param [Google::Apis::ComputeV1::Autoscaler] autoscaler_object @@ -622,7 +670,7 @@ module Google # Deletes the specified BackendService resource. # @param [String] project - # Name of the project scoping this request. + # Project ID for this request. # @param [String] backend_service # Name of the BackendService resource to delete. # @param [String] fields @@ -660,7 +708,7 @@ module Google # Returns the specified BackendService resource. # @param [String] project - # Name of the project scoping this request. + # Project ID for this request. # @param [String] backend_service # Name of the BackendService resource to return. # @param [String] fields @@ -739,7 +787,7 @@ module Google # Creates a BackendService resource in the specified project using the data # included in the request. # @param [String] project - # Name of the project scoping this request. + # Project ID for this request. # @param [Google::Apis::ComputeV1::BackendService] backend_service_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -778,25 +826,37 @@ module Google # Retrieves the list of BackendService resources available to the specified # project. # @param [String] project - # Name of the project scoping this request. + # Project ID for this request. # @param [String] filter # Sets a filter expression for filtering listed resources, in the form filter=` - # expression`. Your `expression` must be in the format: FIELD_NAME - # COMPARISON_STRING LITERAL_STRING. - # The FIELD_NAME is the name of the field you want to compare. Only atomic field - # types are supported (string, number, boolean). The COMPARISON_STRING must be - # either eq (equals) or ne (not equals). The LITERAL_STRING is the string value - # to filter to. The literal value must be valid for the type of field (string, - # number, boolean). For string fields, the literal value is interpreted as a - # regular expression using RE2 syntax. The literal value must match the entire - # field. + # expression`. Your `expression` must be in the format: field_name + # comparison_string literal_string. + # The field_name is the name of the field you want to compare. Only atomic field + # types are supported (string, number, boolean). The comparison_string must be + # either eq (equals) or ne (not equals). The literal_string is the string value + # to filter to. The literal value must be valid for the type of field you are + # filtering by (string, number, boolean). For string fields, the literal value + # is interpreted as a regular expression using RE2 syntax. The literal value + # must match the entire field. # For example, filter=name ne example-instance. + # Compute Engine Beta API Only: If you use filtering in the Beta API, you can + # also filter on nested fields. For example, you could filter on instances that + # have set the scheduling.automaticRestart field to true. In particular, use + # filtering on nested fields to take advantage of instance labels to organize + # and filter results based on label values. + # The Beta API also supports filtering on multiple expressions by providing each + # separate expression within parentheses. For example, (scheduling. + # automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are + # treated as AND expressions meaning that resources must match all expressions + # to pass the filters. # @param [Fixnum] max_results - # Maximum count of results to be returned. + # The maximum number of results per page that Compute Engine should return. If + # the number of available results is larger than maxResults, Compute Engine + # returns a nextPageToken that can be used to get the next page of results in + # subsequent list requests. # @param [String] page_token - # Specifies a page token to use. Use this parameter if you want to list the next - # page of results. Set pageToken to the nextPageToken returned by a previous - # list request. + # Specifies a page token to use. Set pageToken to the nextPageToken returned by + # a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -835,7 +895,7 @@ module Google # Update the entire content of the BackendService resource. This method supports # patch semantics. # @param [String] project - # Name of the project scoping this request. + # Project ID for this request. # @param [String] backend_service # Name of the BackendService resource to update. # @param [Google::Apis::ComputeV1::BackendService] backend_service_object @@ -876,7 +936,7 @@ module Google # Update the entire content of the BackendService resource. # @param [String] project - # Name of the project scoping this request. + # Project ID for this request. # @param [String] backend_service # Name of the BackendService resource to update. # @param [Google::Apis::ComputeV1::BackendService] backend_service_object @@ -920,22 +980,34 @@ module Google # Project ID for this request. # @param [String] filter # Sets a filter expression for filtering listed resources, in the form filter=` - # expression`. Your `expression` must be in the format: FIELD_NAME - # COMPARISON_STRING LITERAL_STRING. - # The FIELD_NAME is the name of the field you want to compare. Only atomic field - # types are supported (string, number, boolean). The COMPARISON_STRING must be - # either eq (equals) or ne (not equals). The LITERAL_STRING is the string value - # to filter to. The literal value must be valid for the type of field (string, - # number, boolean). For string fields, the literal value is interpreted as a - # regular expression using RE2 syntax. The literal value must match the entire - # field. + # expression`. Your `expression` must be in the format: field_name + # comparison_string literal_string. + # The field_name is the name of the field you want to compare. Only atomic field + # types are supported (string, number, boolean). The comparison_string must be + # either eq (equals) or ne (not equals). The literal_string is the string value + # to filter to. The literal value must be valid for the type of field you are + # filtering by (string, number, boolean). For string fields, the literal value + # is interpreted as a regular expression using RE2 syntax. The literal value + # must match the entire field. # For example, filter=name ne example-instance. + # Compute Engine Beta API Only: If you use filtering in the Beta API, you can + # also filter on nested fields. For example, you could filter on instances that + # have set the scheduling.automaticRestart field to true. In particular, use + # filtering on nested fields to take advantage of instance labels to organize + # and filter results based on label values. + # The Beta API also supports filtering on multiple expressions by providing each + # separate expression within parentheses. For example, (scheduling. + # automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are + # treated as AND expressions meaning that resources must match all expressions + # to pass the filters. # @param [Fixnum] max_results - # Maximum count of results to be returned. + # The maximum number of results per page that Compute Engine should return. If + # the number of available results is larger than maxResults, Compute Engine + # returns a nextPageToken that can be used to get the next page of results in + # subsequent list requests. # @param [String] page_token - # Specifies a page token to use. Use this parameter if you want to list the next - # page of results. Set pageToken to the nextPageToken returned by a previous - # list request. + # Specifies a page token to use. Set pageToken to the nextPageToken returned by + # a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1019,22 +1091,34 @@ module Google # The name of the zone for this request. # @param [String] filter # Sets a filter expression for filtering listed resources, in the form filter=` - # expression`. Your `expression` must be in the format: FIELD_NAME - # COMPARISON_STRING LITERAL_STRING. - # The FIELD_NAME is the name of the field you want to compare. Only atomic field - # types are supported (string, number, boolean). The COMPARISON_STRING must be - # either eq (equals) or ne (not equals). The LITERAL_STRING is the string value - # to filter to. The literal value must be valid for the type of field (string, - # number, boolean). For string fields, the literal value is interpreted as a - # regular expression using RE2 syntax. The literal value must match the entire - # field. + # expression`. Your `expression` must be in the format: field_name + # comparison_string literal_string. + # The field_name is the name of the field you want to compare. Only atomic field + # types are supported (string, number, boolean). The comparison_string must be + # either eq (equals) or ne (not equals). The literal_string is the string value + # to filter to. The literal value must be valid for the type of field you are + # filtering by (string, number, boolean). For string fields, the literal value + # is interpreted as a regular expression using RE2 syntax. The literal value + # must match the entire field. # For example, filter=name ne example-instance. + # Compute Engine Beta API Only: If you use filtering in the Beta API, you can + # also filter on nested fields. For example, you could filter on instances that + # have set the scheduling.automaticRestart field to true. In particular, use + # filtering on nested fields to take advantage of instance labels to organize + # and filter results based on label values. + # The Beta API also supports filtering on multiple expressions by providing each + # separate expression within parentheses. For example, (scheduling. + # automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are + # treated as AND expressions meaning that resources must match all expressions + # to pass the filters. # @param [Fixnum] max_results - # Maximum count of results to be returned. + # The maximum number of results per page that Compute Engine should return. If + # the number of available results is larger than maxResults, Compute Engine + # returns a nextPageToken that can be used to get the next page of results in + # subsequent list requests. # @param [String] page_token - # Specifies a page token to use. Use this parameter if you want to list the next - # page of results. Set pageToken to the nextPageToken returned by a previous - # list request. + # Specifies a page token to use. Set pageToken to the nextPageToken returned by + # a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1071,27 +1155,39 @@ module Google execute_or_queue_command(command, &block) end - # Retrieves the list of disks grouped by scope. + # Retrieves the list of persistent disks grouped by scope. # @param [String] project # Project ID for this request. # @param [String] filter # Sets a filter expression for filtering listed resources, in the form filter=` - # expression`. Your `expression` must be in the format: FIELD_NAME - # COMPARISON_STRING LITERAL_STRING. - # The FIELD_NAME is the name of the field you want to compare. Only atomic field - # types are supported (string, number, boolean). The COMPARISON_STRING must be - # either eq (equals) or ne (not equals). The LITERAL_STRING is the string value - # to filter to. The literal value must be valid for the type of field (string, - # number, boolean). For string fields, the literal value is interpreted as a - # regular expression using RE2 syntax. The literal value must match the entire - # field. + # expression`. Your `expression` must be in the format: field_name + # comparison_string literal_string. + # The field_name is the name of the field you want to compare. Only atomic field + # types are supported (string, number, boolean). The comparison_string must be + # either eq (equals) or ne (not equals). The literal_string is the string value + # to filter to. The literal value must be valid for the type of field you are + # filtering by (string, number, boolean). For string fields, the literal value + # is interpreted as a regular expression using RE2 syntax. The literal value + # must match the entire field. # For example, filter=name ne example-instance. + # Compute Engine Beta API Only: If you use filtering in the Beta API, you can + # also filter on nested fields. For example, you could filter on instances that + # have set the scheduling.automaticRestart field to true. In particular, use + # filtering on nested fields to take advantage of instance labels to organize + # and filter results based on label values. + # The Beta API also supports filtering on multiple expressions by providing each + # separate expression within parentheses. For example, (scheduling. + # automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are + # treated as AND expressions meaning that resources must match all expressions + # to pass the filters. # @param [Fixnum] max_results - # Maximum count of results to be returned. + # The maximum number of results per page that Compute Engine should return. If + # the number of available results is larger than maxResults, Compute Engine + # returns a nextPageToken that can be used to get the next page of results in + # subsequent list requests. # @param [String] page_token - # Specifies a page token to use. Use this parameter if you want to list the next - # page of results. Set pageToken to the nextPageToken returned by a previous - # list request. + # Specifies a page token to use. Set pageToken to the nextPageToken returned by + # a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1127,7 +1223,7 @@ module Google execute_or_queue_command(command, &block) end - # Creates a snapshot of this disk. + # Creates a snapshot of a specified persistent disk. # @param [String] project # Project ID for this request. # @param [String] zone @@ -1307,22 +1403,34 @@ module Google # The name of the zone for this request. # @param [String] filter # Sets a filter expression for filtering listed resources, in the form filter=` - # expression`. Your `expression` must be in the format: FIELD_NAME - # COMPARISON_STRING LITERAL_STRING. - # The FIELD_NAME is the name of the field you want to compare. Only atomic field - # types are supported (string, number, boolean). The COMPARISON_STRING must be - # either eq (equals) or ne (not equals). The LITERAL_STRING is the string value - # to filter to. The literal value must be valid for the type of field (string, - # number, boolean). For string fields, the literal value is interpreted as a - # regular expression using RE2 syntax. The literal value must match the entire - # field. + # expression`. Your `expression` must be in the format: field_name + # comparison_string literal_string. + # The field_name is the name of the field you want to compare. Only atomic field + # types are supported (string, number, boolean). The comparison_string must be + # either eq (equals) or ne (not equals). The literal_string is the string value + # to filter to. The literal value must be valid for the type of field you are + # filtering by (string, number, boolean). For string fields, the literal value + # is interpreted as a regular expression using RE2 syntax. The literal value + # must match the entire field. # For example, filter=name ne example-instance. + # Compute Engine Beta API Only: If you use filtering in the Beta API, you can + # also filter on nested fields. For example, you could filter on instances that + # have set the scheduling.automaticRestart field to true. In particular, use + # filtering on nested fields to take advantage of instance labels to organize + # and filter results based on label values. + # The Beta API also supports filtering on multiple expressions by providing each + # separate expression within parentheses. For example, (scheduling. + # automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are + # treated as AND expressions meaning that resources must match all expressions + # to pass the filters. # @param [Fixnum] max_results - # Maximum count of results to be returned. + # The maximum number of results per page that Compute Engine should return. If + # the number of available results is larger than maxResults, Compute Engine + # returns a nextPageToken that can be used to get the next page of results in + # subsequent list requests. # @param [String] page_token - # Specifies a page token to use. Use this parameter if you want to list the next - # page of results. Set pageToken to the nextPageToken returned by a previous - # list request. + # Specifies a page token to use. Set pageToken to the nextPageToken returned by + # a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1479,22 +1587,34 @@ module Google # Project ID for this request. # @param [String] filter # Sets a filter expression for filtering listed resources, in the form filter=` - # expression`. Your `expression` must be in the format: FIELD_NAME - # COMPARISON_STRING LITERAL_STRING. - # The FIELD_NAME is the name of the field you want to compare. Only atomic field - # types are supported (string, number, boolean). The COMPARISON_STRING must be - # either eq (equals) or ne (not equals). The LITERAL_STRING is the string value - # to filter to. The literal value must be valid for the type of field (string, - # number, boolean). For string fields, the literal value is interpreted as a - # regular expression using RE2 syntax. The literal value must match the entire - # field. + # expression`. Your `expression` must be in the format: field_name + # comparison_string literal_string. + # The field_name is the name of the field you want to compare. Only atomic field + # types are supported (string, number, boolean). The comparison_string must be + # either eq (equals) or ne (not equals). The literal_string is the string value + # to filter to. The literal value must be valid for the type of field you are + # filtering by (string, number, boolean). For string fields, the literal value + # is interpreted as a regular expression using RE2 syntax. The literal value + # must match the entire field. # For example, filter=name ne example-instance. + # Compute Engine Beta API Only: If you use filtering in the Beta API, you can + # also filter on nested fields. For example, you could filter on instances that + # have set the scheduling.automaticRestart field to true. In particular, use + # filtering on nested fields to take advantage of instance labels to organize + # and filter results based on label values. + # The Beta API also supports filtering on multiple expressions by providing each + # separate expression within parentheses. For example, (scheduling. + # automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are + # treated as AND expressions meaning that resources must match all expressions + # to pass the filters. # @param [Fixnum] max_results - # Maximum count of results to be returned. + # The maximum number of results per page that Compute Engine should return. If + # the number of available results is larger than maxResults, Compute Engine + # returns a nextPageToken that can be used to get the next page of results in + # subsequent list requests. # @param [String] page_token - # Specifies a page token to use. Use this parameter if you want to list the next - # page of results. Set pageToken to the nextPageToken returned by a previous - # list request. + # Specifies a page token to use. Set pageToken to the nextPageToken returned by + # a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1615,25 +1735,37 @@ module Google # Retrieves the list of forwarding rules grouped by scope. # @param [String] project - # Name of the project scoping this request. + # Project ID for this request. # @param [String] filter # Sets a filter expression for filtering listed resources, in the form filter=` - # expression`. Your `expression` must be in the format: FIELD_NAME - # COMPARISON_STRING LITERAL_STRING. - # The FIELD_NAME is the name of the field you want to compare. Only atomic field - # types are supported (string, number, boolean). The COMPARISON_STRING must be - # either eq (equals) or ne (not equals). The LITERAL_STRING is the string value - # to filter to. The literal value must be valid for the type of field (string, - # number, boolean). For string fields, the literal value is interpreted as a - # regular expression using RE2 syntax. The literal value must match the entire - # field. + # expression`. Your `expression` must be in the format: field_name + # comparison_string literal_string. + # The field_name is the name of the field you want to compare. Only atomic field + # types are supported (string, number, boolean). The comparison_string must be + # either eq (equals) or ne (not equals). The literal_string is the string value + # to filter to. The literal value must be valid for the type of field you are + # filtering by (string, number, boolean). For string fields, the literal value + # is interpreted as a regular expression using RE2 syntax. The literal value + # must match the entire field. # For example, filter=name ne example-instance. + # Compute Engine Beta API Only: If you use filtering in the Beta API, you can + # also filter on nested fields. For example, you could filter on instances that + # have set the scheduling.automaticRestart field to true. In particular, use + # filtering on nested fields to take advantage of instance labels to organize + # and filter results based on label values. + # The Beta API also supports filtering on multiple expressions by providing each + # separate expression within parentheses. For example, (scheduling. + # automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are + # treated as AND expressions meaning that resources must match all expressions + # to pass the filters. # @param [Fixnum] max_results - # Maximum count of results to be returned. + # The maximum number of results per page that Compute Engine should return. If + # the number of available results is larger than maxResults, Compute Engine + # returns a nextPageToken that can be used to get the next page of results in + # subsequent list requests. # @param [String] page_token - # Specifies a page token to use. Use this parameter if you want to list the next - # page of results. Set pageToken to the nextPageToken returned by a previous - # list request. + # Specifies a page token to use. Set pageToken to the nextPageToken returned by + # a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1671,7 +1803,7 @@ module Google # Deletes the specified ForwardingRule resource. # @param [String] project - # Name of the project scoping this request. + # Project ID for this request. # @param [String] region # Name of the region scoping this request. # @param [String] forwarding_rule @@ -1712,7 +1844,7 @@ module Google # Returns the specified ForwardingRule resource. # @param [String] project - # Name of the project scoping this request. + # Project ID for this request. # @param [String] region # Name of the region scoping this request. # @param [String] forwarding_rule @@ -1754,7 +1886,7 @@ module Google # Creates a ForwardingRule resource in the specified project and region using # the data included in the request. # @param [String] project - # Name of the project scoping this request. + # Project ID for this request. # @param [String] region # Name of the region scoping this request. # @param [Google::Apis::ComputeV1::ForwardingRule] forwarding_rule_object @@ -1796,27 +1928,39 @@ module Google # Retrieves the list of ForwardingRule resources available to the specified # project and region. # @param [String] project - # Name of the project scoping this request. + # Project ID for this request. # @param [String] region # Name of the region scoping this request. # @param [String] filter # Sets a filter expression for filtering listed resources, in the form filter=` - # expression`. Your `expression` must be in the format: FIELD_NAME - # COMPARISON_STRING LITERAL_STRING. - # The FIELD_NAME is the name of the field you want to compare. Only atomic field - # types are supported (string, number, boolean). The COMPARISON_STRING must be - # either eq (equals) or ne (not equals). The LITERAL_STRING is the string value - # to filter to. The literal value must be valid for the type of field (string, - # number, boolean). For string fields, the literal value is interpreted as a - # regular expression using RE2 syntax. The literal value must match the entire - # field. + # expression`. Your `expression` must be in the format: field_name + # comparison_string literal_string. + # The field_name is the name of the field you want to compare. Only atomic field + # types are supported (string, number, boolean). The comparison_string must be + # either eq (equals) or ne (not equals). The literal_string is the string value + # to filter to. The literal value must be valid for the type of field you are + # filtering by (string, number, boolean). For string fields, the literal value + # is interpreted as a regular expression using RE2 syntax. The literal value + # must match the entire field. # For example, filter=name ne example-instance. + # Compute Engine Beta API Only: If you use filtering in the Beta API, you can + # also filter on nested fields. For example, you could filter on instances that + # have set the scheduling.automaticRestart field to true. In particular, use + # filtering on nested fields to take advantage of instance labels to organize + # and filter results based on label values. + # The Beta API also supports filtering on multiple expressions by providing each + # separate expression within parentheses. For example, (scheduling. + # automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are + # treated as AND expressions meaning that resources must match all expressions + # to pass the filters. # @param [Fixnum] max_results - # Maximum count of results to be returned. + # The maximum number of results per page that Compute Engine should return. If + # the number of available results is larger than maxResults, Compute Engine + # returns a nextPageToken that can be used to get the next page of results in + # subsequent list requests. # @param [String] page_token - # Specifies a page token to use. Use this parameter if you want to list the next - # page of results. Set pageToken to the nextPageToken returned by a previous - # list request. + # Specifies a page token to use. Set pageToken to the nextPageToken returned by + # a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1853,10 +1997,10 @@ module Google execute_or_queue_command(command, &block) end - # Changes target url for forwarding rule. The new target should be of the same + # Changes target URL for forwarding rule. The new target should be of the same # type as the old target. # @param [String] project - # Name of the project scoping this request. + # Project ID for this request. # @param [String] region # Name of the region scoping this request. # @param [String] forwarding_rule @@ -2018,22 +2162,34 @@ module Google # Project ID for this request. # @param [String] filter # Sets a filter expression for filtering listed resources, in the form filter=` - # expression`. Your `expression` must be in the format: FIELD_NAME - # COMPARISON_STRING LITERAL_STRING. - # The FIELD_NAME is the name of the field you want to compare. Only atomic field - # types are supported (string, number, boolean). The COMPARISON_STRING must be - # either eq (equals) or ne (not equals). The LITERAL_STRING is the string value - # to filter to. The literal value must be valid for the type of field (string, - # number, boolean). For string fields, the literal value is interpreted as a - # regular expression using RE2 syntax. The literal value must match the entire - # field. + # expression`. Your `expression` must be in the format: field_name + # comparison_string literal_string. + # The field_name is the name of the field you want to compare. Only atomic field + # types are supported (string, number, boolean). The comparison_string must be + # either eq (equals) or ne (not equals). The literal_string is the string value + # to filter to. The literal value must be valid for the type of field you are + # filtering by (string, number, boolean). For string fields, the literal value + # is interpreted as a regular expression using RE2 syntax. The literal value + # must match the entire field. # For example, filter=name ne example-instance. + # Compute Engine Beta API Only: If you use filtering in the Beta API, you can + # also filter on nested fields. For example, you could filter on instances that + # have set the scheduling.automaticRestart field to true. In particular, use + # filtering on nested fields to take advantage of instance labels to organize + # and filter results based on label values. + # The Beta API also supports filtering on multiple expressions by providing each + # separate expression within parentheses. For example, (scheduling. + # automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are + # treated as AND expressions meaning that resources must match all expressions + # to pass the filters. # @param [Fixnum] max_results - # Maximum count of results to be returned. + # The maximum number of results per page that Compute Engine should return. If + # the number of available results is larger than maxResults, Compute Engine + # returns a nextPageToken that can be used to get the next page of results in + # subsequent list requests. # @param [String] page_token - # Specifies a page token to use. Use this parameter if you want to list the next - # page of results. Set pageToken to the nextPageToken returned by a previous - # list request. + # Specifies a page token to use. Set pageToken to the nextPageToken returned by + # a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2071,7 +2227,7 @@ module Google # Deletes the specified ForwardingRule resource. # @param [String] project - # Name of the project scoping this request. + # Project ID for this request. # @param [String] forwarding_rule # Name of the ForwardingRule resource to delete. # @param [String] fields @@ -2109,7 +2265,7 @@ module Google # Returns the specified ForwardingRule resource. # @param [String] project - # Name of the project scoping this request. + # Project ID for this request. # @param [String] forwarding_rule # Name of the ForwardingRule resource to return. # @param [String] fields @@ -2148,7 +2304,7 @@ module Google # Creates a ForwardingRule resource in the specified project and region using # the data included in the request. # @param [String] project - # Name of the project scoping this request. + # Project ID for this request. # @param [Google::Apis::ComputeV1::ForwardingRule] forwarding_rule_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -2187,25 +2343,37 @@ module Google # Retrieves the list of ForwardingRule resources available to the specified # project. # @param [String] project - # Name of the project scoping this request. + # Project ID for this request. # @param [String] filter # Sets a filter expression for filtering listed resources, in the form filter=` - # expression`. Your `expression` must be in the format: FIELD_NAME - # COMPARISON_STRING LITERAL_STRING. - # The FIELD_NAME is the name of the field you want to compare. Only atomic field - # types are supported (string, number, boolean). The COMPARISON_STRING must be - # either eq (equals) or ne (not equals). The LITERAL_STRING is the string value - # to filter to. The literal value must be valid for the type of field (string, - # number, boolean). For string fields, the literal value is interpreted as a - # regular expression using RE2 syntax. The literal value must match the entire - # field. + # expression`. Your `expression` must be in the format: field_name + # comparison_string literal_string. + # The field_name is the name of the field you want to compare. Only atomic field + # types are supported (string, number, boolean). The comparison_string must be + # either eq (equals) or ne (not equals). The literal_string is the string value + # to filter to. The literal value must be valid for the type of field you are + # filtering by (string, number, boolean). For string fields, the literal value + # is interpreted as a regular expression using RE2 syntax. The literal value + # must match the entire field. # For example, filter=name ne example-instance. + # Compute Engine Beta API Only: If you use filtering in the Beta API, you can + # also filter on nested fields. For example, you could filter on instances that + # have set the scheduling.automaticRestart field to true. In particular, use + # filtering on nested fields to take advantage of instance labels to organize + # and filter results based on label values. + # The Beta API also supports filtering on multiple expressions by providing each + # separate expression within parentheses. For example, (scheduling. + # automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are + # treated as AND expressions meaning that resources must match all expressions + # to pass the filters. # @param [Fixnum] max_results - # Maximum count of results to be returned. + # The maximum number of results per page that Compute Engine should return. If + # the number of available results is larger than maxResults, Compute Engine + # returns a nextPageToken that can be used to get the next page of results in + # subsequent list requests. # @param [String] page_token - # Specifies a page token to use. Use this parameter if you want to list the next - # page of results. Set pageToken to the nextPageToken returned by a previous - # list request. + # Specifies a page token to use. Set pageToken to the nextPageToken returned by + # a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2241,10 +2409,10 @@ module Google execute_or_queue_command(command, &block) end - # Changes target url for forwarding rule. The new target should be of the same + # Changes target URL for forwarding rule. The new target should be of the same # type as the old target. # @param [String] project - # Name of the project scoping this request. + # Project ID for this request. # @param [String] forwarding_rule # Name of the ForwardingRule resource in which target is to be set. # @param [Google::Apis::ComputeV1::TargetReference] target_reference_object @@ -2288,22 +2456,34 @@ module Google # Project ID for this request. # @param [String] filter # Sets a filter expression for filtering listed resources, in the form filter=` - # expression`. Your `expression` must be in the format: FIELD_NAME - # COMPARISON_STRING LITERAL_STRING. - # The FIELD_NAME is the name of the field you want to compare. Only atomic field - # types are supported (string, number, boolean). The COMPARISON_STRING must be - # either eq (equals) or ne (not equals). The LITERAL_STRING is the string value - # to filter to. The literal value must be valid for the type of field (string, - # number, boolean). For string fields, the literal value is interpreted as a - # regular expression using RE2 syntax. The literal value must match the entire - # field. + # expression`. Your `expression` must be in the format: field_name + # comparison_string literal_string. + # The field_name is the name of the field you want to compare. Only atomic field + # types are supported (string, number, boolean). The comparison_string must be + # either eq (equals) or ne (not equals). The literal_string is the string value + # to filter to. The literal value must be valid for the type of field you are + # filtering by (string, number, boolean). For string fields, the literal value + # is interpreted as a regular expression using RE2 syntax. The literal value + # must match the entire field. # For example, filter=name ne example-instance. + # Compute Engine Beta API Only: If you use filtering in the Beta API, you can + # also filter on nested fields. For example, you could filter on instances that + # have set the scheduling.automaticRestart field to true. In particular, use + # filtering on nested fields to take advantage of instance labels to organize + # and filter results based on label values. + # The Beta API also supports filtering on multiple expressions by providing each + # separate expression within parentheses. For example, (scheduling. + # automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are + # treated as AND expressions meaning that resources must match all expressions + # to pass the filters. # @param [Fixnum] max_results - # Maximum count of results to be returned. + # The maximum number of results per page that Compute Engine should return. If + # the number of available results is larger than maxResults, Compute Engine + # returns a nextPageToken that can be used to get the next page of results in + # subsequent list requests. # @param [String] page_token - # Specifies a page token to use. Use this parameter if you want to list the next - # page of results. Set pageToken to the nextPageToken returned by a previous - # list request. + # Specifies a page token to use. Set pageToken to the nextPageToken returned by + # a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2419,22 +2599,34 @@ module Google # Project ID for this request. # @param [String] filter # Sets a filter expression for filtering listed resources, in the form filter=` - # expression`. Your `expression` must be in the format: FIELD_NAME - # COMPARISON_STRING LITERAL_STRING. - # The FIELD_NAME is the name of the field you want to compare. Only atomic field - # types are supported (string, number, boolean). The COMPARISON_STRING must be - # either eq (equals) or ne (not equals). The LITERAL_STRING is the string value - # to filter to. The literal value must be valid for the type of field (string, - # number, boolean). For string fields, the literal value is interpreted as a - # regular expression using RE2 syntax. The literal value must match the entire - # field. + # expression`. Your `expression` must be in the format: field_name + # comparison_string literal_string. + # The field_name is the name of the field you want to compare. Only atomic field + # types are supported (string, number, boolean). The comparison_string must be + # either eq (equals) or ne (not equals). The literal_string is the string value + # to filter to. The literal value must be valid for the type of field you are + # filtering by (string, number, boolean). For string fields, the literal value + # is interpreted as a regular expression using RE2 syntax. The literal value + # must match the entire field. # For example, filter=name ne example-instance. + # Compute Engine Beta API Only: If you use filtering in the Beta API, you can + # also filter on nested fields. For example, you could filter on instances that + # have set the scheduling.automaticRestart field to true. In particular, use + # filtering on nested fields to take advantage of instance labels to organize + # and filter results based on label values. + # The Beta API also supports filtering on multiple expressions by providing each + # separate expression within parentheses. For example, (scheduling. + # automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are + # treated as AND expressions meaning that resources must match all expressions + # to pass the filters. # @param [Fixnum] max_results - # Maximum count of results to be returned. + # The maximum number of results per page that Compute Engine should return. If + # the number of available results is larger than maxResults, Compute Engine + # returns a nextPageToken that can be used to get the next page of results in + # subsequent list requests. # @param [String] page_token - # Specifies a page token to use. Use this parameter if you want to list the next - # page of results. Set pageToken to the nextPageToken returned by a previous - # list request. + # Specifies a page token to use. Set pageToken to the nextPageToken returned by + # a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2472,7 +2664,7 @@ module Google # Deletes the specified HttpHealthCheck resource. # @param [String] project - # Name of the project scoping this request. + # Project ID for this request. # @param [String] http_health_check # Name of the HttpHealthCheck resource to delete. # @param [String] fields @@ -2510,7 +2702,7 @@ module Google # Returns the specified HttpHealthCheck resource. # @param [String] project - # Name of the project scoping this request. + # Project ID for this request. # @param [String] http_health_check # Name of the HttpHealthCheck resource to return. # @param [String] fields @@ -2549,7 +2741,7 @@ module Google # Creates a HttpHealthCheck resource in the specified project using the data # included in the request. # @param [String] project - # Name of the project scoping this request. + # Project ID for this request. # @param [Google::Apis::ComputeV1::HttpHealthCheck] http_health_check_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -2588,25 +2780,37 @@ module Google # Retrieves the list of HttpHealthCheck resources available to the specified # project. # @param [String] project - # Name of the project scoping this request. + # Project ID for this request. # @param [String] filter # Sets a filter expression for filtering listed resources, in the form filter=` - # expression`. Your `expression` must be in the format: FIELD_NAME - # COMPARISON_STRING LITERAL_STRING. - # The FIELD_NAME is the name of the field you want to compare. Only atomic field - # types are supported (string, number, boolean). The COMPARISON_STRING must be - # either eq (equals) or ne (not equals). The LITERAL_STRING is the string value - # to filter to. The literal value must be valid for the type of field (string, - # number, boolean). For string fields, the literal value is interpreted as a - # regular expression using RE2 syntax. The literal value must match the entire - # field. + # expression`. Your `expression` must be in the format: field_name + # comparison_string literal_string. + # The field_name is the name of the field you want to compare. Only atomic field + # types are supported (string, number, boolean). The comparison_string must be + # either eq (equals) or ne (not equals). The literal_string is the string value + # to filter to. The literal value must be valid for the type of field you are + # filtering by (string, number, boolean). For string fields, the literal value + # is interpreted as a regular expression using RE2 syntax. The literal value + # must match the entire field. # For example, filter=name ne example-instance. + # Compute Engine Beta API Only: If you use filtering in the Beta API, you can + # also filter on nested fields. For example, you could filter on instances that + # have set the scheduling.automaticRestart field to true. In particular, use + # filtering on nested fields to take advantage of instance labels to organize + # and filter results based on label values. + # The Beta API also supports filtering on multiple expressions by providing each + # separate expression within parentheses. For example, (scheduling. + # automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are + # treated as AND expressions meaning that resources must match all expressions + # to pass the filters. # @param [Fixnum] max_results - # Maximum count of results to be returned. + # The maximum number of results per page that Compute Engine should return. If + # the number of available results is larger than maxResults, Compute Engine + # returns a nextPageToken that can be used to get the next page of results in + # subsequent list requests. # @param [String] page_token - # Specifies a page token to use. Use this parameter if you want to list the next - # page of results. Set pageToken to the nextPageToken returned by a previous - # list request. + # Specifies a page token to use. Set pageToken to the nextPageToken returned by + # a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2645,7 +2849,7 @@ module Google # Updates a HttpHealthCheck resource in the specified project using the data # included in the request. This method supports patch semantics. # @param [String] project - # Name of the project scoping this request. + # Project ID for this request. # @param [String] http_health_check # Name of the HttpHealthCheck resource to update. # @param [Google::Apis::ComputeV1::HttpHealthCheck] http_health_check_object @@ -2687,7 +2891,7 @@ module Google # Updates a HttpHealthCheck resource in the specified project using the data # included in the request. # @param [String] project - # Name of the project scoping this request. + # Project ID for this request. # @param [String] http_health_check # Name of the HttpHealthCheck resource to update. # @param [Google::Apis::ComputeV1::HttpHealthCheck] http_health_check_object @@ -2728,7 +2932,7 @@ module Google # Deletes the specified HttpsHealthCheck resource. # @param [String] project - # Name of the project scoping this request. + # Project ID for this request. # @param [String] https_health_check # Name of the HttpsHealthCheck resource to delete. # @param [String] fields @@ -2766,7 +2970,7 @@ module Google # Returns the specified HttpsHealthCheck resource. # @param [String] project - # Name of the project scoping this request. + # Project ID for this request. # @param [String] https_health_check # Name of the HttpsHealthCheck resource to return. # @param [String] fields @@ -2805,7 +3009,7 @@ module Google # Creates a HttpsHealthCheck resource in the specified project using the data # included in the request. # @param [String] project - # Name of the project scoping this request. + # Project ID for this request. # @param [Google::Apis::ComputeV1::HttpsHealthCheck] https_health_check_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -2844,25 +3048,37 @@ module Google # Retrieves the list of HttpsHealthCheck resources available to the specified # project. # @param [String] project - # Name of the project scoping this request. + # Project ID for this request. # @param [String] filter # Sets a filter expression for filtering listed resources, in the form filter=` - # expression`. Your `expression` must be in the format: FIELD_NAME - # COMPARISON_STRING LITERAL_STRING. - # The FIELD_NAME is the name of the field you want to compare. Only atomic field - # types are supported (string, number, boolean). The COMPARISON_STRING must be - # either eq (equals) or ne (not equals). The LITERAL_STRING is the string value - # to filter to. The literal value must be valid for the type of field (string, - # number, boolean). For string fields, the literal value is interpreted as a - # regular expression using RE2 syntax. The literal value must match the entire - # field. + # expression`. Your `expression` must be in the format: field_name + # comparison_string literal_string. + # The field_name is the name of the field you want to compare. Only atomic field + # types are supported (string, number, boolean). The comparison_string must be + # either eq (equals) or ne (not equals). The literal_string is the string value + # to filter to. The literal value must be valid for the type of field you are + # filtering by (string, number, boolean). For string fields, the literal value + # is interpreted as a regular expression using RE2 syntax. The literal value + # must match the entire field. # For example, filter=name ne example-instance. + # Compute Engine Beta API Only: If you use filtering in the Beta API, you can + # also filter on nested fields. For example, you could filter on instances that + # have set the scheduling.automaticRestart field to true. In particular, use + # filtering on nested fields to take advantage of instance labels to organize + # and filter results based on label values. + # The Beta API also supports filtering on multiple expressions by providing each + # separate expression within parentheses. For example, (scheduling. + # automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are + # treated as AND expressions meaning that resources must match all expressions + # to pass the filters. # @param [Fixnum] max_results - # Maximum count of results to be returned. + # The maximum number of results per page that Compute Engine should return. If + # the number of available results is larger than maxResults, Compute Engine + # returns a nextPageToken that can be used to get the next page of results in + # subsequent list requests. # @param [String] page_token - # Specifies a page token to use. Use this parameter if you want to list the next - # page of results. Set pageToken to the nextPageToken returned by a previous - # list request. + # Specifies a page token to use. Set pageToken to the nextPageToken returned by + # a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2901,7 +3117,7 @@ module Google # Updates a HttpsHealthCheck resource in the specified project using the data # included in the request. This method supports patch semantics. # @param [String] project - # Name of the project scoping this request. + # Project ID for this request. # @param [String] https_health_check # Name of the HttpsHealthCheck resource to update. # @param [Google::Apis::ComputeV1::HttpsHealthCheck] https_health_check_object @@ -2943,7 +3159,7 @@ module Google # Updates a HttpsHealthCheck resource in the specified project using the data # included in the request. # @param [String] project - # Name of the project scoping this request. + # Project ID for this request. # @param [String] https_health_check # Name of the HttpsHealthCheck resource to update. # @param [Google::Apis::ComputeV1::HttpsHealthCheck] https_health_check_object @@ -3150,22 +3366,34 @@ module Google # Project ID for this request. # @param [String] filter # Sets a filter expression for filtering listed resources, in the form filter=` - # expression`. Your `expression` must be in the format: FIELD_NAME - # COMPARISON_STRING LITERAL_STRING. - # The FIELD_NAME is the name of the field you want to compare. Only atomic field - # types are supported (string, number, boolean). The COMPARISON_STRING must be - # either eq (equals) or ne (not equals). The LITERAL_STRING is the string value - # to filter to. The literal value must be valid for the type of field (string, - # number, boolean). For string fields, the literal value is interpreted as a - # regular expression using RE2 syntax. The literal value must match the entire - # field. + # expression`. Your `expression` must be in the format: field_name + # comparison_string literal_string. + # The field_name is the name of the field you want to compare. Only atomic field + # types are supported (string, number, boolean). The comparison_string must be + # either eq (equals) or ne (not equals). The literal_string is the string value + # to filter to. The literal value must be valid for the type of field you are + # filtering by (string, number, boolean). For string fields, the literal value + # is interpreted as a regular expression using RE2 syntax. The literal value + # must match the entire field. # For example, filter=name ne example-instance. + # Compute Engine Beta API Only: If you use filtering in the Beta API, you can + # also filter on nested fields. For example, you could filter on instances that + # have set the scheduling.automaticRestart field to true. In particular, use + # filtering on nested fields to take advantage of instance labels to organize + # and filter results based on label values. + # The Beta API also supports filtering on multiple expressions by providing each + # separate expression within parentheses. For example, (scheduling. + # automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are + # treated as AND expressions meaning that resources must match all expressions + # to pass the filters. # @param [Fixnum] max_results - # Maximum count of results to be returned. + # The maximum number of results per page that Compute Engine should return. If + # the number of available results is larger than maxResults, Compute Engine + # returns a nextPageToken that can be used to get the next page of results in + # subsequent list requests. # @param [String] page_token - # Specifies a page token to use. Use this parameter if you want to list the next - # page of results. Set pageToken to the nextPageToken returned by a previous - # list request. + # Specifies a page token to use. Set pageToken to the nextPageToken returned by + # a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -3210,7 +3438,7 @@ module Google # removed from the group. You must separately verify the status of the # abandoning action with the listmanagedinstances method. # @param [String] project - # The project ID for this request. + # Project ID for this request. # @param [String] zone # The name of the zone where the managed instance group is located. # @param [String] instance_group_manager @@ -3254,25 +3482,37 @@ module Google # Retrieves the list of managed instance groups and groups them by zone. # @param [String] project - # The project ID for this request. + # Project ID for this request. # @param [String] filter # Sets a filter expression for filtering listed resources, in the form filter=` - # expression`. Your `expression` must be in the format: FIELD_NAME - # COMPARISON_STRING LITERAL_STRING. - # The FIELD_NAME is the name of the field you want to compare. Only atomic field - # types are supported (string, number, boolean). The COMPARISON_STRING must be - # either eq (equals) or ne (not equals). The LITERAL_STRING is the string value - # to filter to. The literal value must be valid for the type of field (string, - # number, boolean). For string fields, the literal value is interpreted as a - # regular expression using RE2 syntax. The literal value must match the entire - # field. + # expression`. Your `expression` must be in the format: field_name + # comparison_string literal_string. + # The field_name is the name of the field you want to compare. Only atomic field + # types are supported (string, number, boolean). The comparison_string must be + # either eq (equals) or ne (not equals). The literal_string is the string value + # to filter to. The literal value must be valid for the type of field you are + # filtering by (string, number, boolean). For string fields, the literal value + # is interpreted as a regular expression using RE2 syntax. The literal value + # must match the entire field. # For example, filter=name ne example-instance. + # Compute Engine Beta API Only: If you use filtering in the Beta API, you can + # also filter on nested fields. For example, you could filter on instances that + # have set the scheduling.automaticRestart field to true. In particular, use + # filtering on nested fields to take advantage of instance labels to organize + # and filter results based on label values. + # The Beta API also supports filtering on multiple expressions by providing each + # separate expression within parentheses. For example, (scheduling. + # automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are + # treated as AND expressions meaning that resources must match all expressions + # to pass the filters. # @param [Fixnum] max_results - # Maximum count of results to be returned. + # The maximum number of results per page that Compute Engine should return. If + # the number of available results is larger than maxResults, Compute Engine + # returns a nextPageToken that can be used to get the next page of results in + # subsequent list requests. # @param [String] page_token - # Specifies a page token to use. Use this parameter if you want to list the next - # page of results. Set pageToken to the nextPageToken returned by a previous - # list request. + # Specifies a page token to use. Set pageToken to the nextPageToken returned by + # a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -3311,7 +3551,7 @@ module Google # Deletes the specified managed instance group and all of the instances in that # group. # @param [String] project - # The project ID for this request. + # Project ID for this request. # @param [String] zone # The name of the zone where the managed instance group is located. # @param [String] instance_group_manager @@ -3358,7 +3598,7 @@ module Google # deleted. You must separately verify the status of the deleting action with the # listmanagedinstances method. # @param [String] project - # The project ID for this request. + # Project ID for this request. # @param [String] zone # The name of the zone where the managed instance group is located. # @param [String] instance_group_manager @@ -3402,7 +3642,7 @@ module Google # Returns all of the details about the specified managed instance group. # @param [String] project - # The project ID for this request. + # Project ID for this request. # @param [String] zone # The name of the zone where the managed instance group is located. # @param [String] instance_group_manager @@ -3448,7 +3688,7 @@ module Google # have not yet been created. You must separately verify the status of the # individual instances with the listmanagedinstances method. # @param [String] project - # The project ID for this request. + # Project ID for this request. # @param [String] zone # The name of the zone where you want to create the managed instance group. # @param [Google::Apis::ComputeV1::InstanceGroupManager] instance_group_manager_object @@ -3490,27 +3730,39 @@ module Google # Retrieves a list of managed instance groups that are contained within the # specified project and zone. # @param [String] project - # The project ID for this request. + # Project ID for this request. # @param [String] zone # The name of the zone where the managed instance group is located. # @param [String] filter # Sets a filter expression for filtering listed resources, in the form filter=` - # expression`. Your `expression` must be in the format: FIELD_NAME - # COMPARISON_STRING LITERAL_STRING. - # The FIELD_NAME is the name of the field you want to compare. Only atomic field - # types are supported (string, number, boolean). The COMPARISON_STRING must be - # either eq (equals) or ne (not equals). The LITERAL_STRING is the string value - # to filter to. The literal value must be valid for the type of field (string, - # number, boolean). For string fields, the literal value is interpreted as a - # regular expression using RE2 syntax. The literal value must match the entire - # field. + # expression`. Your `expression` must be in the format: field_name + # comparison_string literal_string. + # The field_name is the name of the field you want to compare. Only atomic field + # types are supported (string, number, boolean). The comparison_string must be + # either eq (equals) or ne (not equals). The literal_string is the string value + # to filter to. The literal value must be valid for the type of field you are + # filtering by (string, number, boolean). For string fields, the literal value + # is interpreted as a regular expression using RE2 syntax. The literal value + # must match the entire field. # For example, filter=name ne example-instance. + # Compute Engine Beta API Only: If you use filtering in the Beta API, you can + # also filter on nested fields. For example, you could filter on instances that + # have set the scheduling.automaticRestart field to true. In particular, use + # filtering on nested fields to take advantage of instance labels to organize + # and filter results based on label values. + # The Beta API also supports filtering on multiple expressions by providing each + # separate expression within parentheses. For example, (scheduling. + # automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are + # treated as AND expressions meaning that resources must match all expressions + # to pass the filters. # @param [Fixnum] max_results - # Maximum count of results to be returned. + # The maximum number of results per page that Compute Engine should return. If + # the number of available results is larger than maxResults, Compute Engine + # returns a nextPageToken that can be used to get the next page of results in + # subsequent list requests. # @param [String] page_token - # Specifies a page token to use. Use this parameter if you want to list the next - # page of results. Set pageToken to the nextPageToken returned by a previous - # list request. + # Specifies a page token to use. Set pageToken to the nextPageToken returned by + # a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -3553,7 +3805,7 @@ module Google # creating an instance, the currentAction is CREATING. If a previous action # failed, the list displays the errors for that failed action. # @param [String] project - # The project ID for this request. + # Project ID for this request. # @param [String] zone # The name of the zone where the managed instance group is located. # @param [String] instance_group_manager @@ -3599,7 +3851,7 @@ module Google # recreated. You must separately verify the status of the recreating action with # the listmanagedinstances method. # @param [String] project - # The project ID for this request. + # Project ID for this request. # @param [String] zone # The name of the zone where the managed instance group is located. # @param [String] instance_group_manager @@ -3648,7 +3900,7 @@ module Google # deleted any instances. You must separately verify the status of the creating # or deleting actions with the listmanagedinstances method. # @param [String] project - # The project ID for this request. + # Project ID for this request. # @param [String] zone # The name of the zone where the managed instance group is located. # @param [String] instance_group_manager @@ -3696,7 +3948,7 @@ module Google # group. The templates for existing instances in the group do not change unless # you recreate them. # @param [String] project - # The project ID for this request. + # Project ID for this request. # @param [String] zone # The name of the zone where the managed instance group is located. # @param [String] instance_group_manager @@ -3745,7 +3997,7 @@ module Google # target pools. The change might take some time to apply to all of the instances # in the group depending on the size of the group. # @param [String] project - # The project ID for this request. + # Project ID for this request. # @param [String] zone # The name of the zone where the managed instance group is located. # @param [String] instance_group_manager @@ -3790,7 +4042,7 @@ module Google # Adds a list of instances to the specified instance group. All of the instances # in the instance group must be in the same network/subnetwork. # @param [String] project - # The project ID for this request. + # Project ID for this request. # @param [String] zone # The name of the zone where the instance group is located. # @param [String] instance_group @@ -3834,25 +4086,37 @@ module Google # Retrieves the list of instance groups and sorts them by zone. # @param [String] project - # The project ID for this request. + # Project ID for this request. # @param [String] filter # Sets a filter expression for filtering listed resources, in the form filter=` - # expression`. Your `expression` must be in the format: FIELD_NAME - # COMPARISON_STRING LITERAL_STRING. - # The FIELD_NAME is the name of the field you want to compare. Only atomic field - # types are supported (string, number, boolean). The COMPARISON_STRING must be - # either eq (equals) or ne (not equals). The LITERAL_STRING is the string value - # to filter to. The literal value must be valid for the type of field (string, - # number, boolean). For string fields, the literal value is interpreted as a - # regular expression using RE2 syntax. The literal value must match the entire - # field. + # expression`. Your `expression` must be in the format: field_name + # comparison_string literal_string. + # The field_name is the name of the field you want to compare. Only atomic field + # types are supported (string, number, boolean). The comparison_string must be + # either eq (equals) or ne (not equals). The literal_string is the string value + # to filter to. The literal value must be valid for the type of field you are + # filtering by (string, number, boolean). For string fields, the literal value + # is interpreted as a regular expression using RE2 syntax. The literal value + # must match the entire field. # For example, filter=name ne example-instance. + # Compute Engine Beta API Only: If you use filtering in the Beta API, you can + # also filter on nested fields. For example, you could filter on instances that + # have set the scheduling.automaticRestart field to true. In particular, use + # filtering on nested fields to take advantage of instance labels to organize + # and filter results based on label values. + # The Beta API also supports filtering on multiple expressions by providing each + # separate expression within parentheses. For example, (scheduling. + # automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are + # treated as AND expressions meaning that resources must match all expressions + # to pass the filters. # @param [Fixnum] max_results - # Maximum count of results to be returned. + # The maximum number of results per page that Compute Engine should return. If + # the number of available results is larger than maxResults, Compute Engine + # returns a nextPageToken that can be used to get the next page of results in + # subsequent list requests. # @param [String] page_token - # Specifies a page token to use. Use this parameter if you want to list the next - # page of results. Set pageToken to the nextPageToken returned by a previous - # list request. + # Specifies a page token to use. Set pageToken to the nextPageToken returned by + # a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -3891,7 +4155,7 @@ module Google # Deletes the specified instance group. The instances in the group are not # deleted. # @param [String] project - # The project ID for this request. + # Project ID for this request. # @param [String] zone # The name of the zone where the instance group is located. # @param [String] instance_group @@ -3932,7 +4196,7 @@ module Google # Returns the specified instance group resource. # @param [String] project - # The project ID for this request. + # Project ID for this request. # @param [String] zone # The name of the zone where the instance group is located. # @param [String] instance_group @@ -3974,7 +4238,7 @@ module Google # Creates an instance group in the specified project using the parameters that # are included in the request. # @param [String] project - # The project ID for this request. + # Project ID for this request. # @param [String] zone # The name of the zone where you want to create the instance group. # @param [Google::Apis::ComputeV1::InstanceGroup] instance_group_object @@ -4016,27 +4280,39 @@ module Google # Retrieves the list of instance groups that are located in the specified # project and zone. # @param [String] project - # The project ID for this request. + # Project ID for this request. # @param [String] zone # The name of the zone where the instance group is located. # @param [String] filter # Sets a filter expression for filtering listed resources, in the form filter=` - # expression`. Your `expression` must be in the format: FIELD_NAME - # COMPARISON_STRING LITERAL_STRING. - # The FIELD_NAME is the name of the field you want to compare. Only atomic field - # types are supported (string, number, boolean). The COMPARISON_STRING must be - # either eq (equals) or ne (not equals). The LITERAL_STRING is the string value - # to filter to. The literal value must be valid for the type of field (string, - # number, boolean). For string fields, the literal value is interpreted as a - # regular expression using RE2 syntax. The literal value must match the entire - # field. + # expression`. Your `expression` must be in the format: field_name + # comparison_string literal_string. + # The field_name is the name of the field you want to compare. Only atomic field + # types are supported (string, number, boolean). The comparison_string must be + # either eq (equals) or ne (not equals). The literal_string is the string value + # to filter to. The literal value must be valid for the type of field you are + # filtering by (string, number, boolean). For string fields, the literal value + # is interpreted as a regular expression using RE2 syntax. The literal value + # must match the entire field. # For example, filter=name ne example-instance. + # Compute Engine Beta API Only: If you use filtering in the Beta API, you can + # also filter on nested fields. For example, you could filter on instances that + # have set the scheduling.automaticRestart field to true. In particular, use + # filtering on nested fields to take advantage of instance labels to organize + # and filter results based on label values. + # The Beta API also supports filtering on multiple expressions by providing each + # separate expression within parentheses. For example, (scheduling. + # automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are + # treated as AND expressions meaning that resources must match all expressions + # to pass the filters. # @param [Fixnum] max_results - # Maximum count of results to be returned. + # The maximum number of results per page that Compute Engine should return. If + # the number of available results is larger than maxResults, Compute Engine + # returns a nextPageToken that can be used to get the next page of results in + # subsequent list requests. # @param [String] page_token - # Specifies a page token to use. Use this parameter if you want to list the next - # page of results. Set pageToken to the nextPageToken returned by a previous - # list request. + # Specifies a page token to use. Set pageToken to the nextPageToken returned by + # a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -4075,7 +4351,7 @@ module Google # Lists the instances in the specified instance group. # @param [String] project - # The project ID for this request. + # Project ID for this request. # @param [String] zone # The name of the zone where the instance group is located. # @param [String] instance_group @@ -4084,22 +4360,34 @@ module Google # @param [Google::Apis::ComputeV1::InstanceGroupsListInstancesRequest] instance_groups_list_instances_request_object # @param [String] filter # Sets a filter expression for filtering listed resources, in the form filter=` - # expression`. Your `expression` must be in the format: FIELD_NAME - # COMPARISON_STRING LITERAL_STRING. - # The FIELD_NAME is the name of the field you want to compare. Only atomic field - # types are supported (string, number, boolean). The COMPARISON_STRING must be - # either eq (equals) or ne (not equals). The LITERAL_STRING is the string value - # to filter to. The literal value must be valid for the type of field (string, - # number, boolean). For string fields, the literal value is interpreted as a - # regular expression using RE2 syntax. The literal value must match the entire - # field. + # expression`. Your `expression` must be in the format: field_name + # comparison_string literal_string. + # The field_name is the name of the field you want to compare. Only atomic field + # types are supported (string, number, boolean). The comparison_string must be + # either eq (equals) or ne (not equals). The literal_string is the string value + # to filter to. The literal value must be valid for the type of field you are + # filtering by (string, number, boolean). For string fields, the literal value + # is interpreted as a regular expression using RE2 syntax. The literal value + # must match the entire field. # For example, filter=name ne example-instance. + # Compute Engine Beta API Only: If you use filtering in the Beta API, you can + # also filter on nested fields. For example, you could filter on instances that + # have set the scheduling.automaticRestart field to true. In particular, use + # filtering on nested fields to take advantage of instance labels to organize + # and filter results based on label values. + # The Beta API also supports filtering on multiple expressions by providing each + # separate expression within parentheses. For example, (scheduling. + # automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are + # treated as AND expressions meaning that resources must match all expressions + # to pass the filters. # @param [Fixnum] max_results - # Maximum count of results to be returned. + # The maximum number of results per page that Compute Engine should return. If + # the number of available results is larger than maxResults, Compute Engine + # returns a nextPageToken that can be used to get the next page of results in + # subsequent list requests. # @param [String] page_token - # Specifies a page token to use. Use this parameter if you want to list the next - # page of results. Set pageToken to the nextPageToken returned by a previous - # list request. + # Specifies a page token to use. Set pageToken to the nextPageToken returned by + # a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -4142,7 +4430,7 @@ module Google # Removes one or more instances from the specified instance group, but does not # delete those instances. # @param [String] project - # The project ID for this request. + # Project ID for this request. # @param [String] zone # The name of the zone where the instance group is located. # @param [String] instance_group @@ -4186,7 +4474,7 @@ module Google # Sets the named ports for the specified instance group. # @param [String] project - # The project ID for this request. + # Project ID for this request. # @param [String] zone # The name of the zone where the instance group is located. # @param [String] instance_group @@ -4230,7 +4518,7 @@ module Google # Deletes the specified instance template. # @param [String] project - # The project ID for this request. + # Project ID for this request. # @param [String] instance_template # The name of the instance template to delete. # @param [String] fields @@ -4268,7 +4556,7 @@ module Google # Returns the specified instance template resource. # @param [String] project - # The project ID for this request. + # Project ID for this request. # @param [String] instance_template # The name of the instance template. # @param [String] fields @@ -4307,7 +4595,7 @@ module Google # Creates an instance template in the specified project using the data that is # included in the request. # @param [String] project - # The project ID for this request. + # Project ID for this request. # @param [Google::Apis::ComputeV1::InstanceTemplate] instance_template_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -4346,25 +4634,37 @@ module Google # Retrieves a list of instance templates that are contained within the specified # project and zone. # @param [String] project - # The project ID for this request. + # Project ID for this request. # @param [String] filter # Sets a filter expression for filtering listed resources, in the form filter=` - # expression`. Your `expression` must be in the format: FIELD_NAME - # COMPARISON_STRING LITERAL_STRING. - # The FIELD_NAME is the name of the field you want to compare. Only atomic field - # types are supported (string, number, boolean). The COMPARISON_STRING must be - # either eq (equals) or ne (not equals). The LITERAL_STRING is the string value - # to filter to. The literal value must be valid for the type of field (string, - # number, boolean). For string fields, the literal value is interpreted as a - # regular expression using RE2 syntax. The literal value must match the entire - # field. + # expression`. Your `expression` must be in the format: field_name + # comparison_string literal_string. + # The field_name is the name of the field you want to compare. Only atomic field + # types are supported (string, number, boolean). The comparison_string must be + # either eq (equals) or ne (not equals). The literal_string is the string value + # to filter to. The literal value must be valid for the type of field you are + # filtering by (string, number, boolean). For string fields, the literal value + # is interpreted as a regular expression using RE2 syntax. The literal value + # must match the entire field. # For example, filter=name ne example-instance. + # Compute Engine Beta API Only: If you use filtering in the Beta API, you can + # also filter on nested fields. For example, you could filter on instances that + # have set the scheduling.automaticRestart field to true. In particular, use + # filtering on nested fields to take advantage of instance labels to organize + # and filter results based on label values. + # The Beta API also supports filtering on multiple expressions by providing each + # separate expression within parentheses. For example, (scheduling. + # automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are + # treated as AND expressions meaning that resources must match all expressions + # to pass the filters. # @param [Fixnum] max_results - # Maximum count of results to be returned. + # The maximum number of results per page that Compute Engine should return. If + # the number of available results is larger than maxResults, Compute Engine + # returns a nextPageToken that can be used to get the next page of results in + # subsequent list requests. # @param [String] page_token - # Specifies a page token to use. Use this parameter if you want to list the next - # page of results. Set pageToken to the nextPageToken returned by a previous - # list request. + # Specifies a page token to use. Set pageToken to the nextPageToken returned by + # a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -4452,22 +4752,34 @@ module Google # Project ID for this request. # @param [String] filter # Sets a filter expression for filtering listed resources, in the form filter=` - # expression`. Your `expression` must be in the format: FIELD_NAME - # COMPARISON_STRING LITERAL_STRING. - # The FIELD_NAME is the name of the field you want to compare. Only atomic field - # types are supported (string, number, boolean). The COMPARISON_STRING must be - # either eq (equals) or ne (not equals). The LITERAL_STRING is the string value - # to filter to. The literal value must be valid for the type of field (string, - # number, boolean). For string fields, the literal value is interpreted as a - # regular expression using RE2 syntax. The literal value must match the entire - # field. + # expression`. Your `expression` must be in the format: field_name + # comparison_string literal_string. + # The field_name is the name of the field you want to compare. Only atomic field + # types are supported (string, number, boolean). The comparison_string must be + # either eq (equals) or ne (not equals). The literal_string is the string value + # to filter to. The literal value must be valid for the type of field you are + # filtering by (string, number, boolean). For string fields, the literal value + # is interpreted as a regular expression using RE2 syntax. The literal value + # must match the entire field. # For example, filter=name ne example-instance. + # Compute Engine Beta API Only: If you use filtering in the Beta API, you can + # also filter on nested fields. For example, you could filter on instances that + # have set the scheduling.automaticRestart field to true. In particular, use + # filtering on nested fields to take advantage of instance labels to organize + # and filter results based on label values. + # The Beta API also supports filtering on multiple expressions by providing each + # separate expression within parentheses. For example, (scheduling. + # automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are + # treated as AND expressions meaning that resources must match all expressions + # to pass the filters. # @param [Fixnum] max_results - # Maximum count of results to be returned. + # The maximum number of results per page that Compute Engine should return. If + # the number of available results is larger than maxResults, Compute Engine + # returns a nextPageToken that can be used to get the next page of results in + # subsequent list requests. # @param [String] page_token - # Specifies a page token to use. Use this parameter if you want to list the next - # page of results. Set pageToken to the nextPageToken returned by a previous - # list request. + # Specifies a page token to use. Set pageToken to the nextPageToken returned by + # a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -4547,8 +4859,8 @@ module Google execute_or_queue_command(command, &block) end - # Deletes the specified Instance resource. For more information, see Shutting - # down an instance. + # Deletes the specified Instance resource. For more information, see Stopping or + # Deleting an Instance. # @param [String] project # Project ID for this request. # @param [String] zone @@ -4814,22 +5126,34 @@ module Google # The name of the zone for this request. # @param [String] filter # Sets a filter expression for filtering listed resources, in the form filter=` - # expression`. Your `expression` must be in the format: FIELD_NAME - # COMPARISON_STRING LITERAL_STRING. - # The FIELD_NAME is the name of the field you want to compare. Only atomic field - # types are supported (string, number, boolean). The COMPARISON_STRING must be - # either eq (equals) or ne (not equals). The LITERAL_STRING is the string value - # to filter to. The literal value must be valid for the type of field (string, - # number, boolean). For string fields, the literal value is interpreted as a - # regular expression using RE2 syntax. The literal value must match the entire - # field. + # expression`. Your `expression` must be in the format: field_name + # comparison_string literal_string. + # The field_name is the name of the field you want to compare. Only atomic field + # types are supported (string, number, boolean). The comparison_string must be + # either eq (equals) or ne (not equals). The literal_string is the string value + # to filter to. The literal value must be valid for the type of field you are + # filtering by (string, number, boolean). For string fields, the literal value + # is interpreted as a regular expression using RE2 syntax. The literal value + # must match the entire field. # For example, filter=name ne example-instance. + # Compute Engine Beta API Only: If you use filtering in the Beta API, you can + # also filter on nested fields. For example, you could filter on instances that + # have set the scheduling.automaticRestart field to true. In particular, use + # filtering on nested fields to take advantage of instance labels to organize + # and filter results based on label values. + # The Beta API also supports filtering on multiple expressions by providing each + # separate expression within parentheses. For example, (scheduling. + # automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are + # treated as AND expressions meaning that resources must match all expressions + # to pass the filters. # @param [Fixnum] max_results - # Maximum count of results to be returned. + # The maximum number of results per page that Compute Engine should return. If + # the number of available results is larger than maxResults, Compute Engine + # returns a nextPageToken that can be used to get the next page of results in + # subsequent list requests. # @param [String] page_token - # Specifies a page token to use. Use this parameter if you want to list the next - # page of results. Set pageToken to the nextPageToken returned by a previous - # list request. + # Specifies a page token to use. Set pageToken to the nextPageToken returned by + # a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -5217,22 +5541,34 @@ module Google # Project ID for this request. # @param [String] filter # Sets a filter expression for filtering listed resources, in the form filter=` - # expression`. Your `expression` must be in the format: FIELD_NAME - # COMPARISON_STRING LITERAL_STRING. - # The FIELD_NAME is the name of the field you want to compare. Only atomic field - # types are supported (string, number, boolean). The COMPARISON_STRING must be - # either eq (equals) or ne (not equals). The LITERAL_STRING is the string value - # to filter to. The literal value must be valid for the type of field (string, - # number, boolean). For string fields, the literal value is interpreted as a - # regular expression using RE2 syntax. The literal value must match the entire - # field. + # expression`. Your `expression` must be in the format: field_name + # comparison_string literal_string. + # The field_name is the name of the field you want to compare. Only atomic field + # types are supported (string, number, boolean). The comparison_string must be + # either eq (equals) or ne (not equals). The literal_string is the string value + # to filter to. The literal value must be valid for the type of field you are + # filtering by (string, number, boolean). For string fields, the literal value + # is interpreted as a regular expression using RE2 syntax. The literal value + # must match the entire field. # For example, filter=name ne example-instance. + # Compute Engine Beta API Only: If you use filtering in the Beta API, you can + # also filter on nested fields. For example, you could filter on instances that + # have set the scheduling.automaticRestart field to true. In particular, use + # filtering on nested fields to take advantage of instance labels to organize + # and filter results based on label values. + # The Beta API also supports filtering on multiple expressions by providing each + # separate expression within parentheses. For example, (scheduling. + # automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are + # treated as AND expressions meaning that resources must match all expressions + # to pass the filters. # @param [Fixnum] max_results - # Maximum count of results to be returned. + # The maximum number of results per page that Compute Engine should return. If + # the number of available results is larger than maxResults, Compute Engine + # returns a nextPageToken that can be used to get the next page of results in + # subsequent list requests. # @param [String] page_token - # Specifies a page token to use. Use this parameter if you want to list the next - # page of results. Set pageToken to the nextPageToken returned by a previous - # list request. + # Specifies a page token to use. Set pageToken to the nextPageToken returned by + # a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -5317,22 +5653,34 @@ module Google # The name of the zone for this request. # @param [String] filter # Sets a filter expression for filtering listed resources, in the form filter=` - # expression`. Your `expression` must be in the format: FIELD_NAME - # COMPARISON_STRING LITERAL_STRING. - # The FIELD_NAME is the name of the field you want to compare. Only atomic field - # types are supported (string, number, boolean). The COMPARISON_STRING must be - # either eq (equals) or ne (not equals). The LITERAL_STRING is the string value - # to filter to. The literal value must be valid for the type of field (string, - # number, boolean). For string fields, the literal value is interpreted as a - # regular expression using RE2 syntax. The literal value must match the entire - # field. + # expression`. Your `expression` must be in the format: field_name + # comparison_string literal_string. + # The field_name is the name of the field you want to compare. Only atomic field + # types are supported (string, number, boolean). The comparison_string must be + # either eq (equals) or ne (not equals). The literal_string is the string value + # to filter to. The literal value must be valid for the type of field you are + # filtering by (string, number, boolean). For string fields, the literal value + # is interpreted as a regular expression using RE2 syntax. The literal value + # must match the entire field. # For example, filter=name ne example-instance. + # Compute Engine Beta API Only: If you use filtering in the Beta API, you can + # also filter on nested fields. For example, you could filter on instances that + # have set the scheduling.automaticRestart field to true. In particular, use + # filtering on nested fields to take advantage of instance labels to organize + # and filter results based on label values. + # The Beta API also supports filtering on multiple expressions by providing each + # separate expression within parentheses. For example, (scheduling. + # automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are + # treated as AND expressions meaning that resources must match all expressions + # to pass the filters. # @param [Fixnum] max_results - # Maximum count of results to be returned. + # The maximum number of results per page that Compute Engine should return. If + # the number of available results is larger than maxResults, Compute Engine + # returns a nextPageToken that can be used to get the next page of results in + # subsequent list requests. # @param [String] page_token - # Specifies a page token to use. Use this parameter if you want to list the next - # page of results. Set pageToken to the nextPageToken returned by a previous - # list request. + # Specifies a page token to use. Set pageToken to the nextPageToken returned by + # a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -5489,22 +5837,34 @@ module Google # Project ID for this request. # @param [String] filter # Sets a filter expression for filtering listed resources, in the form filter=` - # expression`. Your `expression` must be in the format: FIELD_NAME - # COMPARISON_STRING LITERAL_STRING. - # The FIELD_NAME is the name of the field you want to compare. Only atomic field - # types are supported (string, number, boolean). The COMPARISON_STRING must be - # either eq (equals) or ne (not equals). The LITERAL_STRING is the string value - # to filter to. The literal value must be valid for the type of field (string, - # number, boolean). For string fields, the literal value is interpreted as a - # regular expression using RE2 syntax. The literal value must match the entire - # field. + # expression`. Your `expression` must be in the format: field_name + # comparison_string literal_string. + # The field_name is the name of the field you want to compare. Only atomic field + # types are supported (string, number, boolean). The comparison_string must be + # either eq (equals) or ne (not equals). The literal_string is the string value + # to filter to. The literal value must be valid for the type of field you are + # filtering by (string, number, boolean). For string fields, the literal value + # is interpreted as a regular expression using RE2 syntax. The literal value + # must match the entire field. # For example, filter=name ne example-instance. + # Compute Engine Beta API Only: If you use filtering in the Beta API, you can + # also filter on nested fields. For example, you could filter on instances that + # have set the scheduling.automaticRestart field to true. In particular, use + # filtering on nested fields to take advantage of instance labels to organize + # and filter results based on label values. + # The Beta API also supports filtering on multiple expressions by providing each + # separate expression within parentheses. For example, (scheduling. + # automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are + # treated as AND expressions meaning that resources must match all expressions + # to pass the filters. # @param [Fixnum] max_results - # Maximum count of results to be returned. + # The maximum number of results per page that Compute Engine should return. If + # the number of available results is larger than maxResults, Compute Engine + # returns a nextPageToken that can be used to get the next page of results in + # subsequent list requests. # @param [String] page_token - # Specifies a page token to use. Use this parameter if you want to list the next - # page of results. Set pageToken to the nextPageToken returned by a previous - # list request. + # Specifies a page token to use. Set pageToken to the nextPageToken returned by + # a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -5818,22 +6178,34 @@ module Google # Name of the region scoping this request. # @param [String] filter # Sets a filter expression for filtering listed resources, in the form filter=` - # expression`. Your `expression` must be in the format: FIELD_NAME - # COMPARISON_STRING LITERAL_STRING. - # The FIELD_NAME is the name of the field you want to compare. Only atomic field - # types are supported (string, number, boolean). The COMPARISON_STRING must be - # either eq (equals) or ne (not equals). The LITERAL_STRING is the string value - # to filter to. The literal value must be valid for the type of field (string, - # number, boolean). For string fields, the literal value is interpreted as a - # regular expression using RE2 syntax. The literal value must match the entire - # field. + # expression`. Your `expression` must be in the format: field_name + # comparison_string literal_string. + # The field_name is the name of the field you want to compare. Only atomic field + # types are supported (string, number, boolean). The comparison_string must be + # either eq (equals) or ne (not equals). The literal_string is the string value + # to filter to. The literal value must be valid for the type of field you are + # filtering by (string, number, boolean). For string fields, the literal value + # is interpreted as a regular expression using RE2 syntax. The literal value + # must match the entire field. # For example, filter=name ne example-instance. + # Compute Engine Beta API Only: If you use filtering in the Beta API, you can + # also filter on nested fields. For example, you could filter on instances that + # have set the scheduling.automaticRestart field to true. In particular, use + # filtering on nested fields to take advantage of instance labels to organize + # and filter results based on label values. + # The Beta API also supports filtering on multiple expressions by providing each + # separate expression within parentheses. For example, (scheduling. + # automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are + # treated as AND expressions meaning that resources must match all expressions + # to pass the filters. # @param [Fixnum] max_results - # Maximum count of results to be returned. + # The maximum number of results per page that Compute Engine should return. If + # the number of available results is larger than maxResults, Compute Engine + # returns a nextPageToken that can be used to get the next page of results in + # subsequent list requests. # @param [String] page_token - # Specifies a page token to use. Use this parameter if you want to list the next - # page of results. Set pageToken to the nextPageToken returned by a previous - # list request. + # Specifies a page token to use. Set pageToken to the nextPageToken returned by + # a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -5913,22 +6285,34 @@ module Google # Project ID for this request. # @param [String] filter # Sets a filter expression for filtering listed resources, in the form filter=` - # expression`. Your `expression` must be in the format: FIELD_NAME - # COMPARISON_STRING LITERAL_STRING. - # The FIELD_NAME is the name of the field you want to compare. Only atomic field - # types are supported (string, number, boolean). The COMPARISON_STRING must be - # either eq (equals) or ne (not equals). The LITERAL_STRING is the string value - # to filter to. The literal value must be valid for the type of field (string, - # number, boolean). For string fields, the literal value is interpreted as a - # regular expression using RE2 syntax. The literal value must match the entire - # field. + # expression`. Your `expression` must be in the format: field_name + # comparison_string literal_string. + # The field_name is the name of the field you want to compare. Only atomic field + # types are supported (string, number, boolean). The comparison_string must be + # either eq (equals) or ne (not equals). The literal_string is the string value + # to filter to. The literal value must be valid for the type of field you are + # filtering by (string, number, boolean). For string fields, the literal value + # is interpreted as a regular expression using RE2 syntax. The literal value + # must match the entire field. # For example, filter=name ne example-instance. + # Compute Engine Beta API Only: If you use filtering in the Beta API, you can + # also filter on nested fields. For example, you could filter on instances that + # have set the scheduling.automaticRestart field to true. In particular, use + # filtering on nested fields to take advantage of instance labels to organize + # and filter results based on label values. + # The Beta API also supports filtering on multiple expressions by providing each + # separate expression within parentheses. For example, (scheduling. + # automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are + # treated as AND expressions meaning that resources must match all expressions + # to pass the filters. # @param [Fixnum] max_results - # Maximum count of results to be returned. + # The maximum number of results per page that Compute Engine should return. If + # the number of available results is larger than maxResults, Compute Engine + # returns a nextPageToken that can be used to get the next page of results in + # subsequent list requests. # @param [String] page_token - # Specifies a page token to use. Use this parameter if you want to list the next - # page of results. Set pageToken to the nextPageToken returned by a previous - # list request. + # Specifies a page token to use. Set pageToken to the nextPageToken returned by + # a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -5966,7 +6350,7 @@ module Google # Deletes the specified route resource. # @param [String] project - # Name of the project scoping this request. + # Project ID for this request. # @param [String] route # Name of the route resource to delete. # @param [String] fields @@ -6004,7 +6388,7 @@ module Google # Returns the specified route resource. # @param [String] project - # Name of the project scoping this request. + # Project ID for this request. # @param [String] route # Name of the route resource to return. # @param [String] fields @@ -6043,7 +6427,7 @@ module Google # Creates a route resource in the specified project using the data included in # the request. # @param [String] project - # Name of the project scoping this request. + # Project ID for this request. # @param [Google::Apis::ComputeV1::Route] route_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -6081,25 +6465,37 @@ module Google # Retrieves the list of route resources available to the specified project. # @param [String] project - # Name of the project scoping this request. + # Project ID for this request. # @param [String] filter # Sets a filter expression for filtering listed resources, in the form filter=` - # expression`. Your `expression` must be in the format: FIELD_NAME - # COMPARISON_STRING LITERAL_STRING. - # The FIELD_NAME is the name of the field you want to compare. Only atomic field - # types are supported (string, number, boolean). The COMPARISON_STRING must be - # either eq (equals) or ne (not equals). The LITERAL_STRING is the string value - # to filter to. The literal value must be valid for the type of field (string, - # number, boolean). For string fields, the literal value is interpreted as a - # regular expression using RE2 syntax. The literal value must match the entire - # field. + # expression`. Your `expression` must be in the format: field_name + # comparison_string literal_string. + # The field_name is the name of the field you want to compare. Only atomic field + # types are supported (string, number, boolean). The comparison_string must be + # either eq (equals) or ne (not equals). The literal_string is the string value + # to filter to. The literal value must be valid for the type of field you are + # filtering by (string, number, boolean). For string fields, the literal value + # is interpreted as a regular expression using RE2 syntax. The literal value + # must match the entire field. # For example, filter=name ne example-instance. + # Compute Engine Beta API Only: If you use filtering in the Beta API, you can + # also filter on nested fields. For example, you could filter on instances that + # have set the scheduling.automaticRestart field to true. In particular, use + # filtering on nested fields to take advantage of instance labels to organize + # and filter results based on label values. + # The Beta API also supports filtering on multiple expressions by providing each + # separate expression within parentheses. For example, (scheduling. + # automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are + # treated as AND expressions meaning that resources must match all expressions + # to pass the filters. # @param [Fixnum] max_results - # Maximum count of results to be returned. + # The maximum number of results per page that Compute Engine should return. If + # the number of available results is larger than maxResults, Compute Engine + # returns a nextPageToken that can be used to get the next page of results in + # subsequent list requests. # @param [String] page_token - # Specifies a page token to use. Use this parameter if you want to list the next - # page of results. Set pageToken to the nextPageToken returned by a previous - # list request. + # Specifies a page token to use. Set pageToken to the nextPageToken returned by + # a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -6141,7 +6537,7 @@ module Google # snapshots, the data will be moved to the next corresponding snapshot. # For more information, see Deleting snaphots. # @param [String] project - # Name of the project scoping this request. + # Project ID for this request. # @param [String] snapshot # Name of the Snapshot resource to delete. # @param [String] fields @@ -6179,7 +6575,7 @@ module Google # Returns the specified Snapshot resource. # @param [String] project - # Name of the project scoping this request. + # Project ID for this request. # @param [String] snapshot # Name of the Snapshot resource to return. # @param [String] fields @@ -6218,25 +6614,37 @@ module Google # Retrieves the list of Snapshot resources contained within the specified # project. # @param [String] project - # Name of the project scoping this request. + # Project ID for this request. # @param [String] filter # Sets a filter expression for filtering listed resources, in the form filter=` - # expression`. Your `expression` must be in the format: FIELD_NAME - # COMPARISON_STRING LITERAL_STRING. - # The FIELD_NAME is the name of the field you want to compare. Only atomic field - # types are supported (string, number, boolean). The COMPARISON_STRING must be - # either eq (equals) or ne (not equals). The LITERAL_STRING is the string value - # to filter to. The literal value must be valid for the type of field (string, - # number, boolean). For string fields, the literal value is interpreted as a - # regular expression using RE2 syntax. The literal value must match the entire - # field. + # expression`. Your `expression` must be in the format: field_name + # comparison_string literal_string. + # The field_name is the name of the field you want to compare. Only atomic field + # types are supported (string, number, boolean). The comparison_string must be + # either eq (equals) or ne (not equals). The literal_string is the string value + # to filter to. The literal value must be valid for the type of field you are + # filtering by (string, number, boolean). For string fields, the literal value + # is interpreted as a regular expression using RE2 syntax. The literal value + # must match the entire field. # For example, filter=name ne example-instance. + # Compute Engine Beta API Only: If you use filtering in the Beta API, you can + # also filter on nested fields. For example, you could filter on instances that + # have set the scheduling.automaticRestart field to true. In particular, use + # filtering on nested fields to take advantage of instance labels to organize + # and filter results based on label values. + # The Beta API also supports filtering on multiple expressions by providing each + # separate expression within parentheses. For example, (scheduling. + # automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are + # treated as AND expressions meaning that resources must match all expressions + # to pass the filters. # @param [Fixnum] max_results - # Maximum count of results to be returned. + # The maximum number of results per page that Compute Engine should return. If + # the number of available results is larger than maxResults, Compute Engine + # returns a nextPageToken that can be used to get the next page of results in + # subsequent list requests. # @param [String] page_token - # Specifies a page token to use. Use this parameter if you want to list the next - # page of results. Set pageToken to the nextPageToken returned by a previous - # list request. + # Specifies a page token to use. Set pageToken to the nextPageToken returned by + # a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -6274,7 +6682,7 @@ module Google # Deletes the specified SslCertificate resource. # @param [String] project - # Name of the project scoping this request. + # Project ID for this request. # @param [String] ssl_certificate # Name of the SslCertificate resource to delete. # @param [String] fields @@ -6312,7 +6720,7 @@ module Google # Returns the specified SslCertificate resource. # @param [String] project - # Name of the project scoping this request. + # Project ID for this request. # @param [String] ssl_certificate # Name of the SslCertificate resource to return. # @param [String] fields @@ -6351,7 +6759,7 @@ module Google # Creates a SslCertificate resource in the specified project using the data # included in the request. # @param [String] project - # Name of the project scoping this request. + # Project ID for this request. # @param [Google::Apis::ComputeV1::SslCertificate] ssl_certificate_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -6390,25 +6798,37 @@ module Google # Retrieves the list of SslCertificate resources available to the specified # project. # @param [String] project - # Name of the project scoping this request. + # Project ID for this request. # @param [String] filter # Sets a filter expression for filtering listed resources, in the form filter=` - # expression`. Your `expression` must be in the format: FIELD_NAME - # COMPARISON_STRING LITERAL_STRING. - # The FIELD_NAME is the name of the field you want to compare. Only atomic field - # types are supported (string, number, boolean). The COMPARISON_STRING must be - # either eq (equals) or ne (not equals). The LITERAL_STRING is the string value - # to filter to. The literal value must be valid for the type of field (string, - # number, boolean). For string fields, the literal value is interpreted as a - # regular expression using RE2 syntax. The literal value must match the entire - # field. + # expression`. Your `expression` must be in the format: field_name + # comparison_string literal_string. + # The field_name is the name of the field you want to compare. Only atomic field + # types are supported (string, number, boolean). The comparison_string must be + # either eq (equals) or ne (not equals). The literal_string is the string value + # to filter to. The literal value must be valid for the type of field you are + # filtering by (string, number, boolean). For string fields, the literal value + # is interpreted as a regular expression using RE2 syntax. The literal value + # must match the entire field. # For example, filter=name ne example-instance. + # Compute Engine Beta API Only: If you use filtering in the Beta API, you can + # also filter on nested fields. For example, you could filter on instances that + # have set the scheduling.automaticRestart field to true. In particular, use + # filtering on nested fields to take advantage of instance labels to organize + # and filter results based on label values. + # The Beta API also supports filtering on multiple expressions by providing each + # separate expression within parentheses. For example, (scheduling. + # automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are + # treated as AND expressions meaning that resources must match all expressions + # to pass the filters. # @param [Fixnum] max_results - # Maximum count of results to be returned. + # The maximum number of results per page that Compute Engine should return. If + # the number of available results is larger than maxResults, Compute Engine + # returns a nextPageToken that can be used to get the next page of results in + # subsequent list requests. # @param [String] page_token - # Specifies a page token to use. Use this parameter if you want to list the next - # page of results. Set pageToken to the nextPageToken returned by a previous - # list request. + # Specifies a page token to use. Set pageToken to the nextPageToken returned by + # a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -6446,7 +6866,7 @@ module Google # Deletes the specified TargetHttpProxy resource. # @param [String] project - # Name of the project scoping this request. + # Project ID for this request. # @param [String] target_http_proxy # Name of the TargetHttpProxy resource to delete. # @param [String] fields @@ -6484,7 +6904,7 @@ module Google # Returns the specified TargetHttpProxy resource. # @param [String] project - # Name of the project scoping this request. + # Project ID for this request. # @param [String] target_http_proxy # Name of the TargetHttpProxy resource to return. # @param [String] fields @@ -6523,7 +6943,7 @@ module Google # Creates a TargetHttpProxy resource in the specified project using the data # included in the request. # @param [String] project - # Name of the project scoping this request. + # Project ID for this request. # @param [Google::Apis::ComputeV1::TargetHttpProxy] target_http_proxy_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -6562,25 +6982,37 @@ module Google # Retrieves the list of TargetHttpProxy resources available to the specified # project. # @param [String] project - # Name of the project scoping this request. + # Project ID for this request. # @param [String] filter # Sets a filter expression for filtering listed resources, in the form filter=` - # expression`. Your `expression` must be in the format: FIELD_NAME - # COMPARISON_STRING LITERAL_STRING. - # The FIELD_NAME is the name of the field you want to compare. Only atomic field - # types are supported (string, number, boolean). The COMPARISON_STRING must be - # either eq (equals) or ne (not equals). The LITERAL_STRING is the string value - # to filter to. The literal value must be valid for the type of field (string, - # number, boolean). For string fields, the literal value is interpreted as a - # regular expression using RE2 syntax. The literal value must match the entire - # field. + # expression`. Your `expression` must be in the format: field_name + # comparison_string literal_string. + # The field_name is the name of the field you want to compare. Only atomic field + # types are supported (string, number, boolean). The comparison_string must be + # either eq (equals) or ne (not equals). The literal_string is the string value + # to filter to. The literal value must be valid for the type of field you are + # filtering by (string, number, boolean). For string fields, the literal value + # is interpreted as a regular expression using RE2 syntax. The literal value + # must match the entire field. # For example, filter=name ne example-instance. + # Compute Engine Beta API Only: If you use filtering in the Beta API, you can + # also filter on nested fields. For example, you could filter on instances that + # have set the scheduling.automaticRestart field to true. In particular, use + # filtering on nested fields to take advantage of instance labels to organize + # and filter results based on label values. + # The Beta API also supports filtering on multiple expressions by providing each + # separate expression within parentheses. For example, (scheduling. + # automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are + # treated as AND expressions meaning that resources must match all expressions + # to pass the filters. # @param [Fixnum] max_results - # Maximum count of results to be returned. + # The maximum number of results per page that Compute Engine should return. If + # the number of available results is larger than maxResults, Compute Engine + # returns a nextPageToken that can be used to get the next page of results in + # subsequent list requests. # @param [String] page_token - # Specifies a page token to use. Use this parameter if you want to list the next - # page of results. Set pageToken to the nextPageToken returned by a previous - # list request. + # Specifies a page token to use. Set pageToken to the nextPageToken returned by + # a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -6618,7 +7050,7 @@ module Google # Changes the URL map for TargetHttpProxy. # @param [String] project - # Name of the project scoping this request. + # Project ID for this request. # @param [String] target_http_proxy # Name of the TargetHttpProxy resource whose URL map is to be set. # @param [Google::Apis::ComputeV1::UrlMapReference] url_map_reference_object @@ -6659,7 +7091,7 @@ module Google # Deletes the specified TargetHttpsProxy resource. # @param [String] project - # Name of the project scoping this request. + # Project ID for this request. # @param [String] target_https_proxy # Name of the TargetHttpsProxy resource to delete. # @param [String] fields @@ -6697,7 +7129,7 @@ module Google # Returns the specified TargetHttpsProxy resource. # @param [String] project - # Name of the project scoping this request. + # Project ID for this request. # @param [String] target_https_proxy # Name of the TargetHttpsProxy resource to return. # @param [String] fields @@ -6736,7 +7168,7 @@ module Google # Creates a TargetHttpsProxy resource in the specified project using the data # included in the request. # @param [String] project - # Name of the project scoping this request. + # Project ID for this request. # @param [Google::Apis::ComputeV1::TargetHttpsProxy] target_https_proxy_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -6775,25 +7207,37 @@ module Google # Retrieves the list of TargetHttpsProxy resources available to the specified # project. # @param [String] project - # Name of the project scoping this request. + # Project ID for this request. # @param [String] filter # Sets a filter expression for filtering listed resources, in the form filter=` - # expression`. Your `expression` must be in the format: FIELD_NAME - # COMPARISON_STRING LITERAL_STRING. - # The FIELD_NAME is the name of the field you want to compare. Only atomic field - # types are supported (string, number, boolean). The COMPARISON_STRING must be - # either eq (equals) or ne (not equals). The LITERAL_STRING is the string value - # to filter to. The literal value must be valid for the type of field (string, - # number, boolean). For string fields, the literal value is interpreted as a - # regular expression using RE2 syntax. The literal value must match the entire - # field. + # expression`. Your `expression` must be in the format: field_name + # comparison_string literal_string. + # The field_name is the name of the field you want to compare. Only atomic field + # types are supported (string, number, boolean). The comparison_string must be + # either eq (equals) or ne (not equals). The literal_string is the string value + # to filter to. The literal value must be valid for the type of field you are + # filtering by (string, number, boolean). For string fields, the literal value + # is interpreted as a regular expression using RE2 syntax. The literal value + # must match the entire field. # For example, filter=name ne example-instance. + # Compute Engine Beta API Only: If you use filtering in the Beta API, you can + # also filter on nested fields. For example, you could filter on instances that + # have set the scheduling.automaticRestart field to true. In particular, use + # filtering on nested fields to take advantage of instance labels to organize + # and filter results based on label values. + # The Beta API also supports filtering on multiple expressions by providing each + # separate expression within parentheses. For example, (scheduling. + # automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are + # treated as AND expressions meaning that resources must match all expressions + # to pass the filters. # @param [Fixnum] max_results - # Maximum count of results to be returned. + # The maximum number of results per page that Compute Engine should return. If + # the number of available results is larger than maxResults, Compute Engine + # returns a nextPageToken that can be used to get the next page of results in + # subsequent list requests. # @param [String] page_token - # Specifies a page token to use. Use this parameter if you want to list the next - # page of results. Set pageToken to the nextPageToken returned by a previous - # list request. + # Specifies a page token to use. Set pageToken to the nextPageToken returned by + # a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -6831,7 +7275,7 @@ module Google # Replaces SslCertificates for TargetHttpsProxy. # @param [String] project - # Name of the project scoping this request. + # Project ID for this request. # @param [String] target_https_proxy # Name of the TargetHttpsProxy resource whose SSLCertificate is to be set. # @param [Google::Apis::ComputeV1::TargetHttpsProxiesSetSslCertificatesRequest] target_https_proxies_set_ssl_certificates_request_object @@ -6872,7 +7316,7 @@ module Google # Changes the URL map for TargetHttpsProxy. # @param [String] project - # Name of the project scoping this request. + # Project ID for this request. # @param [String] target_https_proxy # Name of the TargetHttpsProxy resource whose URL map is to be set. # @param [Google::Apis::ComputeV1::UrlMapReference] url_map_reference_object @@ -6913,25 +7357,37 @@ module Google # Retrieves the list of target instances grouped by scope. # @param [String] project - # Name of the project scoping this request. + # Project ID for this request. # @param [String] filter # Sets a filter expression for filtering listed resources, in the form filter=` - # expression`. Your `expression` must be in the format: FIELD_NAME - # COMPARISON_STRING LITERAL_STRING. - # The FIELD_NAME is the name of the field you want to compare. Only atomic field - # types are supported (string, number, boolean). The COMPARISON_STRING must be - # either eq (equals) or ne (not equals). The LITERAL_STRING is the string value - # to filter to. The literal value must be valid for the type of field (string, - # number, boolean). For string fields, the literal value is interpreted as a - # regular expression using RE2 syntax. The literal value must match the entire - # field. + # expression`. Your `expression` must be in the format: field_name + # comparison_string literal_string. + # The field_name is the name of the field you want to compare. Only atomic field + # types are supported (string, number, boolean). The comparison_string must be + # either eq (equals) or ne (not equals). The literal_string is the string value + # to filter to. The literal value must be valid for the type of field you are + # filtering by (string, number, boolean). For string fields, the literal value + # is interpreted as a regular expression using RE2 syntax. The literal value + # must match the entire field. # For example, filter=name ne example-instance. + # Compute Engine Beta API Only: If you use filtering in the Beta API, you can + # also filter on nested fields. For example, you could filter on instances that + # have set the scheduling.automaticRestart field to true. In particular, use + # filtering on nested fields to take advantage of instance labels to organize + # and filter results based on label values. + # The Beta API also supports filtering on multiple expressions by providing each + # separate expression within parentheses. For example, (scheduling. + # automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are + # treated as AND expressions meaning that resources must match all expressions + # to pass the filters. # @param [Fixnum] max_results - # Maximum count of results to be returned. + # The maximum number of results per page that Compute Engine should return. If + # the number of available results is larger than maxResults, Compute Engine + # returns a nextPageToken that can be used to get the next page of results in + # subsequent list requests. # @param [String] page_token - # Specifies a page token to use. Use this parameter if you want to list the next - # page of results. Set pageToken to the nextPageToken returned by a previous - # list request. + # Specifies a page token to use. Set pageToken to the nextPageToken returned by + # a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -6969,7 +7425,7 @@ module Google # Deletes the specified TargetInstance resource. # @param [String] project - # Name of the project scoping this request. + # Project ID for this request. # @param [String] zone # Name of the zone scoping this request. # @param [String] target_instance @@ -7010,7 +7466,7 @@ module Google # Returns the specified TargetInstance resource. # @param [String] project - # Name of the project scoping this request. + # Project ID for this request. # @param [String] zone # Name of the zone scoping this request. # @param [String] target_instance @@ -7052,7 +7508,7 @@ module Google # Creates a TargetInstance resource in the specified project and zone using the # data included in the request. # @param [String] project - # Name of the project scoping this request. + # Project ID for this request. # @param [String] zone # Name of the zone scoping this request. # @param [Google::Apis::ComputeV1::TargetInstance] target_instance_object @@ -7094,27 +7550,39 @@ module Google # Retrieves the list of TargetInstance resources available to the specified # project and zone. # @param [String] project - # Name of the project scoping this request. + # Project ID for this request. # @param [String] zone # Name of the zone scoping this request. # @param [String] filter # Sets a filter expression for filtering listed resources, in the form filter=` - # expression`. Your `expression` must be in the format: FIELD_NAME - # COMPARISON_STRING LITERAL_STRING. - # The FIELD_NAME is the name of the field you want to compare. Only atomic field - # types are supported (string, number, boolean). The COMPARISON_STRING must be - # either eq (equals) or ne (not equals). The LITERAL_STRING is the string value - # to filter to. The literal value must be valid for the type of field (string, - # number, boolean). For string fields, the literal value is interpreted as a - # regular expression using RE2 syntax. The literal value must match the entire - # field. + # expression`. Your `expression` must be in the format: field_name + # comparison_string literal_string. + # The field_name is the name of the field you want to compare. Only atomic field + # types are supported (string, number, boolean). The comparison_string must be + # either eq (equals) or ne (not equals). The literal_string is the string value + # to filter to. The literal value must be valid for the type of field you are + # filtering by (string, number, boolean). For string fields, the literal value + # is interpreted as a regular expression using RE2 syntax. The literal value + # must match the entire field. # For example, filter=name ne example-instance. + # Compute Engine Beta API Only: If you use filtering in the Beta API, you can + # also filter on nested fields. For example, you could filter on instances that + # have set the scheduling.automaticRestart field to true. In particular, use + # filtering on nested fields to take advantage of instance labels to organize + # and filter results based on label values. + # The Beta API also supports filtering on multiple expressions by providing each + # separate expression within parentheses. For example, (scheduling. + # automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are + # treated as AND expressions meaning that resources must match all expressions + # to pass the filters. # @param [Fixnum] max_results - # Maximum count of results to be returned. + # The maximum number of results per page that Compute Engine should return. If + # the number of available results is larger than maxResults, Compute Engine + # returns a nextPageToken that can be used to get the next page of results in + # subsequent list requests. # @param [String] page_token - # Specifies a page token to use. Use this parameter if you want to list the next - # page of results. Set pageToken to the nextPageToken returned by a previous - # list request. + # Specifies a page token to use. Set pageToken to the nextPageToken returned by + # a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -7194,7 +7662,7 @@ module Google execute_or_queue_command(command, &block) end - # Adds instance url to targetPool. + # Adds instance URL to targetPool. # @param [String] project # @param [String] region # Name of the region scoping this request. @@ -7239,25 +7707,37 @@ module Google # Retrieves the list of target pools grouped by scope. # @param [String] project - # Name of the project scoping this request. + # Project ID for this request. # @param [String] filter # Sets a filter expression for filtering listed resources, in the form filter=` - # expression`. Your `expression` must be in the format: FIELD_NAME - # COMPARISON_STRING LITERAL_STRING. - # The FIELD_NAME is the name of the field you want to compare. Only atomic field - # types are supported (string, number, boolean). The COMPARISON_STRING must be - # either eq (equals) or ne (not equals). The LITERAL_STRING is the string value - # to filter to. The literal value must be valid for the type of field (string, - # number, boolean). For string fields, the literal value is interpreted as a - # regular expression using RE2 syntax. The literal value must match the entire - # field. + # expression`. Your `expression` must be in the format: field_name + # comparison_string literal_string. + # The field_name is the name of the field you want to compare. Only atomic field + # types are supported (string, number, boolean). The comparison_string must be + # either eq (equals) or ne (not equals). The literal_string is the string value + # to filter to. The literal value must be valid for the type of field you are + # filtering by (string, number, boolean). For string fields, the literal value + # is interpreted as a regular expression using RE2 syntax. The literal value + # must match the entire field. # For example, filter=name ne example-instance. + # Compute Engine Beta API Only: If you use filtering in the Beta API, you can + # also filter on nested fields. For example, you could filter on instances that + # have set the scheduling.automaticRestart field to true. In particular, use + # filtering on nested fields to take advantage of instance labels to organize + # and filter results based on label values. + # The Beta API also supports filtering on multiple expressions by providing each + # separate expression within parentheses. For example, (scheduling. + # automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are + # treated as AND expressions meaning that resources must match all expressions + # to pass the filters. # @param [Fixnum] max_results - # Maximum count of results to be returned. + # The maximum number of results per page that Compute Engine should return. If + # the number of available results is larger than maxResults, Compute Engine + # returns a nextPageToken that can be used to get the next page of results in + # subsequent list requests. # @param [String] page_token - # Specifies a page token to use. Use this parameter if you want to list the next - # page of results. Set pageToken to the nextPageToken returned by a previous - # list request. + # Specifies a page token to use. Set pageToken to the nextPageToken returned by + # a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -7295,7 +7775,7 @@ module Google # Deletes the specified TargetPool resource. # @param [String] project - # Name of the project scoping this request. + # Project ID for this request. # @param [String] region # Name of the region scoping this request. # @param [String] target_pool @@ -7336,7 +7816,7 @@ module Google # Returns the specified TargetPool resource. # @param [String] project - # Name of the project scoping this request. + # Project ID for this request. # @param [String] region # Name of the region scoping this request. # @param [String] target_pool @@ -7422,7 +7902,7 @@ module Google # Creates a TargetPool resource in the specified project and region using the # data included in the request. # @param [String] project - # Name of the project scoping this request. + # Project ID for this request. # @param [String] region # Name of the region scoping this request. # @param [Google::Apis::ComputeV1::TargetPool] target_pool_object @@ -7464,27 +7944,39 @@ module Google # Retrieves the list of TargetPool resources available to the specified project # and region. # @param [String] project - # Name of the project scoping this request. + # Project ID for this request. # @param [String] region # Name of the region scoping this request. # @param [String] filter # Sets a filter expression for filtering listed resources, in the form filter=` - # expression`. Your `expression` must be in the format: FIELD_NAME - # COMPARISON_STRING LITERAL_STRING. - # The FIELD_NAME is the name of the field you want to compare. Only atomic field - # types are supported (string, number, boolean). The COMPARISON_STRING must be - # either eq (equals) or ne (not equals). The LITERAL_STRING is the string value - # to filter to. The literal value must be valid for the type of field (string, - # number, boolean). For string fields, the literal value is interpreted as a - # regular expression using RE2 syntax. The literal value must match the entire - # field. + # expression`. Your `expression` must be in the format: field_name + # comparison_string literal_string. + # The field_name is the name of the field you want to compare. Only atomic field + # types are supported (string, number, boolean). The comparison_string must be + # either eq (equals) or ne (not equals). The literal_string is the string value + # to filter to. The literal value must be valid for the type of field you are + # filtering by (string, number, boolean). For string fields, the literal value + # is interpreted as a regular expression using RE2 syntax. The literal value + # must match the entire field. # For example, filter=name ne example-instance. + # Compute Engine Beta API Only: If you use filtering in the Beta API, you can + # also filter on nested fields. For example, you could filter on instances that + # have set the scheduling.automaticRestart field to true. In particular, use + # filtering on nested fields to take advantage of instance labels to organize + # and filter results based on label values. + # The Beta API also supports filtering on multiple expressions by providing each + # separate expression within parentheses. For example, (scheduling. + # automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are + # treated as AND expressions meaning that resources must match all expressions + # to pass the filters. # @param [Fixnum] max_results - # Maximum count of results to be returned. + # The maximum number of results per page that Compute Engine should return. If + # the number of available results is larger than maxResults, Compute Engine + # returns a nextPageToken that can be used to get the next page of results in + # subsequent list requests. # @param [String] page_token - # Specifies a page token to use. Use this parameter if you want to list the next - # page of results. Set pageToken to the nextPageToken returned by a previous - # list request. + # Specifies a page token to use. Set pageToken to the nextPageToken returned by + # a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -7609,7 +8101,7 @@ module Google # Changes backup pool configurations. # @param [String] project - # Name of the project scoping this request. + # Project ID for this request. # @param [String] region # Name of the region scoping this request. # @param [String] target_pool @@ -7659,22 +8151,34 @@ module Google # Project ID for this request. # @param [String] filter # Sets a filter expression for filtering listed resources, in the form filter=` - # expression`. Your `expression` must be in the format: FIELD_NAME - # COMPARISON_STRING LITERAL_STRING. - # The FIELD_NAME is the name of the field you want to compare. Only atomic field - # types are supported (string, number, boolean). The COMPARISON_STRING must be - # either eq (equals) or ne (not equals). The LITERAL_STRING is the string value - # to filter to. The literal value must be valid for the type of field (string, - # number, boolean). For string fields, the literal value is interpreted as a - # regular expression using RE2 syntax. The literal value must match the entire - # field. + # expression`. Your `expression` must be in the format: field_name + # comparison_string literal_string. + # The field_name is the name of the field you want to compare. Only atomic field + # types are supported (string, number, boolean). The comparison_string must be + # either eq (equals) or ne (not equals). The literal_string is the string value + # to filter to. The literal value must be valid for the type of field you are + # filtering by (string, number, boolean). For string fields, the literal value + # is interpreted as a regular expression using RE2 syntax. The literal value + # must match the entire field. # For example, filter=name ne example-instance. + # Compute Engine Beta API Only: If you use filtering in the Beta API, you can + # also filter on nested fields. For example, you could filter on instances that + # have set the scheduling.automaticRestart field to true. In particular, use + # filtering on nested fields to take advantage of instance labels to organize + # and filter results based on label values. + # The Beta API also supports filtering on multiple expressions by providing each + # separate expression within parentheses. For example, (scheduling. + # automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are + # treated as AND expressions meaning that resources must match all expressions + # to pass the filters. # @param [Fixnum] max_results - # Maximum count of results to be returned. + # The maximum number of results per page that Compute Engine should return. If + # the number of available results is larger than maxResults, Compute Engine + # returns a nextPageToken that can be used to get the next page of results in + # subsequent list requests. # @param [String] page_token - # Specifies a page token to use. Use this parameter if you want to list the next - # page of results. Set pageToken to the nextPageToken returned by a previous - # list request. + # Specifies a page token to use. Set pageToken to the nextPageToken returned by + # a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -7842,22 +8346,34 @@ module Google # The name of the region for this request. # @param [String] filter # Sets a filter expression for filtering listed resources, in the form filter=` - # expression`. Your `expression` must be in the format: FIELD_NAME - # COMPARISON_STRING LITERAL_STRING. - # The FIELD_NAME is the name of the field you want to compare. Only atomic field - # types are supported (string, number, boolean). The COMPARISON_STRING must be - # either eq (equals) or ne (not equals). The LITERAL_STRING is the string value - # to filter to. The literal value must be valid for the type of field (string, - # number, boolean). For string fields, the literal value is interpreted as a - # regular expression using RE2 syntax. The literal value must match the entire - # field. + # expression`. Your `expression` must be in the format: field_name + # comparison_string literal_string. + # The field_name is the name of the field you want to compare. Only atomic field + # types are supported (string, number, boolean). The comparison_string must be + # either eq (equals) or ne (not equals). The literal_string is the string value + # to filter to. The literal value must be valid for the type of field you are + # filtering by (string, number, boolean). For string fields, the literal value + # is interpreted as a regular expression using RE2 syntax. The literal value + # must match the entire field. # For example, filter=name ne example-instance. + # Compute Engine Beta API Only: If you use filtering in the Beta API, you can + # also filter on nested fields. For example, you could filter on instances that + # have set the scheduling.automaticRestart field to true. In particular, use + # filtering on nested fields to take advantage of instance labels to organize + # and filter results based on label values. + # The Beta API also supports filtering on multiple expressions by providing each + # separate expression within parentheses. For example, (scheduling. + # automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are + # treated as AND expressions meaning that resources must match all expressions + # to pass the filters. # @param [Fixnum] max_results - # Maximum count of results to be returned. + # The maximum number of results per page that Compute Engine should return. If + # the number of available results is larger than maxResults, Compute Engine + # returns a nextPageToken that can be used to get the next page of results in + # subsequent list requests. # @param [String] page_token - # Specifies a page token to use. Use this parameter if you want to list the next - # page of results. Set pageToken to the nextPageToken returned by a previous - # list request. + # Specifies a page token to use. Set pageToken to the nextPageToken returned by + # a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -7896,7 +8412,7 @@ module Google # Deletes the specified UrlMap resource. # @param [String] project - # Name of the project scoping this request. + # Project ID for this request. # @param [String] url_map # Name of the UrlMap resource to delete. # @param [String] fields @@ -7934,7 +8450,7 @@ module Google # Returns the specified UrlMap resource. # @param [String] project - # Name of the project scoping this request. + # Project ID for this request. # @param [String] url_map # Name of the UrlMap resource to return. # @param [String] fields @@ -7973,7 +8489,7 @@ module Google # Creates a UrlMap resource in the specified project using the data included in # the request. # @param [String] project - # Name of the project scoping this request. + # Project ID for this request. # @param [Google::Apis::ComputeV1::UrlMap] url_map_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -8011,25 +8527,37 @@ module Google # Retrieves the list of UrlMap resources available to the specified project. # @param [String] project - # Name of the project scoping this request. + # Project ID for this request. # @param [String] filter # Sets a filter expression for filtering listed resources, in the form filter=` - # expression`. Your `expression` must be in the format: FIELD_NAME - # COMPARISON_STRING LITERAL_STRING. - # The FIELD_NAME is the name of the field you want to compare. Only atomic field - # types are supported (string, number, boolean). The COMPARISON_STRING must be - # either eq (equals) or ne (not equals). The LITERAL_STRING is the string value - # to filter to. The literal value must be valid for the type of field (string, - # number, boolean). For string fields, the literal value is interpreted as a - # regular expression using RE2 syntax. The literal value must match the entire - # field. + # expression`. Your `expression` must be in the format: field_name + # comparison_string literal_string. + # The field_name is the name of the field you want to compare. Only atomic field + # types are supported (string, number, boolean). The comparison_string must be + # either eq (equals) or ne (not equals). The literal_string is the string value + # to filter to. The literal value must be valid for the type of field you are + # filtering by (string, number, boolean). For string fields, the literal value + # is interpreted as a regular expression using RE2 syntax. The literal value + # must match the entire field. # For example, filter=name ne example-instance. + # Compute Engine Beta API Only: If you use filtering in the Beta API, you can + # also filter on nested fields. For example, you could filter on instances that + # have set the scheduling.automaticRestart field to true. In particular, use + # filtering on nested fields to take advantage of instance labels to organize + # and filter results based on label values. + # The Beta API also supports filtering on multiple expressions by providing each + # separate expression within parentheses. For example, (scheduling. + # automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are + # treated as AND expressions meaning that resources must match all expressions + # to pass the filters. # @param [Fixnum] max_results - # Maximum count of results to be returned. + # The maximum number of results per page that Compute Engine should return. If + # the number of available results is larger than maxResults, Compute Engine + # returns a nextPageToken that can be used to get the next page of results in + # subsequent list requests. # @param [String] page_token - # Specifies a page token to use. Use this parameter if you want to list the next - # page of results. Set pageToken to the nextPageToken returned by a previous - # list request. + # Specifies a page token to use. Set pageToken to the nextPageToken returned by + # a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -8068,7 +8596,7 @@ module Google # Update the entire content of the UrlMap resource. This method supports patch # semantics. # @param [String] project - # Name of the project scoping this request. + # Project ID for this request. # @param [String] url_map # Name of the UrlMap resource to update. # @param [Google::Apis::ComputeV1::UrlMap] url_map_object @@ -8109,7 +8637,7 @@ module Google # Update the entire content of the UrlMap resource. # @param [String] project - # Name of the project scoping this request. + # Project ID for this request. # @param [String] url_map # Name of the UrlMap resource to update. # @param [Google::Apis::ComputeV1::UrlMap] url_map_object @@ -8151,7 +8679,7 @@ module Google # Run static validation for the UrlMap. In particular, the tests of the provided # UrlMap will be run. Calling this method does NOT create the UrlMap. # @param [String] project - # Name of the project scoping this request. + # Project ID for this request. # @param [String] url_map # Name of the UrlMap resource to be validated as. # @param [Google::Apis::ComputeV1::ValidateUrlMapsRequest] validate_url_maps_request_object @@ -8195,22 +8723,34 @@ module Google # Project ID for this request. # @param [String] filter # Sets a filter expression for filtering listed resources, in the form filter=` - # expression`. Your `expression` must be in the format: FIELD_NAME - # COMPARISON_STRING LITERAL_STRING. - # The FIELD_NAME is the name of the field you want to compare. Only atomic field - # types are supported (string, number, boolean). The COMPARISON_STRING must be - # either eq (equals) or ne (not equals). The LITERAL_STRING is the string value - # to filter to. The literal value must be valid for the type of field (string, - # number, boolean). For string fields, the literal value is interpreted as a - # regular expression using RE2 syntax. The literal value must match the entire - # field. + # expression`. Your `expression` must be in the format: field_name + # comparison_string literal_string. + # The field_name is the name of the field you want to compare. Only atomic field + # types are supported (string, number, boolean). The comparison_string must be + # either eq (equals) or ne (not equals). The literal_string is the string value + # to filter to. The literal value must be valid for the type of field you are + # filtering by (string, number, boolean). For string fields, the literal value + # is interpreted as a regular expression using RE2 syntax. The literal value + # must match the entire field. # For example, filter=name ne example-instance. + # Compute Engine Beta API Only: If you use filtering in the Beta API, you can + # also filter on nested fields. For example, you could filter on instances that + # have set the scheduling.automaticRestart field to true. In particular, use + # filtering on nested fields to take advantage of instance labels to organize + # and filter results based on label values. + # The Beta API also supports filtering on multiple expressions by providing each + # separate expression within parentheses. For example, (scheduling. + # automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are + # treated as AND expressions meaning that resources must match all expressions + # to pass the filters. # @param [Fixnum] max_results - # Maximum count of results to be returned. + # The maximum number of results per page that Compute Engine should return. If + # the number of available results is larger than maxResults, Compute Engine + # returns a nextPageToken that can be used to get the next page of results in + # subsequent list requests. # @param [String] page_token - # Specifies a page token to use. Use this parameter if you want to list the next - # page of results. Set pageToken to the nextPageToken returned by a previous - # list request. + # Specifies a page token to use. Set pageToken to the nextPageToken returned by + # a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -8378,22 +8918,34 @@ module Google # The name of the region for this request. # @param [String] filter # Sets a filter expression for filtering listed resources, in the form filter=` - # expression`. Your `expression` must be in the format: FIELD_NAME - # COMPARISON_STRING LITERAL_STRING. - # The FIELD_NAME is the name of the field you want to compare. Only atomic field - # types are supported (string, number, boolean). The COMPARISON_STRING must be - # either eq (equals) or ne (not equals). The LITERAL_STRING is the string value - # to filter to. The literal value must be valid for the type of field (string, - # number, boolean). For string fields, the literal value is interpreted as a - # regular expression using RE2 syntax. The literal value must match the entire - # field. + # expression`. Your `expression` must be in the format: field_name + # comparison_string literal_string. + # The field_name is the name of the field you want to compare. Only atomic field + # types are supported (string, number, boolean). The comparison_string must be + # either eq (equals) or ne (not equals). The literal_string is the string value + # to filter to. The literal value must be valid for the type of field you are + # filtering by (string, number, boolean). For string fields, the literal value + # is interpreted as a regular expression using RE2 syntax. The literal value + # must match the entire field. # For example, filter=name ne example-instance. + # Compute Engine Beta API Only: If you use filtering in the Beta API, you can + # also filter on nested fields. For example, you could filter on instances that + # have set the scheduling.automaticRestart field to true. In particular, use + # filtering on nested fields to take advantage of instance labels to organize + # and filter results based on label values. + # The Beta API also supports filtering on multiple expressions by providing each + # separate expression within parentheses. For example, (scheduling. + # automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are + # treated as AND expressions meaning that resources must match all expressions + # to pass the filters. # @param [Fixnum] max_results - # Maximum count of results to be returned. + # The maximum number of results per page that Compute Engine should return. If + # the number of available results is larger than maxResults, Compute Engine + # returns a nextPageToken that can be used to get the next page of results in + # subsequent list requests. # @param [String] page_token - # Specifies a page token to use. Use this parameter if you want to list the next - # page of results. Set pageToken to the nextPageToken returned by a previous - # list request. + # Specifies a page token to use. Set pageToken to the nextPageToken returned by + # a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -8517,22 +9069,34 @@ module Google # Name of the zone scoping this request. # @param [String] filter # Sets a filter expression for filtering listed resources, in the form filter=` - # expression`. Your `expression` must be in the format: FIELD_NAME - # COMPARISON_STRING LITERAL_STRING. - # The FIELD_NAME is the name of the field you want to compare. Only atomic field - # types are supported (string, number, boolean). The COMPARISON_STRING must be - # either eq (equals) or ne (not equals). The LITERAL_STRING is the string value - # to filter to. The literal value must be valid for the type of field (string, - # number, boolean). For string fields, the literal value is interpreted as a - # regular expression using RE2 syntax. The literal value must match the entire - # field. + # expression`. Your `expression` must be in the format: field_name + # comparison_string literal_string. + # The field_name is the name of the field you want to compare. Only atomic field + # types are supported (string, number, boolean). The comparison_string must be + # either eq (equals) or ne (not equals). The literal_string is the string value + # to filter to. The literal value must be valid for the type of field you are + # filtering by (string, number, boolean). For string fields, the literal value + # is interpreted as a regular expression using RE2 syntax. The literal value + # must match the entire field. # For example, filter=name ne example-instance. + # Compute Engine Beta API Only: If you use filtering in the Beta API, you can + # also filter on nested fields. For example, you could filter on instances that + # have set the scheduling.automaticRestart field to true. In particular, use + # filtering on nested fields to take advantage of instance labels to organize + # and filter results based on label values. + # The Beta API also supports filtering on multiple expressions by providing each + # separate expression within parentheses. For example, (scheduling. + # automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are + # treated as AND expressions meaning that resources must match all expressions + # to pass the filters. # @param [Fixnum] max_results - # Maximum count of results to be returned. + # The maximum number of results per page that Compute Engine should return. If + # the number of available results is larger than maxResults, Compute Engine + # returns a nextPageToken that can be used to get the next page of results in + # subsequent list requests. # @param [String] page_token - # Specifies a page token to use. Use this parameter if you want to list the next - # page of results. Set pageToken to the nextPageToken returned by a previous - # list request. + # Specifies a page token to use. Set pageToken to the nextPageToken returned by + # a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -8612,22 +9176,34 @@ module Google # Project ID for this request. # @param [String] filter # Sets a filter expression for filtering listed resources, in the form filter=` - # expression`. Your `expression` must be in the format: FIELD_NAME - # COMPARISON_STRING LITERAL_STRING. - # The FIELD_NAME is the name of the field you want to compare. Only atomic field - # types are supported (string, number, boolean). The COMPARISON_STRING must be - # either eq (equals) or ne (not equals). The LITERAL_STRING is the string value - # to filter to. The literal value must be valid for the type of field (string, - # number, boolean). For string fields, the literal value is interpreted as a - # regular expression using RE2 syntax. The literal value must match the entire - # field. + # expression`. Your `expression` must be in the format: field_name + # comparison_string literal_string. + # The field_name is the name of the field you want to compare. Only atomic field + # types are supported (string, number, boolean). The comparison_string must be + # either eq (equals) or ne (not equals). The literal_string is the string value + # to filter to. The literal value must be valid for the type of field you are + # filtering by (string, number, boolean). For string fields, the literal value + # is interpreted as a regular expression using RE2 syntax. The literal value + # must match the entire field. # For example, filter=name ne example-instance. + # Compute Engine Beta API Only: If you use filtering in the Beta API, you can + # also filter on nested fields. For example, you could filter on instances that + # have set the scheduling.automaticRestart field to true. In particular, use + # filtering on nested fields to take advantage of instance labels to organize + # and filter results based on label values. + # The Beta API also supports filtering on multiple expressions by providing each + # separate expression within parentheses. For example, (scheduling. + # automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are + # treated as AND expressions meaning that resources must match all expressions + # to pass the filters. # @param [Fixnum] max_results - # Maximum count of results to be returned. + # The maximum number of results per page that Compute Engine should return. If + # the number of available results is larger than maxResults, Compute Engine + # returns a nextPageToken that can be used to get the next page of results in + # subsequent list requests. # @param [String] page_token - # Specifies a page token to use. Use this parameter if you want to list the next - # page of results. Set pageToken to the nextPageToken returned by a previous - # list request. + # Specifies a page token to use. Set pageToken to the nextPageToken returned by + # a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user diff --git a/generated/google/apis/content_v2.rb b/generated/google/apis/content_v2.rb index 078cf9460..1749270cc 100644 --- a/generated/google/apis/content_v2.rb +++ b/generated/google/apis/content_v2.rb @@ -26,7 +26,7 @@ module Google # @see https://developers.google.com/shopping-content module ContentV2 VERSION = 'V2' - REVISION = '20151112' + REVISION = '20151211' # Manage your product listings and accounts for Google Shopping AUTH_CONTENT = 'https://www.googleapis.com/auth/content' diff --git a/generated/google/apis/content_v2/classes.rb b/generated/google/apis/content_v2/classes.rb index 1c8177ef8..f32b5d225 100644 --- a/generated/google/apis/content_v2/classes.rb +++ b/generated/google/apis/content_v2/classes.rb @@ -1509,7 +1509,8 @@ module Google # @return [String] attr_accessor :attribute_language - # The two-letter ISO 639-1 language of the items in the feed. + # The two-letter ISO 639-1 language of the items in the feed. Must be a valid + # language for targetCountry. # Corresponds to the JSON property `contentLanguage` # @return [String] attr_accessor :content_language @@ -3418,6 +3419,13 @@ module Google class OrdersCancelLineItemRequest include Google::Apis::Core::Hashable + # Amount to refund for the cancelation. Optional. If not set, Google will + # calculate the default based on the price and tax of the items involved. The + # amount must not be larger than the net amount left on the order. + # Corresponds to the JSON property `amount` + # @return [Google::Apis::ContentV2::Price] + attr_accessor :amount + # The ID of the line item to cancel. # Corresponds to the JSON property `lineItemId` # @return [String] @@ -3449,6 +3457,7 @@ module Google # Update properties of this object def update!(**args) + @amount = args[:amount] unless args[:amount].nil? @line_item_id = args[:line_item_id] unless args[:line_item_id].nil? @operation_id = args[:operation_id] unless args[:operation_id].nil? @quantity = args[:quantity] unless args[:quantity].nil? @@ -3728,6 +3737,13 @@ module Google class OrdersCustomBatchRequestEntryCancelLineItem include Google::Apis::Core::Hashable + # Amount to refund for the cancelation. Optional. If not set, Google will + # calculate the default based on the price and tax of the items involved. The + # amount must not be larger than the net amount left on the order. + # Corresponds to the JSON property `amount` + # @return [Google::Apis::ContentV2::Price] + attr_accessor :amount + # The ID of the line item to cancel. # Corresponds to the JSON property `lineItemId` # @return [String] @@ -3754,6 +3770,7 @@ module Google # Update properties of this object def update!(**args) + @amount = args[:amount] unless args[:amount].nil? @line_item_id = args[:line_item_id] unless args[:line_item_id].nil? @quantity = args[:quantity] unless args[:quantity].nil? @reason = args[:reason] unless args[:reason].nil? diff --git a/generated/google/apis/content_v2/representations.rb b/generated/google/apis/content_v2/representations.rb index 5b3f5544f..b116e6bf2 100644 --- a/generated/google/apis/content_v2/representations.rb +++ b/generated/google/apis/content_v2/representations.rb @@ -1578,6 +1578,8 @@ module Google class OrdersCancelLineItemRequest # @private class Representation < Google::Apis::Core::JsonRepresentation + property :amount, as: 'amount', class: Google::Apis::ContentV2::Price, decorator: Google::Apis::ContentV2::Price::Representation + property :line_item_id, as: 'lineItemId' property :operation_id, as: 'operationId' property :quantity, as: 'quantity' @@ -1671,6 +1673,8 @@ module Google class OrdersCustomBatchRequestEntryCancelLineItem # @private class Representation < Google::Apis::Core::JsonRepresentation + property :amount, as: 'amount', class: Google::Apis::ContentV2::Price, decorator: Google::Apis::ContentV2::Price::Representation + property :line_item_id, as: 'lineItemId' property :quantity, as: 'quantity' property :reason, as: 'reason' diff --git a/generated/google/apis/deploymentmanager_v2.rb b/generated/google/apis/deploymentmanager_v2.rb index b670e02f7..eb008e10a 100644 --- a/generated/google/apis/deploymentmanager_v2.rb +++ b/generated/google/apis/deploymentmanager_v2.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/deployment-manager/ module DeploymentmanagerV2 VERSION = 'V2' - REVISION = '20151110' + REVISION = '20151207' # 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/deploymentmanager_v2/classes.rb b/generated/google/apis/deploymentmanager_v2/classes.rb index 76fe51abf..f9dfae685 100644 --- a/generated/google/apis/deploymentmanager_v2/classes.rb +++ b/generated/google/apis/deploymentmanager_v2/classes.rb @@ -339,8 +339,7 @@ module Google class Operation include Google::Apis::Core::Hashable - # [Output Only] An optional identifier specified by the client when the mutation - # was initiated. Must be unique for all Operation resources in the project. + # [Output Only] A unique client ID generated by the server. # Corresponds to the JSON property `clientOperationId` # @return [String] attr_accessor :client_operation_id @@ -350,8 +349,14 @@ module Google # @return [String] attr_accessor :creation_timestamp - # [Output Only] The time that this operation was completed. This is in RFC3339 - # text format. + # [Output Only] A textual description of the operation, which is set when the + # operation is created. + # Corresponds to the JSON property `description` + # @return [String] + attr_accessor :description + + # [Output Only] The time that this operation was completed. This value is in + # RFC3339 text format. # Corresponds to the JSON property `endTime` # @return [String] attr_accessor :end_time @@ -369,18 +374,19 @@ module Google attr_accessor :http_error_message # [Output Only] If the operation fails, this field contains the HTTP error - # message that was returned, such as 404. + # message that was returned. For example, a 404 means the resource was not found. # Corresponds to the JSON property `httpErrorStatusCode` # @return [Fixnum] attr_accessor :http_error_status_code - # [Output Only] Unique identifier for the resource; defined by the server. + # [Output Only] The unique identifier for the resource. This identifier is + # defined by the server. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id - # [Output Only] The time that this operation was requested. This is in RFC3339 - # text format. + # [Output Only] The time that this operation was requested. This value is in + # RFC3339 text format. # Corresponds to the JSON property `insertTime` # @return [String] attr_accessor :insert_time @@ -396,8 +402,7 @@ module Google # @return [String] attr_accessor :name - # [Output Only] Type of the operation, such as insert, compute.instanceGroups. - # update, or compute.instanceGroups.delete. + # [Output Only] The type of operation, which can be insert, update, or delete. # Corresponds to the JSON property `operationType` # @return [String] attr_accessor :operation_type @@ -421,14 +426,14 @@ module Google # @return [String] attr_accessor :self_link - # [Output Only] The time that this operation was started by the server. This is - # in RFC3339 text format. + # [Output Only] The time that this operation was started by the server. This + # value is in RFC3339 text format. # Corresponds to the JSON property `startTime` # @return [String] attr_accessor :start_time - # [Output Only] Status of the operation. Can be one of the following: PENDING, - # RUNNING, or DONE. + # [Output Only] The status of the operation, which can be one of the following: + # PENDING, RUNNING, or DONE. # Corresponds to the JSON property `status` # @return [String] attr_accessor :status @@ -439,13 +444,13 @@ module Google # @return [String] attr_accessor :status_message - # [Output Only] Unique target ID which identifies a particular incarnation of - # the target. + # [Output Only] The unique target ID, which identifies a specific incarnation of + # the target resource. # Corresponds to the JSON property `targetId` # @return [String] attr_accessor :target_id - # [Output Only] URL of the resource the operation is mutating. + # [Output Only] The URL of the resource that the operation is modifying. # Corresponds to the JSON property `targetLink` # @return [String] attr_accessor :target_link @@ -474,6 +479,7 @@ module Google def update!(**args) @client_operation_id = args[:client_operation_id] unless args[:client_operation_id].nil? @creation_timestamp = args[:creation_timestamp] unless args[:creation_timestamp].nil? + @description = args[:description] unless args[:description].nil? @end_time = args[:end_time] unless args[:end_time].nil? @error = args[:error] unless args[:error].nil? @http_error_message = args[:http_error_message] unless args[:http_error_message].nil? @@ -552,17 +558,19 @@ module Google class Warning include Google::Apis::Core::Hashable - # [Output Only] The warning type identifier for this warning. + # [Output Only] A warning code, if applicable. For example, Compute Engine + # returns NO_RESULTS_ON_PAGE if there are no results in the response. # Corresponds to the JSON property `code` # @return [String] attr_accessor :code - # [Output Only] Metadata for this warning in key: value format. + # [Output Only] Metadata about this warning in key: value format. For example: + # "data": [ ` "key": "scope", "value": "zones/us-east1-d" ` # Corresponds to the JSON property `data` # @return [Array] attr_accessor :data - # [Output Only] Optional human-readable details for this warning. + # [Output Only] A human-readable description of the warning code. # Corresponds to the JSON property `message` # @return [String] attr_accessor :message @@ -582,7 +590,13 @@ module Google class Datum include Google::Apis::Core::Hashable - # [Output Only] A key for the warning data. + # [Output Only] A key that provides more detail on the warning being returned. + # For example, for warnings where there are no results in a list request for a + # particular zone, this key might be scope and the key value might be the zone + # name. Other examples might be a key indicating a deprecated resource, and a + # suggested replacement, or a warning about invalid network settings (for + # example, if an instance attempts to perform IP forwarding but is not enabled + # for IP forwarding). # Corresponds to the JSON property `key` # @return [String] attr_accessor :key @@ -719,17 +733,19 @@ module Google class Warning include Google::Apis::Core::Hashable - # [Output Only] The warning type identifier for this warning. + # [Output Only] A warning code, if applicable. For example, Compute Engine + # returns NO_RESULTS_ON_PAGE if there are no results in the response. # Corresponds to the JSON property `code` # @return [String] attr_accessor :code - # [Output Only] Metadata for this warning in key: value format. + # [Output Only] Metadata about this warning in key: value format. For example: + # "data": [ ` "key": "scope", "value": "zones/us-east1-d" ` # Corresponds to the JSON property `data` # @return [Array] attr_accessor :data - # [Output Only] Optional human-readable details for this warning. + # [Output Only] A human-readable description of the warning code. # Corresponds to the JSON property `message` # @return [String] attr_accessor :message @@ -749,7 +765,13 @@ module Google class Datum include Google::Apis::Core::Hashable - # [Output Only] A key for the warning data. + # [Output Only] A key that provides more detail on the warning being returned. + # For example, for warnings where there are no results in a list request for a + # particular zone, this key might be scope and the key value might be the zone + # name. Other examples might be a key indicating a deprecated resource, and a + # suggested replacement, or a warning about invalid network settings (for + # example, if an instance attempts to perform IP forwarding but is not enabled + # for IP forwarding). # Corresponds to the JSON property `key` # @return [String] attr_accessor :key @@ -887,17 +909,19 @@ module Google class Warning include Google::Apis::Core::Hashable - # [Output Only] The warning type identifier for this warning. + # [Output Only] A warning code, if applicable. For example, Compute Engine + # returns NO_RESULTS_ON_PAGE if there are no results in the response. # Corresponds to the JSON property `code` # @return [String] attr_accessor :code - # [Output Only] Metadata for this warning in key: value format. + # [Output Only] Metadata about this warning in key: value format. For example: + # "data": [ ` "key": "scope", "value": "zones/us-east1-d" ` # Corresponds to the JSON property `data` # @return [Array] attr_accessor :data - # [Output Only] Optional human-readable details for this warning. + # [Output Only] A human-readable description of the warning code. # Corresponds to the JSON property `message` # @return [String] attr_accessor :message @@ -917,7 +941,13 @@ module Google class Datum include Google::Apis::Core::Hashable - # [Output Only] A key for the warning data. + # [Output Only] A key that provides more detail on the warning being returned. + # For example, for warnings where there are no results in a list request for a + # particular zone, this key might be scope and the key value might be the zone + # name. Other examples might be a key indicating a deprecated resource, and a + # suggested replacement, or a warning about invalid network settings (for + # example, if an instance attempts to perform IP forwarding but is not enabled + # for IP forwarding). # Corresponds to the JSON property `key` # @return [String] attr_accessor :key diff --git a/generated/google/apis/deploymentmanager_v2/representations.rb b/generated/google/apis/deploymentmanager_v2/representations.rb index db0745881..68f1dd38e 100644 --- a/generated/google/apis/deploymentmanager_v2/representations.rb +++ b/generated/google/apis/deploymentmanager_v2/representations.rb @@ -223,6 +223,7 @@ module Google class Representation < Google::Apis::Core::JsonRepresentation property :client_operation_id, as: 'clientOperationId' property :creation_timestamp, as: 'creationTimestamp' + property :description, as: 'description' property :end_time, as: 'endTime' property :error, as: 'error', class: Google::Apis::DeploymentmanagerV2::Operation::Error, decorator: Google::Apis::DeploymentmanagerV2::Operation::Error::Representation diff --git a/generated/google/apis/deploymentmanager_v2/service.rb b/generated/google/apis/deploymentmanager_v2/service.rb index 1c73a5f5d..195feebe1 100644 --- a/generated/google/apis/deploymentmanager_v2/service.rb +++ b/generated/google/apis/deploymentmanager_v2/service.rb @@ -223,22 +223,34 @@ module Google # The project ID for this request. # @param [String] filter # Sets a filter expression for filtering listed resources, in the form filter=` - # expression`. Your `expression` must be in the format: FIELD_NAME - # COMPARISON_STRING LITERAL_STRING. - # The FIELD_NAME is the name of the field you want to compare. Only atomic field - # types are supported (string, number, boolean). The COMPARISON_STRING must be - # either eq (equals) or ne (not equals). The LITERAL_STRING is the string value - # to filter to. The literal value must be valid for the type of field (string, - # number, boolean). For string fields, the literal value is interpreted as a - # regular expression using RE2 syntax. The literal value must match the entire - # field. + # expression`. Your `expression` must be in the format: field_name + # comparison_string literal_string. + # The field_name is the name of the field you want to compare. Only atomic field + # types are supported (string, number, boolean). The comparison_string must be + # either eq (equals) or ne (not equals). The literal_string is the string value + # to filter to. The literal value must be valid for the type of field you are + # filtering by (string, number, boolean). For string fields, the literal value + # is interpreted as a regular expression using RE2 syntax. The literal value + # must match the entire field. # For example, filter=name ne example-instance. + # Compute Engine Beta API Only: If you use filtering in the Beta API, you can + # also filter on nested fields. For example, you could filter on instances that + # have set the scheduling.automaticRestart field to true. In particular, use + # filtering on nested fields to take advantage of instance labels to organize + # and filter results based on label values. + # The Beta API also supports filtering on multiple expressions by providing each + # separate expression within parentheses. For example, (scheduling. + # automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are + # treated as AND expressions meaning that resources must match all expressions + # to pass the filters. # @param [Fixnum] max_results - # Maximum count of results to be returned. + # The maximum number of results per page that Compute Engine should return. If + # the number of available results is larger than maxResults, Compute Engine + # returns a nextPageToken that can be used to get the next page of results in + # subsequent list requests. # @param [String] page_token - # Specifies a page token to use. Use this parameter if you want to list the next - # page of results. Set pageToken to the nextPageToken returned by a previous - # list request. + # Specifies a page token to use. Set pageToken to the nextPageToken returned by + # a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -482,22 +494,34 @@ module Google # The name of the deployment for this request. # @param [String] filter # Sets a filter expression for filtering listed resources, in the form filter=` - # expression`. Your `expression` must be in the format: FIELD_NAME - # COMPARISON_STRING LITERAL_STRING. - # The FIELD_NAME is the name of the field you want to compare. Only atomic field - # types are supported (string, number, boolean). The COMPARISON_STRING must be - # either eq (equals) or ne (not equals). The LITERAL_STRING is the string value - # to filter to. The literal value must be valid for the type of field (string, - # number, boolean). For string fields, the literal value is interpreted as a - # regular expression using RE2 syntax. The literal value must match the entire - # field. + # expression`. Your `expression` must be in the format: field_name + # comparison_string literal_string. + # The field_name is the name of the field you want to compare. Only atomic field + # types are supported (string, number, boolean). The comparison_string must be + # either eq (equals) or ne (not equals). The literal_string is the string value + # to filter to. The literal value must be valid for the type of field you are + # filtering by (string, number, boolean). For string fields, the literal value + # is interpreted as a regular expression using RE2 syntax. The literal value + # must match the entire field. # For example, filter=name ne example-instance. + # Compute Engine Beta API Only: If you use filtering in the Beta API, you can + # also filter on nested fields. For example, you could filter on instances that + # have set the scheduling.automaticRestart field to true. In particular, use + # filtering on nested fields to take advantage of instance labels to organize + # and filter results based on label values. + # The Beta API also supports filtering on multiple expressions by providing each + # separate expression within parentheses. For example, (scheduling. + # automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are + # treated as AND expressions meaning that resources must match all expressions + # to pass the filters. # @param [Fixnum] max_results - # Maximum count of results to be returned. + # The maximum number of results per page that Compute Engine should return. If + # the number of available results is larger than maxResults, Compute Engine + # returns a nextPageToken that can be used to get the next page of results in + # subsequent list requests. # @param [String] page_token - # Specifies a page token to use. Use this parameter if you want to list the next - # page of results. Set pageToken to the nextPageToken returned by a previous - # list request. + # Specifies a page token to use. Set pageToken to the nextPageToken returned by + # a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -577,22 +601,34 @@ module Google # The project ID for this request. # @param [String] filter # Sets a filter expression for filtering listed resources, in the form filter=` - # expression`. Your `expression` must be in the format: FIELD_NAME - # COMPARISON_STRING LITERAL_STRING. - # The FIELD_NAME is the name of the field you want to compare. Only atomic field - # types are supported (string, number, boolean). The COMPARISON_STRING must be - # either eq (equals) or ne (not equals). The LITERAL_STRING is the string value - # to filter to. The literal value must be valid for the type of field (string, - # number, boolean). For string fields, the literal value is interpreted as a - # regular expression using RE2 syntax. The literal value must match the entire - # field. + # expression`. Your `expression` must be in the format: field_name + # comparison_string literal_string. + # The field_name is the name of the field you want to compare. Only atomic field + # types are supported (string, number, boolean). The comparison_string must be + # either eq (equals) or ne (not equals). The literal_string is the string value + # to filter to. The literal value must be valid for the type of field you are + # filtering by (string, number, boolean). For string fields, the literal value + # is interpreted as a regular expression using RE2 syntax. The literal value + # must match the entire field. # For example, filter=name ne example-instance. + # Compute Engine Beta API Only: If you use filtering in the Beta API, you can + # also filter on nested fields. For example, you could filter on instances that + # have set the scheduling.automaticRestart field to true. In particular, use + # filtering on nested fields to take advantage of instance labels to organize + # and filter results based on label values. + # The Beta API also supports filtering on multiple expressions by providing each + # separate expression within parentheses. For example, (scheduling. + # automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are + # treated as AND expressions meaning that resources must match all expressions + # to pass the filters. # @param [Fixnum] max_results - # Maximum count of results to be returned. + # The maximum number of results per page that Compute Engine should return. If + # the number of available results is larger than maxResults, Compute Engine + # returns a nextPageToken that can be used to get the next page of results in + # subsequent list requests. # @param [String] page_token - # Specifies a page token to use. Use this parameter if you want to list the next - # page of results. Set pageToken to the nextPageToken returned by a previous - # list request. + # Specifies a page token to use. Set pageToken to the nextPageToken returned by + # a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -676,22 +712,34 @@ module Google # The name of the deployment for this request. # @param [String] filter # Sets a filter expression for filtering listed resources, in the form filter=` - # expression`. Your `expression` must be in the format: FIELD_NAME - # COMPARISON_STRING LITERAL_STRING. - # The FIELD_NAME is the name of the field you want to compare. Only atomic field - # types are supported (string, number, boolean). The COMPARISON_STRING must be - # either eq (equals) or ne (not equals). The LITERAL_STRING is the string value - # to filter to. The literal value must be valid for the type of field (string, - # number, boolean). For string fields, the literal value is interpreted as a - # regular expression using RE2 syntax. The literal value must match the entire - # field. + # expression`. Your `expression` must be in the format: field_name + # comparison_string literal_string. + # The field_name is the name of the field you want to compare. Only atomic field + # types are supported (string, number, boolean). The comparison_string must be + # either eq (equals) or ne (not equals). The literal_string is the string value + # to filter to. The literal value must be valid for the type of field you are + # filtering by (string, number, boolean). For string fields, the literal value + # is interpreted as a regular expression using RE2 syntax. The literal value + # must match the entire field. # For example, filter=name ne example-instance. + # Compute Engine Beta API Only: If you use filtering in the Beta API, you can + # also filter on nested fields. For example, you could filter on instances that + # have set the scheduling.automaticRestart field to true. In particular, use + # filtering on nested fields to take advantage of instance labels to organize + # and filter results based on label values. + # The Beta API also supports filtering on multiple expressions by providing each + # separate expression within parentheses. For example, (scheduling. + # automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are + # treated as AND expressions meaning that resources must match all expressions + # to pass the filters. # @param [Fixnum] max_results - # Maximum count of results to be returned. + # The maximum number of results per page that Compute Engine should return. If + # the number of available results is larger than maxResults, Compute Engine + # returns a nextPageToken that can be used to get the next page of results in + # subsequent list requests. # @param [String] page_token - # Specifies a page token to use. Use this parameter if you want to list the next - # page of results. Set pageToken to the nextPageToken returned by a previous - # list request. + # Specifies a page token to use. Set pageToken to the nextPageToken returned by + # a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -733,22 +781,34 @@ module Google # The project ID for this request. # @param [String] filter # Sets a filter expression for filtering listed resources, in the form filter=` - # expression`. Your `expression` must be in the format: FIELD_NAME - # COMPARISON_STRING LITERAL_STRING. - # The FIELD_NAME is the name of the field you want to compare. Only atomic field - # types are supported (string, number, boolean). The COMPARISON_STRING must be - # either eq (equals) or ne (not equals). The LITERAL_STRING is the string value - # to filter to. The literal value must be valid for the type of field (string, - # number, boolean). For string fields, the literal value is interpreted as a - # regular expression using RE2 syntax. The literal value must match the entire - # field. + # expression`. Your `expression` must be in the format: field_name + # comparison_string literal_string. + # The field_name is the name of the field you want to compare. Only atomic field + # types are supported (string, number, boolean). The comparison_string must be + # either eq (equals) or ne (not equals). The literal_string is the string value + # to filter to. The literal value must be valid for the type of field you are + # filtering by (string, number, boolean). For string fields, the literal value + # is interpreted as a regular expression using RE2 syntax. The literal value + # must match the entire field. # For example, filter=name ne example-instance. + # Compute Engine Beta API Only: If you use filtering in the Beta API, you can + # also filter on nested fields. For example, you could filter on instances that + # have set the scheduling.automaticRestart field to true. In particular, use + # filtering on nested fields to take advantage of instance labels to organize + # and filter results based on label values. + # The Beta API also supports filtering on multiple expressions by providing each + # separate expression within parentheses. For example, (scheduling. + # automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are + # treated as AND expressions meaning that resources must match all expressions + # to pass the filters. # @param [Fixnum] max_results - # Maximum count of results to be returned. + # The maximum number of results per page that Compute Engine should return. If + # the number of available results is larger than maxResults, Compute Engine + # returns a nextPageToken that can be used to get the next page of results in + # subsequent list requests. # @param [String] page_token - # Specifies a page token to use. Use this parameter if you want to list the next - # page of results. Set pageToken to the nextPageToken returned by a previous - # list request. + # Specifies a page token to use. Set pageToken to the nextPageToken returned by + # a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user diff --git a/generated/google/apis/doubleclicksearch_v2.rb b/generated/google/apis/doubleclicksearch_v2.rb index 4ee6edfc4..cd6415b8a 100644 --- a/generated/google/apis/doubleclicksearch_v2.rb +++ b/generated/google/apis/doubleclicksearch_v2.rb @@ -26,7 +26,7 @@ module Google # @see https://developers.google.com/doubleclick-search/ module DoubleclicksearchV2 VERSION = 'V2' - REVISION = '20151105' + REVISION = '20151202' # View and manage your advertising data in DoubleClick Search AUTH_DOUBLECLICKSEARCH = 'https://www.googleapis.com/auth/doubleclicksearch' diff --git a/generated/google/apis/doubleclicksearch_v2/classes.rb b/generated/google/apis/doubleclicksearch_v2/classes.rb index 3623fd434..e2baf73c9 100644 --- a/generated/google/apis/doubleclicksearch_v2/classes.rb +++ b/generated/google/apis/doubleclicksearch_v2/classes.rb @@ -120,11 +120,10 @@ module Google # @return [String] attr_accessor :click_id - # For offline conversions, this is an ID provided by advertisers. Advertisers - # can use this property to specify an ID that is meaningful to them. If an - # advertiser doesn't specify a conversionId, DoubleClick Search generates one. - # For online conversions, DS copies the dsConversionId or floodlightOrderId into - # this property depending on the advertiser's Floodlight instructions. + # For offline conversions, this is an ID that advertisers are required to + # provide. Advertisers can specify any ID that is meaningful to them. For online + # conversions, DS copies the dsConversionId or floodlightOrderId into this + # property depending on the advertiser's Floodlight instructions. # Corresponds to the JSON property `conversionId` # @return [String] attr_accessor :conversion_id @@ -537,8 +536,11 @@ module Google # @return [String] attr_accessor :platform_source - # Provide different source for product items. Acceptable values are "advertised" - # and "sold". + # Returns metrics only for a specific type of product activity. Accepted values + # are: + # - "sold": returns metrics only for products that were sold + # - "advertised": returns metrics only for products that were advertised in a + # Shopping campaign, and that might or might not have been sold # Corresponds to the JSON property `productReportPerspective` # @return [String] attr_accessor :product_report_perspective diff --git a/generated/google/apis/drive_v2.rb b/generated/google/apis/drive_v2.rb index 54ab5311d..7f6b052c0 100644 --- a/generated/google/apis/drive_v2.rb +++ b/generated/google/apis/drive_v2.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/drive/ module DriveV2 VERSION = 'V2' - REVISION = '20151112' + REVISION = '20151209' # View and manage the files in your Google Drive AUTH_DRIVE = 'https://www.googleapis.com/auth/drive' diff --git a/generated/google/apis/drive_v2/classes.rb b/generated/google/apis/drive_v2/classes.rb index d25e25817..83b451994 100644 --- a/generated/google/apis/drive_v2/classes.rb +++ b/generated/google/apis/drive_v2/classes.rb @@ -152,7 +152,7 @@ module Google # @return [String] attr_accessor :self_link - # The JSON template for a user. + # Information about a Drive user. # Corresponds to the JSON property `user` # @return [Google::Apis::DriveV2::User] attr_accessor :user @@ -892,7 +892,7 @@ module Google end end - # A JSON representation of a comment on a file in Google Drive. + # A comment on a file in Google Drive. class Comment include Google::Apis::Core::Hashable @@ -902,7 +902,7 @@ module Google # @return [String] attr_accessor :anchor - # The JSON template for a user. + # Information about a Drive user. # Corresponds to the JSON property `author` # @return [Google::Apis::DriveV2::User] attr_accessor :author @@ -1030,7 +1030,7 @@ module Google end end - # A JSON representation of a list of comments on a file in Google Drive. + # A list of comments on a file in Google Drive. class CommentList include Google::Apis::Core::Hashable @@ -1073,11 +1073,11 @@ module Google end end - # A JSON representation of a reply to a comment on a file in Google Drive. + # A comment on a file in Google Drive. class CommentReply include Google::Apis::Core::Hashable - # The JSON template for a user. + # Information about a Drive user. # Corresponds to the JSON property `author` # @return [Google::Apis::DriveV2::User] attr_accessor :author @@ -1148,8 +1148,7 @@ module Google end end - # A JSON representation of a list of replies to a comment on a file in Google - # Drive. + # A list of replies to a comment on a file in Google Drive. class CommentReplyList include Google::Apis::Core::Hashable @@ -1337,7 +1336,7 @@ module Google # @return [Google::Apis::DriveV2::File::Labels] attr_accessor :labels - # The JSON template for a user. + # Information about a Drive user. # Corresponds to the JSON property `lastModifyingUser` # @return [Google::Apis::DriveV2::User] attr_accessor :last_modifying_user @@ -1460,7 +1459,7 @@ module Google # @return [DateTime] attr_accessor :shared_with_me_date - # The JSON template for a user. + # Information about a Drive user. # Corresponds to the JSON property `sharingUser` # @return [Google::Apis::DriveV2::User] attr_accessor :sharing_user @@ -2353,7 +2352,7 @@ module Google # @return [String] attr_accessor :kind - # The JSON template for a user. + # Information about a Drive user. # Corresponds to the JSON property `lastModifyingUser` # @return [Google::Apis::DriveV2::User] attr_accessor :last_modifying_user @@ -2489,7 +2488,7 @@ module Google end end - # The JSON template for a user. + # Information about a Drive user. class User include Google::Apis::Core::Hashable diff --git a/generated/google/apis/drive_v3.rb b/generated/google/apis/drive_v3.rb new file mode 100644 index 000000000..d3e07c4ab --- /dev/null +++ b/generated/google/apis/drive_v3.rb @@ -0,0 +1,55 @@ +# Copyright 2015 Google Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +require 'google/apis/drive_v3/service.rb' +require 'google/apis/drive_v3/classes.rb' +require 'google/apis/drive_v3/representations.rb' + +module Google + module Apis + # Drive API + # + # The API to interact with Drive. + # + # @see https://developers.google.com/drive/ + module DriveV3 + VERSION = 'V3' + REVISION = '20151209' + + # View and manage the files in your Google Drive + AUTH_DRIVE = 'https://www.googleapis.com/auth/drive' + + # View and manage its own configuration data in your Google Drive + AUTH_DRIVE_APPDATA = 'https://www.googleapis.com/auth/drive.appdata' + + # View and manage Google Drive files and folders that you have opened or created with this app + AUTH_DRIVE_FILE = 'https://www.googleapis.com/auth/drive.file' + + # View and manage metadata of files in your Google Drive + AUTH_DRIVE_METADATA = 'https://www.googleapis.com/auth/drive.metadata' + + # View metadata for files in your Google Drive + AUTH_DRIVE_METADATA_READONLY = 'https://www.googleapis.com/auth/drive.metadata.readonly' + + # View the photos, videos and albums in your Google Photos + AUTH_DRIVE_PHOTOS_READONLY = 'https://www.googleapis.com/auth/drive.photos.readonly' + + # View the files in your Google Drive + AUTH_DRIVE_READONLY = 'https://www.googleapis.com/auth/drive.readonly' + + # Modify your Google Apps Script scripts' behavior + AUTH_DRIVE_SCRIPTS = 'https://www.googleapis.com/auth/drive.scripts' + end + end +end diff --git a/generated/google/apis/drive_v3/classes.rb b/generated/google/apis/drive_v3/classes.rb new file mode 100644 index 000000000..1023869eb --- /dev/null +++ b/generated/google/apis/drive_v3/classes.rb @@ -0,0 +1,1534 @@ +# Copyright 2015 Google Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +require 'date' +require 'google/apis/core/base_service' +require 'google/apis/core/json_representation' +require 'google/apis/core/hashable' +require 'google/apis/errors' + +module Google + module Apis + module DriveV3 + + # Information about the user, the user's Drive, and system capabilities. + class About + include Google::Apis::Core::Hashable + + # Whether the user has installed the requesting app. + # Corresponds to the JSON property `appInstalled` + # @return [Boolean] + attr_accessor :app_installed + alias_method :app_installed?, :app_installed + + # A map of source MIME type to possible targets for all supported exports. + # Corresponds to the JSON property `exportFormats` + # @return [Hash>] + attr_accessor :export_formats + + # The currently supported folder colors as RGB hex strings. + # Corresponds to the JSON property `folderColorPalette` + # @return [Array] + attr_accessor :folder_color_palette + + # A map of source MIME type to possible targets for all supported imports. + # Corresponds to the JSON property `importFormats` + # @return [Hash>] + attr_accessor :import_formats + + # This is always drive#about. + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # A map of maximum import sizes by MIME type, in bytes. + # Corresponds to the JSON property `maxImportSizes` + # @return [Hash] + attr_accessor :max_import_sizes + + # The maximum upload size in bytes. + # Corresponds to the JSON property `maxUploadSize` + # @return [String] + attr_accessor :max_upload_size + + # The user's storage quota limits and usage. All fields are measured in bytes. + # Corresponds to the JSON property `storageQuota` + # @return [Google::Apis::DriveV3::About::StorageQuota] + attr_accessor :storage_quota + + # Information about a Drive user. + # Corresponds to the JSON property `user` + # @return [Google::Apis::DriveV3::User] + attr_accessor :user + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @app_installed = args[:app_installed] unless args[:app_installed].nil? + @export_formats = args[:export_formats] unless args[:export_formats].nil? + @folder_color_palette = args[:folder_color_palette] unless args[:folder_color_palette].nil? + @import_formats = args[:import_formats] unless args[:import_formats].nil? + @kind = args[:kind] unless args[:kind].nil? + @max_import_sizes = args[:max_import_sizes] unless args[:max_import_sizes].nil? + @max_upload_size = args[:max_upload_size] unless args[:max_upload_size].nil? + @storage_quota = args[:storage_quota] unless args[:storage_quota].nil? + @user = args[:user] unless args[:user].nil? + end + + # The user's storage quota limits and usage. All fields are measured in bytes. + class StorageQuota + include Google::Apis::Core::Hashable + + # The usage limit, if applicable. This will not be present if the user has + # unlimited storage. + # Corresponds to the JSON property `limit` + # @return [String] + attr_accessor :limit + + # The total usage across all services. + # Corresponds to the JSON property `usage` + # @return [String] + attr_accessor :usage + + # The usage by all files in Google Drive. + # Corresponds to the JSON property `usageInDrive` + # @return [String] + attr_accessor :usage_in_drive + + # The usage by trashed files in Google Drive. + # Corresponds to the JSON property `usageInDriveTrash` + # @return [String] + attr_accessor :usage_in_drive_trash + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @limit = args[:limit] unless args[:limit].nil? + @usage = args[:usage] unless args[:usage].nil? + @usage_in_drive = args[:usage_in_drive] unless args[:usage_in_drive].nil? + @usage_in_drive_trash = args[:usage_in_drive_trash] unless args[:usage_in_drive_trash].nil? + end + end + end + + # A change to a file. + class Change + include Google::Apis::Core::Hashable + + # The metadata for a file. + # Corresponds to the JSON property `file` + # @return [Google::Apis::DriveV3::File] + attr_accessor :file + + # The ID of the file which has changed. + # Corresponds to the JSON property `fileId` + # @return [String] + attr_accessor :file_id + + # This is always drive#change. + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Whether the file has been removed from the view of the changes list, for + # example by deletion or lost access. + # Corresponds to the JSON property `removed` + # @return [Boolean] + attr_accessor :removed + alias_method :removed?, :removed + + # The time of this change (RFC 3339 date-time). + # Corresponds to the JSON property `time` + # @return [DateTime] + attr_accessor :time + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @file = args[:file] unless args[:file].nil? + @file_id = args[:file_id] unless args[:file_id].nil? + @kind = args[:kind] unless args[:kind].nil? + @removed = args[:removed] unless args[:removed].nil? + @time = args[:time] unless args[:time].nil? + end + end + + # A list of changes for a user. + class ChangeList + include Google::Apis::Core::Hashable + + # The page of changes. + # Corresponds to the JSON property `changes` + # @return [Array] + attr_accessor :changes + + # This is always drive#changeList. + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # The starting page token for future changes. This will be present only if the + # end of the current changes list has been reached. + # Corresponds to the JSON property `newStartPageToken` + # @return [String] + attr_accessor :new_start_page_token + + # The page token for the next page of changes. This will be absent if the end of + # the current changes list has been reached. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @changes = args[:changes] unless args[:changes].nil? + @kind = args[:kind] unless args[:kind].nil? + @new_start_page_token = args[:new_start_page_token] unless args[:new_start_page_token].nil? + @next_page_token = args[:next_page_token] unless args[:next_page_token].nil? + end + end + + # An notification channel used to watch for resource changes. + class Channel + include Google::Apis::Core::Hashable + + # The address where notifications are delivered for this channel. + # Corresponds to the JSON property `address` + # @return [String] + attr_accessor :address + + # Date and time of notification channel expiration, expressed as a Unix + # timestamp, in milliseconds. Optional. + # Corresponds to the JSON property `expiration` + # @return [String] + attr_accessor :expiration + + # A UUID or similar unique string that identifies this channel. + # Corresponds to the JSON property `id` + # @return [String] + attr_accessor :id + + # Identifies this as a notification channel used to watch for changes to a + # resource. Value: the fixed string "api#channel". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Additional parameters controlling delivery channel behavior. Optional. + # Corresponds to the JSON property `params` + # @return [Hash] + attr_accessor :params + + # A Boolean value to indicate whether payload is wanted. Optional. + # Corresponds to the JSON property `payload` + # @return [Boolean] + attr_accessor :payload + alias_method :payload?, :payload + + # An opaque ID that identifies the resource being watched on this channel. + # Stable across different API versions. + # Corresponds to the JSON property `resourceId` + # @return [String] + attr_accessor :resource_id + + # A version-specific identifier for the watched resource. + # Corresponds to the JSON property `resourceUri` + # @return [String] + attr_accessor :resource_uri + + # An arbitrary string delivered to the target address with each notification + # delivered over this channel. Optional. + # Corresponds to the JSON property `token` + # @return [String] + attr_accessor :token + + # The type of delivery mechanism used for this channel. + # Corresponds to the JSON property `type` + # @return [String] + attr_accessor :type + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @address = args[:address] unless args[:address].nil? + @expiration = args[:expiration] unless args[:expiration].nil? + @id = args[:id] unless args[:id].nil? + @kind = args[:kind] unless args[:kind].nil? + @params = args[:params] unless args[:params].nil? + @payload = args[:payload] unless args[:payload].nil? + @resource_id = args[:resource_id] unless args[:resource_id].nil? + @resource_uri = args[:resource_uri] unless args[:resource_uri].nil? + @token = args[:token] unless args[:token].nil? + @type = args[:type] unless args[:type].nil? + end + end + + # A comment on a file. + class Comment + include Google::Apis::Core::Hashable + + # A region of the document represented as a JSON string. See anchor + # documentation for details on how to define and interpret anchor properties. + # Corresponds to the JSON property `anchor` + # @return [String] + attr_accessor :anchor + + # Information about a Drive user. + # Corresponds to the JSON property `author` + # @return [Google::Apis::DriveV3::User] + attr_accessor :author + + # The plain text content of the comment. This field is used for setting the + # content, while htmlContent should be displayed. + # Corresponds to the JSON property `content` + # @return [String] + attr_accessor :content + + # The time at which the comment was created (RFC 3339 date-time). + # Corresponds to the JSON property `createdTime` + # @return [DateTime] + attr_accessor :created_time + + # Whether the comment has been deleted. A deleted comment has no content. + # Corresponds to the JSON property `deleted` + # @return [Boolean] + attr_accessor :deleted + alias_method :deleted?, :deleted + + # The content of the comment with HTML formatting. + # Corresponds to the JSON property `htmlContent` + # @return [String] + attr_accessor :html_content + + # The ID of the comment. + # Corresponds to the JSON property `id` + # @return [String] + attr_accessor :id + + # This is always drive#comment. + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # The last time the comment or any of its replies was modified (RFC 3339 date- + # time). + # Corresponds to the JSON property `modifiedTime` + # @return [DateTime] + attr_accessor :modified_time + + # The file content to which the comment refers, typically within the anchor + # region. For a text file, for example, this would be the text at the location + # of the comment. + # Corresponds to the JSON property `quotedFileContent` + # @return [Google::Apis::DriveV3::Comment::QuotedFileContent] + attr_accessor :quoted_file_content + + # The full list of replies to the comment in chronological order. + # Corresponds to the JSON property `replies` + # @return [Array] + attr_accessor :replies + + # Whether the comment has been resolved by one of its replies. + # Corresponds to the JSON property `resolved` + # @return [Boolean] + attr_accessor :resolved + alias_method :resolved?, :resolved + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @anchor = args[:anchor] unless args[:anchor].nil? + @author = args[:author] unless args[:author].nil? + @content = args[:content] unless args[:content].nil? + @created_time = args[:created_time] unless args[:created_time].nil? + @deleted = args[:deleted] unless args[:deleted].nil? + @html_content = args[:html_content] unless args[:html_content].nil? + @id = args[:id] unless args[:id].nil? + @kind = args[:kind] unless args[:kind].nil? + @modified_time = args[:modified_time] unless args[:modified_time].nil? + @quoted_file_content = args[:quoted_file_content] unless args[:quoted_file_content].nil? + @replies = args[:replies] unless args[:replies].nil? + @resolved = args[:resolved] unless args[:resolved].nil? + end + + # The file content to which the comment refers, typically within the anchor + # region. For a text file, for example, this would be the text at the location + # of the comment. + class QuotedFileContent + include Google::Apis::Core::Hashable + + # The MIME type of the quoted content. + # Corresponds to the JSON property `mimeType` + # @return [String] + attr_accessor :mime_type + + # The quoted content itself. This is interpreted as plain text if set through + # the API. + # Corresponds to the JSON property `value` + # @return [String] + attr_accessor :value + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @mime_type = args[:mime_type] unless args[:mime_type].nil? + @value = args[:value] unless args[:value].nil? + end + end + end + + # A list of comments on a file. + class CommentList + include Google::Apis::Core::Hashable + + # The page of comments. + # Corresponds to the JSON property `comments` + # @return [Array] + attr_accessor :comments + + # This is always drive#commentList. + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # The page token for the next page of comments. This will be absent if the end + # of the comments list has been reached. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @comments = args[:comments] unless args[:comments].nil? + @kind = args[:kind] unless args[:kind].nil? + @next_page_token = args[:next_page_token] unless args[:next_page_token].nil? + end + end + + # The metadata for a file. + class File + include Google::Apis::Core::Hashable + + # A collection of arbitrary key-value pairs which are private to the requesting + # app. + # Entries with null values are cleared in update and copy requests. + # Corresponds to the JSON property `appProperties` + # @return [Hash] + attr_accessor :app_properties + + # Capabilities the current user has on the file. + # Corresponds to the JSON property `capabilities` + # @return [Google::Apis::DriveV3::File::Capabilities] + attr_accessor :capabilities + + # Additional information about the content of the file. These fields are never + # populated in responses. + # Corresponds to the JSON property `contentHints` + # @return [Google::Apis::DriveV3::File::ContentHints] + attr_accessor :content_hints + + # The time at which the file was created (RFC 3339 date-time). + # Corresponds to the JSON property `createdTime` + # @return [DateTime] + attr_accessor :created_time + + # A short description of the file. + # Corresponds to the JSON property `description` + # @return [String] + attr_accessor :description + + # Whether the file has been explicitly trashed, as opposed to recursively + # trashed from a parent folder. + # Corresponds to the JSON property `explicitlyTrashed` + # @return [Boolean] + attr_accessor :explicitly_trashed + alias_method :explicitly_trashed?, :explicitly_trashed + + # The final component of fullFileExtension. This is only available for files + # with binary content in Drive. + # Corresponds to the JSON property `fileExtension` + # @return [String] + attr_accessor :file_extension + + # The color for a folder as an RGB hex string. The supported colors are + # published in the folderColorPalette field of the About resource. + # If an unsupported color is specified, the closest color in the palette will be + # used instead. + # Corresponds to the JSON property `folderColorRgb` + # @return [String] + attr_accessor :folder_color_rgb + + # The full file extension extracted from the name field. May contain multiple + # concatenated extensions, such as "tar.gz". This is only available for files + # with binary content in Drive. + # This is automatically updated when the name field changes, however it is not + # cleared if the new name does not contain a valid extension. + # Corresponds to the JSON property `fullFileExtension` + # @return [String] + attr_accessor :full_file_extension + + # The ID of the file's head revision. This is currently only available for files + # with binary content in Drive. + # Corresponds to the JSON property `headRevisionId` + # @return [String] + attr_accessor :head_revision_id + + # A static, unauthenticated link to the file's icon. + # Corresponds to the JSON property `iconLink` + # @return [String] + attr_accessor :icon_link + + # The ID of the file. + # Corresponds to the JSON property `id` + # @return [String] + attr_accessor :id + + # Additional metadata about image media, if available. + # Corresponds to the JSON property `imageMediaMetadata` + # @return [Google::Apis::DriveV3::File::ImageMediaMetadata] + attr_accessor :image_media_metadata + + # This is always drive#file. + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Information about a Drive user. + # Corresponds to the JSON property `lastModifyingUser` + # @return [Google::Apis::DriveV3::User] + attr_accessor :last_modifying_user + + # The MD5 checksum for the content of the file. This is only applicable to files + # with binary content in Drive. + # Corresponds to the JSON property `md5Checksum` + # @return [String] + attr_accessor :md5_checksum + + # The MIME type of the file. + # Drive will attempt to automatically detect an appropriate value from uploaded + # content if no value is provided. The value cannot be changed unless a new + # revision is uploaded. + # If a file is created with a Google Doc MIME type, the uploaded content will be + # imported if possible. The supported import formats are published in the About + # resource. + # Corresponds to the JSON property `mimeType` + # @return [String] + attr_accessor :mime_type + + # The last time the file was modified by the user (RFC 3339 date-time). + # Corresponds to the JSON property `modifiedByMeTime` + # @return [DateTime] + attr_accessor :modified_by_me_time + + # The last time the file was modified by anyone (RFC 3339 date-time). + # Note that setting modifiedTime will also update modifiedByMeTime for the user. + # Corresponds to the JSON property `modifiedTime` + # @return [DateTime] + attr_accessor :modified_time + + # The name of the file. This is not necessarily unique within a folder. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # The original filename of the uploaded content if available, or else the + # original value of the name field. This is only available for files with binary + # content in Drive. + # Corresponds to the JSON property `originalFilename` + # @return [String] + attr_accessor :original_filename + + # Whether the user owns the file. + # Corresponds to the JSON property `ownedByMe` + # @return [Boolean] + attr_accessor :owned_by_me + alias_method :owned_by_me?, :owned_by_me + + # The owners of the file. Currently, only certain legacy files may have more + # than one owner. + # Corresponds to the JSON property `owners` + # @return [Array] + attr_accessor :owners + + # The IDs of the parent folders which contain the file. + # If not specified as part of a create request, the file will be placed directly + # in the My Drive folder. Update requests must use the addParents and + # removeParents parameters to modify the values. + # Corresponds to the JSON property `parents` + # @return [Array] + attr_accessor :parents + + # The full list of permissions for the file. This is only available if the + # requesting user can share the file. + # Corresponds to the JSON property `permissions` + # @return [Array] + attr_accessor :permissions + + # A collection of arbitrary key-value pairs which are visible to all apps. + # Entries with null values are cleared in update and copy requests. + # Corresponds to the JSON property `properties` + # @return [Hash] + attr_accessor :properties + + # The number of storage quota bytes used by the file. This includes the head + # revision as well as previous revisions with keepForever enabled. + # Corresponds to the JSON property `quotaBytesUsed` + # @return [String] + attr_accessor :quota_bytes_used + + # Whether the file has been shared. + # Corresponds to the JSON property `shared` + # @return [Boolean] + attr_accessor :shared + alias_method :shared?, :shared + + # The time at which the file was shared with the user, if applicable (RFC 3339 + # date-time). + # Corresponds to the JSON property `sharedWithMeTime` + # @return [DateTime] + attr_accessor :shared_with_me_time + + # Information about a Drive user. + # Corresponds to the JSON property `sharingUser` + # @return [Google::Apis::DriveV3::User] + attr_accessor :sharing_user + + # The size of the file's content in bytes. This is only applicable to files with + # binary content in Drive. + # Corresponds to the JSON property `size` + # @return [String] + attr_accessor :size + + # The list of spaces which contain the file. The currently supported values are ' + # drive', 'appDataFolder' and 'photos'. + # Corresponds to the JSON property `spaces` + # @return [Array] + attr_accessor :spaces + + # Whether the user has starred the file. + # Corresponds to the JSON property `starred` + # @return [Boolean] + attr_accessor :starred + alias_method :starred?, :starred + + # A short-lived link to the file's thumbnail, if available. Typically lasts on + # the order of hours. + # Corresponds to the JSON property `thumbnailLink` + # @return [String] + attr_accessor :thumbnail_link + + # Whether the file has been trashed, either explicitly or from a trashed parent + # folder. Only the owner may trash a file, and other users cannot see files in + # the owner's trash. + # Corresponds to the JSON property `trashed` + # @return [Boolean] + attr_accessor :trashed + alias_method :trashed?, :trashed + + # A monotonically increasing version number for the file. This reflects every + # change made to the file on the server, even those not visible to the user. + # Corresponds to the JSON property `version` + # @return [String] + attr_accessor :version + + # Additional metadata about video media. This may not be available immediately + # upon upload. + # Corresponds to the JSON property `videoMediaMetadata` + # @return [Google::Apis::DriveV3::File::VideoMediaMetadata] + attr_accessor :video_media_metadata + + # Whether the file has been viewed by this user. + # Corresponds to the JSON property `viewedByMe` + # @return [Boolean] + attr_accessor :viewed_by_me + alias_method :viewed_by_me?, :viewed_by_me + + # The last time the file was viewed by the user (RFC 3339 date-time). + # Corresponds to the JSON property `viewedByMeTime` + # @return [DateTime] + attr_accessor :viewed_by_me_time + + # Whether users with only reader or commenter permission can copy the file's + # content. This affects copy, download, and print operations. + # Corresponds to the JSON property `viewersCanCopyContent` + # @return [Boolean] + attr_accessor :viewers_can_copy_content + alias_method :viewers_can_copy_content?, :viewers_can_copy_content + + # A link for downloading the content of the file in a browser. This is only + # available for files with binary content in Drive. + # Corresponds to the JSON property `webContentLink` + # @return [String] + attr_accessor :web_content_link + + # A link for opening the file in a relevant Google editor or viewer in a browser. + # Corresponds to the JSON property `webViewLink` + # @return [String] + attr_accessor :web_view_link + + # Whether users with only writer permission can modify the file's permissions. + # Corresponds to the JSON property `writersCanShare` + # @return [Boolean] + attr_accessor :writers_can_share + alias_method :writers_can_share?, :writers_can_share + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @app_properties = args[:app_properties] unless args[:app_properties].nil? + @capabilities = args[:capabilities] unless args[:capabilities].nil? + @content_hints = args[:content_hints] unless args[:content_hints].nil? + @created_time = args[:created_time] unless args[:created_time].nil? + @description = args[:description] unless args[:description].nil? + @explicitly_trashed = args[:explicitly_trashed] unless args[:explicitly_trashed].nil? + @file_extension = args[:file_extension] unless args[:file_extension].nil? + @folder_color_rgb = args[:folder_color_rgb] unless args[:folder_color_rgb].nil? + @full_file_extension = args[:full_file_extension] unless args[:full_file_extension].nil? + @head_revision_id = args[:head_revision_id] unless args[:head_revision_id].nil? + @icon_link = args[:icon_link] unless args[:icon_link].nil? + @id = args[:id] unless args[:id].nil? + @image_media_metadata = args[:image_media_metadata] unless args[:image_media_metadata].nil? + @kind = args[:kind] unless args[:kind].nil? + @last_modifying_user = args[:last_modifying_user] unless args[:last_modifying_user].nil? + @md5_checksum = args[:md5_checksum] unless args[:md5_checksum].nil? + @mime_type = args[:mime_type] unless args[:mime_type].nil? + @modified_by_me_time = args[:modified_by_me_time] unless args[:modified_by_me_time].nil? + @modified_time = args[:modified_time] unless args[:modified_time].nil? + @name = args[:name] unless args[:name].nil? + @original_filename = args[:original_filename] unless args[:original_filename].nil? + @owned_by_me = args[:owned_by_me] unless args[:owned_by_me].nil? + @owners = args[:owners] unless args[:owners].nil? + @parents = args[:parents] unless args[:parents].nil? + @permissions = args[:permissions] unless args[:permissions].nil? + @properties = args[:properties] unless args[:properties].nil? + @quota_bytes_used = args[:quota_bytes_used] unless args[:quota_bytes_used].nil? + @shared = args[:shared] unless args[:shared].nil? + @shared_with_me_time = args[:shared_with_me_time] unless args[:shared_with_me_time].nil? + @sharing_user = args[:sharing_user] unless args[:sharing_user].nil? + @size = args[:size] unless args[:size].nil? + @spaces = args[:spaces] unless args[:spaces].nil? + @starred = args[:starred] unless args[:starred].nil? + @thumbnail_link = args[:thumbnail_link] unless args[:thumbnail_link].nil? + @trashed = args[:trashed] unless args[:trashed].nil? + @version = args[:version] unless args[:version].nil? + @video_media_metadata = args[:video_media_metadata] unless args[:video_media_metadata].nil? + @viewed_by_me = args[:viewed_by_me] unless args[:viewed_by_me].nil? + @viewed_by_me_time = args[:viewed_by_me_time] unless args[:viewed_by_me_time].nil? + @viewers_can_copy_content = args[:viewers_can_copy_content] unless args[:viewers_can_copy_content].nil? + @web_content_link = args[:web_content_link] unless args[:web_content_link].nil? + @web_view_link = args[:web_view_link] unless args[:web_view_link].nil? + @writers_can_share = args[:writers_can_share] unless args[:writers_can_share].nil? + end + + # Capabilities the current user has on the file. + class Capabilities + include Google::Apis::Core::Hashable + + # Whether the user can comment on the file. + # Corresponds to the JSON property `canComment` + # @return [Boolean] + attr_accessor :can_comment + alias_method :can_comment?, :can_comment + + # Whether the user can copy the file. + # Corresponds to the JSON property `canCopy` + # @return [Boolean] + attr_accessor :can_copy + alias_method :can_copy?, :can_copy + + # Whether the user can edit the file's content. + # Corresponds to the JSON property `canEdit` + # @return [Boolean] + attr_accessor :can_edit + alias_method :can_edit?, :can_edit + + # Whether the user can modify the file's permissions and sharing settings. + # Corresponds to the JSON property `canShare` + # @return [Boolean] + attr_accessor :can_share + alias_method :can_share?, :can_share + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @can_comment = args[:can_comment] unless args[:can_comment].nil? + @can_copy = args[:can_copy] unless args[:can_copy].nil? + @can_edit = args[:can_edit] unless args[:can_edit].nil? + @can_share = args[:can_share] unless args[:can_share].nil? + end + end + + # Additional information about the content of the file. These fields are never + # populated in responses. + class ContentHints + include Google::Apis::Core::Hashable + + # Text to be indexed for the file to improve fullText queries. This is limited + # to 128KB in length and may contain HTML elements. + # Corresponds to the JSON property `indexableText` + # @return [String] + attr_accessor :indexable_text + + # A thumbnail for the file. This will only be used if Drive cannot generate a + # standard thumbnail. + # Corresponds to the JSON property `thumbnail` + # @return [Google::Apis::DriveV3::File::ContentHints::Thumbnail] + attr_accessor :thumbnail + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @indexable_text = args[:indexable_text] unless args[:indexable_text].nil? + @thumbnail = args[:thumbnail] unless args[:thumbnail].nil? + end + + # A thumbnail for the file. This will only be used if Drive cannot generate a + # standard thumbnail. + class Thumbnail + include Google::Apis::Core::Hashable + + # The thumbnail data encoded with URL-safe Base64 (RFC 4648 section 5). + # Corresponds to the JSON property `image` + # @return [String] + attr_accessor :image + + # The MIME type of the thumbnail. + # Corresponds to the JSON property `mimeType` + # @return [String] + attr_accessor :mime_type + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @image = args[:image] unless args[:image].nil? + @mime_type = args[:mime_type] unless args[:mime_type].nil? + end + end + end + + # Additional metadata about image media, if available. + class ImageMediaMetadata + include Google::Apis::Core::Hashable + + # The aperture used to create the photo (f-number). + # Corresponds to the JSON property `aperture` + # @return [Float] + attr_accessor :aperture + + # The make of the camera used to create the photo. + # Corresponds to the JSON property `cameraMake` + # @return [String] + attr_accessor :camera_make + + # The model of the camera used to create the photo. + # Corresponds to the JSON property `cameraModel` + # @return [String] + attr_accessor :camera_model + + # The color space of the photo. + # Corresponds to the JSON property `colorSpace` + # @return [String] + attr_accessor :color_space + + # The exposure bias of the photo (APEX value). + # Corresponds to the JSON property `exposureBias` + # @return [Float] + attr_accessor :exposure_bias + + # The exposure mode used to create the photo. + # Corresponds to the JSON property `exposureMode` + # @return [String] + attr_accessor :exposure_mode + + # The length of the exposure, in seconds. + # Corresponds to the JSON property `exposureTime` + # @return [Float] + attr_accessor :exposure_time + + # Whether a flash was used to create the photo. + # Corresponds to the JSON property `flashUsed` + # @return [Boolean] + attr_accessor :flash_used + alias_method :flash_used?, :flash_used + + # The focal length used to create the photo, in millimeters. + # Corresponds to the JSON property `focalLength` + # @return [Float] + attr_accessor :focal_length + + # The height of the image in pixels. + # Corresponds to the JSON property `height` + # @return [Fixnum] + attr_accessor :height + + # The ISO speed used to create the photo. + # Corresponds to the JSON property `isoSpeed` + # @return [Fixnum] + attr_accessor :iso_speed + + # The lens used to create the photo. + # Corresponds to the JSON property `lens` + # @return [String] + attr_accessor :lens + + # Geographic location information stored in the image. + # Corresponds to the JSON property `location` + # @return [Google::Apis::DriveV3::File::ImageMediaMetadata::Location] + attr_accessor :location + + # The smallest f-number of the lens at the focal length used to create the photo + # (APEX value). + # Corresponds to the JSON property `maxApertureValue` + # @return [Float] + attr_accessor :max_aperture_value + + # The metering mode used to create the photo. + # Corresponds to the JSON property `meteringMode` + # @return [String] + attr_accessor :metering_mode + + # The rotation in clockwise degrees from the image's original orientation. + # Corresponds to the JSON property `rotation` + # @return [Fixnum] + attr_accessor :rotation + + # The type of sensor used to create the photo. + # Corresponds to the JSON property `sensor` + # @return [String] + attr_accessor :sensor + + # The distance to the subject of the photo, in meters. + # Corresponds to the JSON property `subjectDistance` + # @return [Fixnum] + attr_accessor :subject_distance + + # The date and time the photo was taken (EXIF DateTime). + # Corresponds to the JSON property `time` + # @return [String] + attr_accessor :time + + # The white balance mode used to create the photo. + # Corresponds to the JSON property `whiteBalance` + # @return [String] + attr_accessor :white_balance + + # The width of the image in pixels. + # Corresponds to the JSON property `width` + # @return [Fixnum] + attr_accessor :width + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @aperture = args[:aperture] unless args[:aperture].nil? + @camera_make = args[:camera_make] unless args[:camera_make].nil? + @camera_model = args[:camera_model] unless args[:camera_model].nil? + @color_space = args[:color_space] unless args[:color_space].nil? + @exposure_bias = args[:exposure_bias] unless args[:exposure_bias].nil? + @exposure_mode = args[:exposure_mode] unless args[:exposure_mode].nil? + @exposure_time = args[:exposure_time] unless args[:exposure_time].nil? + @flash_used = args[:flash_used] unless args[:flash_used].nil? + @focal_length = args[:focal_length] unless args[:focal_length].nil? + @height = args[:height] unless args[:height].nil? + @iso_speed = args[:iso_speed] unless args[:iso_speed].nil? + @lens = args[:lens] unless args[:lens].nil? + @location = args[:location] unless args[:location].nil? + @max_aperture_value = args[:max_aperture_value] unless args[:max_aperture_value].nil? + @metering_mode = args[:metering_mode] unless args[:metering_mode].nil? + @rotation = args[:rotation] unless args[:rotation].nil? + @sensor = args[:sensor] unless args[:sensor].nil? + @subject_distance = args[:subject_distance] unless args[:subject_distance].nil? + @time = args[:time] unless args[:time].nil? + @white_balance = args[:white_balance] unless args[:white_balance].nil? + @width = args[:width] unless args[:width].nil? + end + + # Geographic location information stored in the image. + class Location + include Google::Apis::Core::Hashable + + # The altitude stored in the image. + # Corresponds to the JSON property `altitude` + # @return [Float] + attr_accessor :altitude + + # The latitude stored in the image. + # Corresponds to the JSON property `latitude` + # @return [Float] + attr_accessor :latitude + + # The longitude stored in the image. + # Corresponds to the JSON property `longitude` + # @return [Float] + attr_accessor :longitude + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @altitude = args[:altitude] unless args[:altitude].nil? + @latitude = args[:latitude] unless args[:latitude].nil? + @longitude = args[:longitude] unless args[:longitude].nil? + end + end + end + + # Additional metadata about video media. This may not be available immediately + # upon upload. + class VideoMediaMetadata + include Google::Apis::Core::Hashable + + # The duration of the video in milliseconds. + # Corresponds to the JSON property `durationMillis` + # @return [String] + attr_accessor :duration_millis + + # The height of the video in pixels. + # Corresponds to the JSON property `height` + # @return [Fixnum] + attr_accessor :height + + # The width of the video in pixels. + # Corresponds to the JSON property `width` + # @return [Fixnum] + attr_accessor :width + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @duration_millis = args[:duration_millis] unless args[:duration_millis].nil? + @height = args[:height] unless args[:height].nil? + @width = args[:width] unless args[:width].nil? + end + end + end + + # A list of files. + class FileList + include Google::Apis::Core::Hashable + + # The page of files. + # Corresponds to the JSON property `files` + # @return [Array] + attr_accessor :files + + # This is always drive#fileList. + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # The page token for the next page of files. This will be absent if the end of + # the files list has been reached. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @files = args[:files] unless args[:files].nil? + @kind = args[:kind] unless args[:kind].nil? + @next_page_token = args[:next_page_token] unless args[:next_page_token].nil? + end + end + + # A list of generated file IDs which can be provided in create requests. + class GeneratedIds + include Google::Apis::Core::Hashable + + # The IDs generated for the requesting user in the specified space. + # Corresponds to the JSON property `ids` + # @return [Array] + attr_accessor :ids + + # This is always drive#generatedIds + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # The type of file that can be created with these IDs. + # Corresponds to the JSON property `space` + # @return [String] + attr_accessor :space + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @ids = args[:ids] unless args[:ids].nil? + @kind = args[:kind] unless args[:kind].nil? + @space = args[:space] unless args[:space].nil? + end + end + + # A permission for a file. A permission grants a user, group, domain or the + # world access to a file or a folder hierarchy. + class Permission + include Google::Apis::Core::Hashable + + # Whether the permission allows the file to be discovered through search. This + # is only applicable for permissions of type domain or anyone. + # Corresponds to the JSON property `allowFileDiscovery` + # @return [Boolean] + attr_accessor :allow_file_discovery + alias_method :allow_file_discovery?, :allow_file_discovery + + # A displayable name for users, groups or domains. + # Corresponds to the JSON property `displayName` + # @return [String] + attr_accessor :display_name + + # The domain to which this permission refers. + # Corresponds to the JSON property `domain` + # @return [String] + attr_accessor :domain + + # The email address of the user or group to which this permission refers. + # Corresponds to the JSON property `emailAddress` + # @return [String] + attr_accessor :email_address + + # The ID of this permission. This is a unique identifier for the grantee, and is + # published in User resources as permissionId. + # Corresponds to the JSON property `id` + # @return [String] + attr_accessor :id + + # This is always drive#permission. + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # A link to the user's profile photo, if available. + # Corresponds to the JSON property `photoLink` + # @return [String] + attr_accessor :photo_link + + # The role granted by this permission. Valid values are: + # - owner + # - writer + # - commenter + # - reader + # Corresponds to the JSON property `role` + # @return [String] + attr_accessor :role + + # The type of the grantee. Valid values are: + # - user + # - group + # - domain + # - anyone + # Corresponds to the JSON property `type` + # @return [String] + attr_accessor :type + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @allow_file_discovery = args[:allow_file_discovery] unless args[:allow_file_discovery].nil? + @display_name = args[:display_name] unless args[:display_name].nil? + @domain = args[:domain] unless args[:domain].nil? + @email_address = args[:email_address] unless args[:email_address].nil? + @id = args[:id] unless args[:id].nil? + @kind = args[:kind] unless args[:kind].nil? + @photo_link = args[:photo_link] unless args[:photo_link].nil? + @role = args[:role] unless args[:role].nil? + @type = args[:type] unless args[:type].nil? + end + end + + # A list of permissions for a file. + class PermissionList + include Google::Apis::Core::Hashable + + # This is always drive#permissionList. + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # The full list of permissions. + # Corresponds to the JSON property `permissions` + # @return [Array] + attr_accessor :permissions + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @kind = args[:kind] unless args[:kind].nil? + @permissions = args[:permissions] unless args[:permissions].nil? + end + end + + # A reply to a comment on a file. + class Reply + include Google::Apis::Core::Hashable + + # The action the reply performed to the parent comment. Valid values are: + # - resolve + # - reopen + # Corresponds to the JSON property `action` + # @return [String] + attr_accessor :action + + # Information about a Drive user. + # Corresponds to the JSON property `author` + # @return [Google::Apis::DriveV3::User] + attr_accessor :author + + # The plain text content of the reply. This field is used for setting the + # content, while htmlContent should be displayed. This is required on creates if + # no action is specified. + # Corresponds to the JSON property `content` + # @return [String] + attr_accessor :content + + # The time at which the reply was created (RFC 3339 date-time). + # Corresponds to the JSON property `createdTime` + # @return [DateTime] + attr_accessor :created_time + + # Whether the reply has been deleted. A deleted reply has no content. + # Corresponds to the JSON property `deleted` + # @return [Boolean] + attr_accessor :deleted + alias_method :deleted?, :deleted + + # The content of the reply with HTML formatting. + # Corresponds to the JSON property `htmlContent` + # @return [String] + attr_accessor :html_content + + # The ID of the reply. + # Corresponds to the JSON property `id` + # @return [String] + attr_accessor :id + + # This is always drive#reply. + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # The last time the reply was modified (RFC 3339 date-time). + # Corresponds to the JSON property `modifiedTime` + # @return [DateTime] + attr_accessor :modified_time + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @action = args[:action] unless args[:action].nil? + @author = args[:author] unless args[:author].nil? + @content = args[:content] unless args[:content].nil? + @created_time = args[:created_time] unless args[:created_time].nil? + @deleted = args[:deleted] unless args[:deleted].nil? + @html_content = args[:html_content] unless args[:html_content].nil? + @id = args[:id] unless args[:id].nil? + @kind = args[:kind] unless args[:kind].nil? + @modified_time = args[:modified_time] unless args[:modified_time].nil? + end + end + + # A list of replies to a comment on a file. + class ReplyList + include Google::Apis::Core::Hashable + + # This is always drive#replyList. + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # The page token for the next page of replies. This will be absent if the end of + # the replies list has been reached. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + # The page of replies. + # Corresponds to the JSON property `replies` + # @return [Array] + attr_accessor :replies + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @kind = args[:kind] unless args[:kind].nil? + @next_page_token = args[:next_page_token] unless args[:next_page_token].nil? + @replies = args[:replies] unless args[:replies].nil? + end + end + + # The metadata for a revision to a file. + class Revision + include Google::Apis::Core::Hashable + + # The ID of the revision. + # Corresponds to the JSON property `id` + # @return [String] + attr_accessor :id + + # Whether to keep this revision forever, even if it is no longer the head + # revision. If not set, the revision will be automatically purged 30 days after + # newer content is uploaded. This can be set on a maximum of 200 revisions for a + # file. + # This field is only applicable to files with binary content in Drive. + # Corresponds to the JSON property `keepForever` + # @return [Boolean] + attr_accessor :keep_forever + alias_method :keep_forever?, :keep_forever + + # This is always drive#revision. + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Information about a Drive user. + # Corresponds to the JSON property `lastModifyingUser` + # @return [Google::Apis::DriveV3::User] + attr_accessor :last_modifying_user + + # The MD5 checksum of the revision's content. This is only applicable to files + # with binary content in Drive. + # Corresponds to the JSON property `md5Checksum` + # @return [String] + attr_accessor :md5_checksum + + # The MIME type of the revision. + # Corresponds to the JSON property `mimeType` + # @return [String] + attr_accessor :mime_type + + # The last time the revision was modified (RFC 3339 date-time). + # Corresponds to the JSON property `modifiedTime` + # @return [DateTime] + attr_accessor :modified_time + + # The original filename used to create this revision. This is only applicable to + # files with binary content in Drive. + # Corresponds to the JSON property `originalFilename` + # @return [String] + attr_accessor :original_filename + + # Whether subsequent revisions will be automatically republished. This is only + # applicable to Google Docs. + # Corresponds to the JSON property `publishAuto` + # @return [Boolean] + attr_accessor :publish_auto + alias_method :publish_auto?, :publish_auto + + # Whether this revision is published. This is only applicable to Google Docs. + # Corresponds to the JSON property `published` + # @return [Boolean] + attr_accessor :published + alias_method :published?, :published + + # Whether this revision is published outside the domain. This is only applicable + # to Google Docs. + # Corresponds to the JSON property `publishedOutsideDomain` + # @return [Boolean] + attr_accessor :published_outside_domain + alias_method :published_outside_domain?, :published_outside_domain + + # The size of the revision's content in bytes. This is only applicable to files + # with binary content in Drive. + # Corresponds to the JSON property `size` + # @return [String] + attr_accessor :size + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @id = args[:id] unless args[:id].nil? + @keep_forever = args[:keep_forever] unless args[:keep_forever].nil? + @kind = args[:kind] unless args[:kind].nil? + @last_modifying_user = args[:last_modifying_user] unless args[:last_modifying_user].nil? + @md5_checksum = args[:md5_checksum] unless args[:md5_checksum].nil? + @mime_type = args[:mime_type] unless args[:mime_type].nil? + @modified_time = args[:modified_time] unless args[:modified_time].nil? + @original_filename = args[:original_filename] unless args[:original_filename].nil? + @publish_auto = args[:publish_auto] unless args[:publish_auto].nil? + @published = args[:published] unless args[:published].nil? + @published_outside_domain = args[:published_outside_domain] unless args[:published_outside_domain].nil? + @size = args[:size] unless args[:size].nil? + end + end + + # A list of revisions of a file. + class RevisionList + include Google::Apis::Core::Hashable + + # This is always drive#revisionList. + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # The full list of revisions. + # Corresponds to the JSON property `revisions` + # @return [Array] + attr_accessor :revisions + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @kind = args[:kind] unless args[:kind].nil? + @revisions = args[:revisions] unless args[:revisions].nil? + end + end + + # + class StartPageToken + include Google::Apis::Core::Hashable + + # This is always drive#startPageToken. + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # The starting page token for listing changes. + # Corresponds to the JSON property `startPageToken` + # @return [String] + attr_accessor :start_page_token + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @kind = args[:kind] unless args[:kind].nil? + @start_page_token = args[:start_page_token] unless args[:start_page_token].nil? + end + end + + # Information about a Drive user. + class User + include Google::Apis::Core::Hashable + + # A plain text displayable name for this user. + # Corresponds to the JSON property `displayName` + # @return [String] + attr_accessor :display_name + + # The email address of the user. This may not be present in certain contexts if + # the user has not made their email address visible to the requester. + # Corresponds to the JSON property `emailAddress` + # @return [String] + attr_accessor :email_address + + # This is always drive#user. + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Whether this user is the requesting user. + # Corresponds to the JSON property `me` + # @return [Boolean] + attr_accessor :me + alias_method :me?, :me + + # The user's ID as visible in Permission resources. + # Corresponds to the JSON property `permissionId` + # @return [String] + attr_accessor :permission_id + + # A link to the user's profile photo, if available. + # Corresponds to the JSON property `photoLink` + # @return [String] + attr_accessor :photo_link + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @display_name = args[:display_name] unless args[:display_name].nil? + @email_address = args[:email_address] unless args[:email_address].nil? + @kind = args[:kind] unless args[:kind].nil? + @me = args[:me] unless args[:me].nil? + @permission_id = args[:permission_id] unless args[:permission_id].nil? + @photo_link = args[:photo_link] unless args[:photo_link].nil? + end + end + end + end +end diff --git a/generated/google/apis/drive_v3/representations.rb b/generated/google/apis/drive_v3/representations.rb new file mode 100644 index 000000000..587154646 --- /dev/null +++ b/generated/google/apis/drive_v3/representations.rb @@ -0,0 +1,497 @@ +# Copyright 2015 Google Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +require 'date' +require 'google/apis/core/base_service' +require 'google/apis/core/json_representation' +require 'google/apis/core/hashable' +require 'google/apis/errors' + +module Google + module Apis + module DriveV3 + + class About + class Representation < Google::Apis::Core::JsonRepresentation; end + + class StorageQuota + class Representation < Google::Apis::Core::JsonRepresentation; end + end + end + + class Change + class Representation < Google::Apis::Core::JsonRepresentation; end + end + + class ChangeList + class Representation < Google::Apis::Core::JsonRepresentation; end + end + + class Channel + class Representation < Google::Apis::Core::JsonRepresentation; end + end + + class Comment + class Representation < Google::Apis::Core::JsonRepresentation; end + + class QuotedFileContent + class Representation < Google::Apis::Core::JsonRepresentation; end + end + end + + class CommentList + class Representation < Google::Apis::Core::JsonRepresentation; end + end + + class File + class Representation < Google::Apis::Core::JsonRepresentation; end + + class Capabilities + class Representation < Google::Apis::Core::JsonRepresentation; end + end + + class ContentHints + class Representation < Google::Apis::Core::JsonRepresentation; end + + class Thumbnail + class Representation < Google::Apis::Core::JsonRepresentation; end + end + end + + class ImageMediaMetadata + class Representation < Google::Apis::Core::JsonRepresentation; end + + class Location + class Representation < Google::Apis::Core::JsonRepresentation; end + end + end + + class VideoMediaMetadata + class Representation < Google::Apis::Core::JsonRepresentation; end + end + end + + class FileList + class Representation < Google::Apis::Core::JsonRepresentation; end + end + + class GeneratedIds + class Representation < Google::Apis::Core::JsonRepresentation; end + end + + class Permission + class Representation < Google::Apis::Core::JsonRepresentation; end + end + + class PermissionList + class Representation < Google::Apis::Core::JsonRepresentation; end + end + + class Reply + class Representation < Google::Apis::Core::JsonRepresentation; end + end + + class ReplyList + class Representation < Google::Apis::Core::JsonRepresentation; end + end + + class Revision + class Representation < Google::Apis::Core::JsonRepresentation; end + end + + class RevisionList + class Representation < Google::Apis::Core::JsonRepresentation; end + end + + class StartPageToken + class Representation < Google::Apis::Core::JsonRepresentation; end + end + + class User + class Representation < Google::Apis::Core::JsonRepresentation; end + end + + class About + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :app_installed, as: 'appInstalled' + hash :export_formats, as: 'exportFormats', :class => Array do + include Representable::JSON::Collection + items + end + + collection :folder_color_palette, as: 'folderColorPalette' + hash :import_formats, as: 'importFormats', :class => Array do + include Representable::JSON::Collection + items + end + + property :kind, as: 'kind' + hash :max_import_sizes, as: 'maxImportSizes' + property :max_upload_size, as: 'maxUploadSize' + property :storage_quota, as: 'storageQuota', class: Google::Apis::DriveV3::About::StorageQuota, decorator: Google::Apis::DriveV3::About::StorageQuota::Representation + + property :user, as: 'user', class: Google::Apis::DriveV3::User, decorator: Google::Apis::DriveV3::User::Representation + + end + + class StorageQuota + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :limit, as: 'limit' + property :usage, as: 'usage' + property :usage_in_drive, as: 'usageInDrive' + property :usage_in_drive_trash, as: 'usageInDriveTrash' + end + end + end + + class Change + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :file, as: 'file', class: Google::Apis::DriveV3::File, decorator: Google::Apis::DriveV3::File::Representation + + property :file_id, as: 'fileId' + property :kind, as: 'kind' + property :removed, as: 'removed' + property :time, as: 'time', type: DateTime + + end + end + + class ChangeList + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :changes, as: 'changes', class: Google::Apis::DriveV3::Change, decorator: Google::Apis::DriveV3::Change::Representation + + property :kind, as: 'kind' + property :new_start_page_token, as: 'newStartPageToken' + property :next_page_token, as: 'nextPageToken' + end + end + + class Channel + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :address, as: 'address' + property :expiration, as: 'expiration' + property :id, as: 'id' + property :kind, as: 'kind' + hash :params, as: 'params' + property :payload, as: 'payload' + property :resource_id, as: 'resourceId' + property :resource_uri, as: 'resourceUri' + property :token, as: 'token' + property :type, as: 'type' + end + end + + class Comment + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :anchor, as: 'anchor' + property :author, as: 'author', class: Google::Apis::DriveV3::User, decorator: Google::Apis::DriveV3::User::Representation + + property :content, as: 'content' + property :created_time, as: 'createdTime', type: DateTime + + property :deleted, as: 'deleted' + property :html_content, as: 'htmlContent' + property :id, as: 'id' + property :kind, as: 'kind' + property :modified_time, as: 'modifiedTime', type: DateTime + + property :quoted_file_content, as: 'quotedFileContent', class: Google::Apis::DriveV3::Comment::QuotedFileContent, decorator: Google::Apis::DriveV3::Comment::QuotedFileContent::Representation + + collection :replies, as: 'replies', class: Google::Apis::DriveV3::Reply, decorator: Google::Apis::DriveV3::Reply::Representation + + property :resolved, as: 'resolved' + end + + class QuotedFileContent + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :mime_type, as: 'mimeType' + property :value, as: 'value' + end + end + end + + class CommentList + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :comments, as: 'comments', class: Google::Apis::DriveV3::Comment, decorator: Google::Apis::DriveV3::Comment::Representation + + property :kind, as: 'kind' + property :next_page_token, as: 'nextPageToken' + end + end + + class File + # @private + class Representation < Google::Apis::Core::JsonRepresentation + hash :app_properties, as: 'appProperties' + property :capabilities, as: 'capabilities', class: Google::Apis::DriveV3::File::Capabilities, decorator: Google::Apis::DriveV3::File::Capabilities::Representation + + property :content_hints, as: 'contentHints', class: Google::Apis::DriveV3::File::ContentHints, decorator: Google::Apis::DriveV3::File::ContentHints::Representation + + property :created_time, as: 'createdTime', type: DateTime + + property :description, as: 'description' + property :explicitly_trashed, as: 'explicitlyTrashed' + property :file_extension, as: 'fileExtension' + property :folder_color_rgb, as: 'folderColorRgb' + property :full_file_extension, as: 'fullFileExtension' + property :head_revision_id, as: 'headRevisionId' + property :icon_link, as: 'iconLink' + property :id, as: 'id' + property :image_media_metadata, as: 'imageMediaMetadata', class: Google::Apis::DriveV3::File::ImageMediaMetadata, decorator: Google::Apis::DriveV3::File::ImageMediaMetadata::Representation + + property :kind, as: 'kind' + property :last_modifying_user, as: 'lastModifyingUser', class: Google::Apis::DriveV3::User, decorator: Google::Apis::DriveV3::User::Representation + + property :md5_checksum, as: 'md5Checksum' + property :mime_type, as: 'mimeType' + property :modified_by_me_time, as: 'modifiedByMeTime', type: DateTime + + property :modified_time, as: 'modifiedTime', type: DateTime + + property :name, as: 'name' + property :original_filename, as: 'originalFilename' + property :owned_by_me, as: 'ownedByMe' + collection :owners, as: 'owners', class: Google::Apis::DriveV3::User, decorator: Google::Apis::DriveV3::User::Representation + + collection :parents, as: 'parents' + collection :permissions, as: 'permissions', class: Google::Apis::DriveV3::Permission, decorator: Google::Apis::DriveV3::Permission::Representation + + hash :properties, as: 'properties' + property :quota_bytes_used, as: 'quotaBytesUsed' + property :shared, as: 'shared' + property :shared_with_me_time, as: 'sharedWithMeTime', type: DateTime + + property :sharing_user, as: 'sharingUser', class: Google::Apis::DriveV3::User, decorator: Google::Apis::DriveV3::User::Representation + + property :size, as: 'size' + collection :spaces, as: 'spaces' + property :starred, as: 'starred' + property :thumbnail_link, as: 'thumbnailLink' + property :trashed, as: 'trashed' + property :version, as: 'version' + property :video_media_metadata, as: 'videoMediaMetadata', class: Google::Apis::DriveV3::File::VideoMediaMetadata, decorator: Google::Apis::DriveV3::File::VideoMediaMetadata::Representation + + property :viewed_by_me, as: 'viewedByMe' + property :viewed_by_me_time, as: 'viewedByMeTime', type: DateTime + + property :viewers_can_copy_content, as: 'viewersCanCopyContent' + property :web_content_link, as: 'webContentLink' + property :web_view_link, as: 'webViewLink' + property :writers_can_share, as: 'writersCanShare' + end + + class Capabilities + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :can_comment, as: 'canComment' + property :can_copy, as: 'canCopy' + property :can_edit, as: 'canEdit' + property :can_share, as: 'canShare' + end + end + + class ContentHints + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :indexable_text, as: 'indexableText' + property :thumbnail, as: 'thumbnail', class: Google::Apis::DriveV3::File::ContentHints::Thumbnail, decorator: Google::Apis::DriveV3::File::ContentHints::Thumbnail::Representation + + end + + class Thumbnail + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :image, :base64 => true, as: 'image' + property :mime_type, as: 'mimeType' + end + end + end + + class ImageMediaMetadata + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :aperture, as: 'aperture' + property :camera_make, as: 'cameraMake' + property :camera_model, as: 'cameraModel' + property :color_space, as: 'colorSpace' + property :exposure_bias, as: 'exposureBias' + property :exposure_mode, as: 'exposureMode' + property :exposure_time, as: 'exposureTime' + property :flash_used, as: 'flashUsed' + property :focal_length, as: 'focalLength' + property :height, as: 'height' + property :iso_speed, as: 'isoSpeed' + property :lens, as: 'lens' + property :location, as: 'location', class: Google::Apis::DriveV3::File::ImageMediaMetadata::Location, decorator: Google::Apis::DriveV3::File::ImageMediaMetadata::Location::Representation + + property :max_aperture_value, as: 'maxApertureValue' + property :metering_mode, as: 'meteringMode' + property :rotation, as: 'rotation' + property :sensor, as: 'sensor' + property :subject_distance, as: 'subjectDistance' + property :time, as: 'time' + property :white_balance, as: 'whiteBalance' + property :width, as: 'width' + end + + class Location + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :altitude, as: 'altitude' + property :latitude, as: 'latitude' + property :longitude, as: 'longitude' + end + end + end + + class VideoMediaMetadata + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :duration_millis, as: 'durationMillis' + property :height, as: 'height' + property :width, as: 'width' + end + end + end + + class FileList + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :files, as: 'files', class: Google::Apis::DriveV3::File, decorator: Google::Apis::DriveV3::File::Representation + + property :kind, as: 'kind' + property :next_page_token, as: 'nextPageToken' + end + end + + class GeneratedIds + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :ids, as: 'ids' + property :kind, as: 'kind' + property :space, as: 'space' + end + end + + class Permission + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :allow_file_discovery, as: 'allowFileDiscovery' + property :display_name, as: 'displayName' + property :domain, as: 'domain' + property :email_address, as: 'emailAddress' + property :id, as: 'id' + property :kind, as: 'kind' + property :photo_link, as: 'photoLink' + property :role, as: 'role' + property :type, as: 'type' + end + end + + class PermissionList + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :kind, as: 'kind' + collection :permissions, as: 'permissions', class: Google::Apis::DriveV3::Permission, decorator: Google::Apis::DriveV3::Permission::Representation + + end + end + + class Reply + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :action, as: 'action' + property :author, as: 'author', class: Google::Apis::DriveV3::User, decorator: Google::Apis::DriveV3::User::Representation + + property :content, as: 'content' + property :created_time, as: 'createdTime', type: DateTime + + property :deleted, as: 'deleted' + property :html_content, as: 'htmlContent' + property :id, as: 'id' + property :kind, as: 'kind' + property :modified_time, as: 'modifiedTime', type: DateTime + + end + end + + class ReplyList + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :kind, as: 'kind' + property :next_page_token, as: 'nextPageToken' + collection :replies, as: 'replies', class: Google::Apis::DriveV3::Reply, decorator: Google::Apis::DriveV3::Reply::Representation + + end + end + + class Revision + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :id, as: 'id' + property :keep_forever, as: 'keepForever' + property :kind, as: 'kind' + property :last_modifying_user, as: 'lastModifyingUser', class: Google::Apis::DriveV3::User, decorator: Google::Apis::DriveV3::User::Representation + + property :md5_checksum, as: 'md5Checksum' + property :mime_type, as: 'mimeType' + property :modified_time, as: 'modifiedTime', type: DateTime + + property :original_filename, as: 'originalFilename' + property :publish_auto, as: 'publishAuto' + property :published, as: 'published' + property :published_outside_domain, as: 'publishedOutsideDomain' + property :size, as: 'size' + end + end + + class RevisionList + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :kind, as: 'kind' + collection :revisions, as: 'revisions', class: Google::Apis::DriveV3::Revision, decorator: Google::Apis::DriveV3::Revision::Representation + + end + end + + class StartPageToken + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :kind, as: 'kind' + property :start_page_token, as: 'startPageToken' + end + end + + class User + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :display_name, as: 'displayName' + property :email_address, as: 'emailAddress' + property :kind, as: 'kind' + property :me, as: 'me' + property :permission_id, as: 'permissionId' + property :photo_link, as: 'photoLink' + end + end + end + end +end diff --git a/generated/google/apis/drive_v3/service.rb b/generated/google/apis/drive_v3/service.rb new file mode 100644 index 000000000..d15b0284d --- /dev/null +++ b/generated/google/apis/drive_v3/service.rb @@ -0,0 +1,1541 @@ +# Copyright 2015 Google Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +require 'google/apis/core/base_service' +require 'google/apis/core/json_representation' +require 'google/apis/core/hashable' +require 'google/apis/errors' + +module Google + module Apis + module DriveV3 + # Drive API + # + # The API to interact with Drive. + # + # @example + # require 'google/apis/drive_v3' + # + # Drive = Google::Apis::DriveV3 # Alias the module + # service = Drive::DriveService.new + # + # @see https://developers.google.com/drive/ + class DriveService < Google::Apis::Core::BaseService + # @return [String] + # API key. Your API key identifies your project and provides you with API access, + # quota, and reports. Required unless you provide an OAuth 2.0 token. + attr_accessor :key + + # @return [String] + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + attr_accessor :quota_user + + # @return [String] + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + attr_accessor :user_ip + + def initialize + super('https://www.googleapis.com/', 'drive/v3/') + end + + # Gets information about the user, the user's Drive, and system capabilities. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DriveV3::About] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DriveV3::About] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_about(fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'about', options) + command.response_representation = Google::Apis::DriveV3::About::Representation + command.response_class = Google::Apis::DriveV3::About + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Gets the starting pageToken for listing future changes. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DriveV3::StartPageToken] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DriveV3::StartPageToken] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_changes_start_page_token(fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'changes/startPageToken', options) + command.response_representation = Google::Apis::DriveV3::StartPageToken::Representation + command.response_class = Google::Apis::DriveV3::StartPageToken + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Lists changes for a user. + # @param [String] page_token + # The token for continuing a previous list request on the next page. This should + # be set to the value of 'nextPageToken' from the previous response or to the + # response from the getStartPageToken method. + # @param [Boolean] include_removed + # Whether to include changes indicating that items have left the view of the + # changes list, for example by deletion or lost access. + # @param [Fixnum] page_size + # The maximum number of changes to return per page. + # @param [Boolean] restrict_to_my_drive + # Whether to restrict the results to changes inside the My Drive hierarchy. This + # omits changes to files such as those in the Application Data folder or shared + # files which have not been added to My Drive. + # @param [String] spaces + # A comma-separated list of spaces to query within the user corpus. Supported + # values are 'drive', 'appDataFolder' and 'photos'. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DriveV3::ChangeList] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DriveV3::ChangeList] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_changes(page_token, include_removed: nil, page_size: nil, restrict_to_my_drive: nil, spaces: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'changes', options) + command.response_representation = Google::Apis::DriveV3::ChangeList::Representation + command.response_class = Google::Apis::DriveV3::ChangeList + command.query['includeRemoved'] = include_removed unless include_removed.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['restrictToMyDrive'] = restrict_to_my_drive unless restrict_to_my_drive.nil? + command.query['spaces'] = spaces unless spaces.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Subscribes to changes for a user. + # @param [String] page_token + # The token for continuing a previous list request on the next page. This should + # be set to the value of 'nextPageToken' from the previous response or to the + # response from the getStartPageToken method. + # @param [Google::Apis::DriveV3::Channel] channel_object + # @param [Boolean] include_removed + # Whether to include changes indicating that items have left the view of the + # changes list, for example by deletion or lost access. + # @param [Fixnum] page_size + # The maximum number of changes to return per page. + # @param [Boolean] restrict_to_my_drive + # Whether to restrict the results to changes inside the My Drive hierarchy. This + # omits changes to files such as those in the Application Data folder or shared + # files which have not been added to My Drive. + # @param [String] spaces + # A comma-separated list of spaces to query within the user corpus. Supported + # values are 'drive', 'appDataFolder' and 'photos'. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DriveV3::Channel] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DriveV3::Channel] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def watch_change(page_token, channel_object = nil, include_removed: nil, page_size: nil, restrict_to_my_drive: nil, spaces: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, 'changes/watch', options) + command.request_representation = Google::Apis::DriveV3::Channel::Representation + command.request_object = channel_object + command.response_representation = Google::Apis::DriveV3::Channel::Representation + command.response_class = Google::Apis::DriveV3::Channel + command.query['includeRemoved'] = include_removed unless include_removed.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['restrictToMyDrive'] = restrict_to_my_drive unless restrict_to_my_drive.nil? + command.query['spaces'] = spaces unless spaces.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Stop watching resources through this channel + # @param [Google::Apis::DriveV3::Channel] channel_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [NilClass] No result returned for this method + # @yieldparam err [StandardError] error object if request failed + # + # @return [void] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def stop_channel(channel_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, 'channels/stop', options) + command.request_representation = Google::Apis::DriveV3::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 + + # Creates a new comment on a file. + # @param [String] file_id + # The ID of the file. + # @param [Google::Apis::DriveV3::Comment] comment_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DriveV3::Comment] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DriveV3::Comment] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def create_comment(file_id, comment_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, 'files/{fileId}/comments', options) + command.request_representation = Google::Apis::DriveV3::Comment::Representation + command.request_object = comment_object + command.response_representation = Google::Apis::DriveV3::Comment::Representation + command.response_class = Google::Apis::DriveV3::Comment + command.params['fileId'] = file_id unless file_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Deletes a comment. + # @param [String] file_id + # The ID of the file. + # @param [String] comment_id + # The ID of the comment. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [NilClass] No result returned for this method + # @yieldparam err [StandardError] error object if request failed + # + # @return [void] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_comment(file_id, comment_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:delete, 'files/{fileId}/comments/{commentId}', options) + command.params['fileId'] = file_id unless file_id.nil? + command.params['commentId'] = comment_id unless comment_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Gets a comment by ID. + # @param [String] file_id + # The ID of the file. + # @param [String] comment_id + # The ID of the comment. + # @param [Boolean] include_deleted + # Whether to return deleted comments. Deleted comments will not include their + # original content. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DriveV3::Comment] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DriveV3::Comment] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_comment(file_id, comment_id, include_deleted: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'files/{fileId}/comments/{commentId}', options) + command.response_representation = Google::Apis::DriveV3::Comment::Representation + command.response_class = Google::Apis::DriveV3::Comment + command.params['fileId'] = file_id unless file_id.nil? + command.params['commentId'] = comment_id unless comment_id.nil? + command.query['includeDeleted'] = include_deleted unless include_deleted.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Lists a file's comments. + # @param [String] file_id + # The ID of the file. + # @param [Boolean] include_deleted + # Whether to include deleted comments. Deleted comments will not include their + # original content. + # @param [Fixnum] page_size + # The maximum number of comments to return per page. + # @param [String] page_token + # The token for continuing a previous list request on the next page. This should + # be set to the value of 'nextPageToken' from the previous response. + # @param [String] start_modified_time + # The minimum value of 'modifiedTime' for the result comments (RFC 3339 date- + # time). + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DriveV3::CommentList] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DriveV3::CommentList] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_comments(file_id, include_deleted: nil, page_size: nil, page_token: nil, start_modified_time: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'files/{fileId}/comments', options) + command.response_representation = Google::Apis::DriveV3::CommentList::Representation + command.response_class = Google::Apis::DriveV3::CommentList + command.params['fileId'] = file_id unless file_id.nil? + command.query['includeDeleted'] = include_deleted unless include_deleted.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['startModifiedTime'] = start_modified_time unless start_modified_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 + + # Updates a comment with patch semantics. + # @param [String] file_id + # The ID of the file. + # @param [String] comment_id + # The ID of the comment. + # @param [Google::Apis::DriveV3::Comment] comment_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DriveV3::Comment] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DriveV3::Comment] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def update_comment(file_id, comment_id, comment_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:patch, 'files/{fileId}/comments/{commentId}', options) + command.request_representation = Google::Apis::DriveV3::Comment::Representation + command.request_object = comment_object + command.response_representation = Google::Apis::DriveV3::Comment::Representation + command.response_class = Google::Apis::DriveV3::Comment + command.params['fileId'] = file_id unless file_id.nil? + command.params['commentId'] = comment_id unless comment_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Creates a copy of a file and applies any requested updates with patch + # semantics. + # @param [String] file_id + # The ID of the file. + # @param [Google::Apis::DriveV3::File] file_object + # @param [Boolean] ignore_default_visibility + # Whether to ignore the domain's default visibility settings for the created + # file. Domain administrators can choose to make all uploaded files visible to + # the domain by default; this parameter bypasses that behavior for the request. + # Permissions are still inherited from parent folders. + # @param [Boolean] keep_revision_forever + # Whether to set the 'keepForever' field in the new head revision. This is only + # applicable to files with binary content in Drive. + # @param [String] ocr_language + # A language hint for OCR processing during image import (ISO 639-1 code). + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DriveV3::File] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DriveV3::File] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def copy_file(file_id, file_object = nil, ignore_default_visibility: nil, keep_revision_forever: nil, ocr_language: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, 'files/{fileId}/copy', options) + command.request_representation = Google::Apis::DriveV3::File::Representation + command.request_object = file_object + command.response_representation = Google::Apis::DriveV3::File::Representation + command.response_class = Google::Apis::DriveV3::File + command.params['fileId'] = file_id unless file_id.nil? + command.query['ignoreDefaultVisibility'] = ignore_default_visibility unless ignore_default_visibility.nil? + command.query['keepRevisionForever'] = keep_revision_forever unless keep_revision_forever.nil? + command.query['ocrLanguage'] = ocr_language unless ocr_language.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Creates a new file. + # @param [Google::Apis::DriveV3::File] file_object + # @param [Boolean] ignore_default_visibility + # Whether to ignore the domain's default visibility settings for the created + # file. Domain administrators can choose to make all uploaded files visible to + # the domain by default; this parameter bypasses that behavior for the request. + # Permissions are still inherited from parent folders. + # @param [Boolean] keep_revision_forever + # Whether to set the 'keepForever' field in the new head revision. This is only + # applicable to files with binary content in Drive. + # @param [String] ocr_language + # A language hint for OCR processing during image import (ISO 639-1 code). + # @param [Boolean] use_content_as_indexable_text + # Whether to use the uploaded content as indexable text. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [IO, String] upload_source + # IO stream or filename containing content to upload + # @param [String] content_type + # Content type of the uploaded content. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DriveV3::File] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DriveV3::File] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def create_file(file_object = nil, ignore_default_visibility: nil, keep_revision_forever: nil, ocr_language: nil, use_content_as_indexable_text: nil, fields: nil, quota_user: nil, user_ip: nil, upload_source: nil, content_type: nil, options: nil, &block) + if upload_source.nil? + command = make_simple_command(:post, 'files', options) + else + command = make_upload_command(:post, 'files', options) + command.upload_source = upload_source + command.upload_content_type = content_type + end + command.request_representation = Google::Apis::DriveV3::File::Representation + command.request_object = file_object + command.response_representation = Google::Apis::DriveV3::File::Representation + command.response_class = Google::Apis::DriveV3::File + command.query['ignoreDefaultVisibility'] = ignore_default_visibility unless ignore_default_visibility.nil? + command.query['keepRevisionForever'] = keep_revision_forever unless keep_revision_forever.nil? + command.query['ocrLanguage'] = ocr_language unless ocr_language.nil? + command.query['useContentAsIndexableText'] = use_content_as_indexable_text unless use_content_as_indexable_text.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Permanently deletes a file owned by the user without moving it to the trash. + # If the target is a folder, all descendants owned by the user are also deleted. + # @param [String] file_id + # The ID of the file. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [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_file(file_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:delete, 'files/{fileId}', options) + command.params['fileId'] = file_id unless file_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Permanently deletes all of the user's trashed files. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [NilClass] No result returned for this method + # @yieldparam err [StandardError] error object if request failed + # + # @return [void] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def empty_file_trash(fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:delete, 'files/trash', options) + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Exports a Google Doc to the requested MIME type. + # @param [String] file_id + # The ID of the file. + # @param [String] mime_type + # The MIME type of the format requested for this export. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [IO, String] download_dest + # IO stream or filename to receive content download + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [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 export_file(file_id, mime_type, fields: nil, quota_user: nil, user_ip: nil, download_dest: nil, options: nil, &block) + if download_dest.nil? + command = make_simple_command(:get, 'files/{fileId}/export', options) + else + command = make_download_command(:get, 'files/{fileId}/export', options) + command.download_dest = download_dest + end + command.params['fileId'] = file_id unless file_id.nil? + command.query['mimeType'] = mime_type unless mime_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 + + # Generates a set of file IDs which can be provided in create requests. + # @param [Fixnum] count + # The number of IDs to return. + # @param [String] space + # The space in which the IDs can be used to create new files. Supported values + # are 'drive' and 'appDataFolder'. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DriveV3::GeneratedIds] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DriveV3::GeneratedIds] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_file_ids(count: nil, space: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'files/generateIds', options) + command.response_representation = Google::Apis::DriveV3::GeneratedIds::Representation + command.response_class = Google::Apis::DriveV3::GeneratedIds + command.query['count'] = count unless count.nil? + command.query['space'] = space unless space.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Gets a file's metadata or content by ID. + # @param [String] file_id + # The ID of the file. + # @param [Boolean] acknowledge_abuse + # Whether the user is acknowledging the risk of downloading known malware or + # other abusive files. This is only applicable when alt=media. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [IO, String] download_dest + # IO stream or filename to receive content download + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DriveV3::File] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DriveV3::File] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_file(file_id, acknowledge_abuse: nil, fields: nil, quota_user: nil, user_ip: nil, download_dest: nil, options: nil, &block) + if download_dest.nil? + command = make_simple_command(:get, 'files/{fileId}', options) + else + command = make_download_command(:get, 'files/{fileId}', options) + command.download_dest = download_dest + end + command.response_representation = Google::Apis::DriveV3::File::Representation + command.response_class = Google::Apis::DriveV3::File + command.params['fileId'] = file_id unless file_id.nil? + command.query['acknowledgeAbuse'] = acknowledge_abuse unless acknowledge_abuse.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Lists or searches files. + # @param [String] corpus + # The source of files to list. + # @param [String] order_by + # A comma-separated list of sort keys. Valid keys are 'createdTime', 'folder', ' + # modifiedByMeTime', 'modifiedTime', 'name', 'quotaBytesUsed', 'recency', ' + # sharedWithMeTime', 'starred', and 'viewedByMeTime'. Each key sorts ascending + # by default, but may be reversed with the 'desc' modifier. Example usage: ? + # orderBy=folder,modifiedTime desc,name. Please note that there is a current + # limitation for users with approximately one million files in which the + # requested sort order is ignored. + # @param [Fixnum] page_size + # The maximum number of files to return per page. + # @param [String] page_token + # The token for continuing a previous list request on the next page. This should + # be set to the value of 'nextPageToken' from the previous response. + # @param [String] q + # A query for filtering the file results. See the "Search for Files" guide for + # supported syntax. + # @param [String] spaces + # A comma-separated list of spaces to query within the corpus. Supported values + # are 'drive', 'appDataFolder' and 'photos'. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DriveV3::FileList] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DriveV3::FileList] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_files(corpus: nil, order_by: nil, page_size: nil, page_token: nil, q: nil, spaces: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'files', options) + command.response_representation = Google::Apis::DriveV3::FileList::Representation + command.response_class = Google::Apis::DriveV3::FileList + command.query['corpus'] = corpus unless corpus.nil? + command.query['orderBy'] = order_by unless order_by.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['q'] = q unless q.nil? + command.query['spaces'] = spaces unless spaces.nil? + command.query['fields'] = fields unless fields.nil? + command.query['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 file's metadata and/or content with patch semantics. + # @param [String] file_id + # The ID of the file. + # @param [Google::Apis::DriveV3::File] file_object + # @param [String] add_parents + # A comma-separated list of parent IDs to add. + # @param [Boolean] keep_revision_forever + # Whether to set the 'keepForever' field in the new head revision. This is only + # applicable to files with binary content in Drive. + # @param [String] ocr_language + # A language hint for OCR processing during image import (ISO 639-1 code). + # @param [String] remove_parents + # A comma-separated list of parent IDs to remove. + # @param [Boolean] use_content_as_indexable_text + # Whether to use the uploaded content as indexable text. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [IO, String] upload_source + # IO stream or filename containing content to upload + # @param [String] content_type + # Content type of the uploaded content. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DriveV3::File] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DriveV3::File] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def update_file(file_id, file_object = nil, add_parents: nil, keep_revision_forever: nil, ocr_language: nil, remove_parents: nil, use_content_as_indexable_text: nil, fields: nil, quota_user: nil, user_ip: nil, upload_source: nil, content_type: nil, options: nil, &block) + if upload_source.nil? + command = make_simple_command(:patch, 'files/{fileId}', options) + else + command = make_upload_command(:patch, 'files/{fileId}', options) + command.upload_source = upload_source + command.upload_content_type = content_type + end + command.request_representation = Google::Apis::DriveV3::File::Representation + command.request_object = file_object + command.response_representation = Google::Apis::DriveV3::File::Representation + command.response_class = Google::Apis::DriveV3::File + command.params['fileId'] = file_id unless file_id.nil? + command.query['addParents'] = add_parents unless add_parents.nil? + command.query['keepRevisionForever'] = keep_revision_forever unless keep_revision_forever.nil? + command.query['ocrLanguage'] = ocr_language unless ocr_language.nil? + command.query['removeParents'] = remove_parents unless remove_parents.nil? + command.query['useContentAsIndexableText'] = use_content_as_indexable_text unless use_content_as_indexable_text.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Subscribes to changes to a file + # @param [String] file_id + # The ID of the file. + # @param [Google::Apis::DriveV3::Channel] channel_object + # @param [Boolean] acknowledge_abuse + # Whether the user is acknowledging the risk of downloading known malware or + # other abusive files. This is only applicable when alt=media. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [IO, String] download_dest + # IO stream or filename to receive content download + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DriveV3::Channel] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DriveV3::Channel] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def watch_file(file_id, channel_object = nil, acknowledge_abuse: nil, fields: nil, quota_user: nil, user_ip: nil, download_dest: nil, options: nil, &block) + if download_dest.nil? + command = make_simple_command(:post, 'files/{fileId}/watch', options) + else + command = make_download_command(:post, 'files/{fileId}/watch', options) + command.download_dest = download_dest + end + command.request_representation = Google::Apis::DriveV3::Channel::Representation + command.request_object = channel_object + command.response_representation = Google::Apis::DriveV3::Channel::Representation + command.response_class = Google::Apis::DriveV3::Channel + command.params['fileId'] = file_id unless file_id.nil? + command.query['acknowledgeAbuse'] = acknowledge_abuse unless acknowledge_abuse.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Creates a permission for a file. + # @param [String] file_id + # The ID of the file. + # @param [Google::Apis::DriveV3::Permission] permission_object + # @param [String] email_message + # A custom message to include in the notification email. + # @param [Boolean] send_notification_email + # Whether to send a notification email when sharing to users or groups. This + # defaults to true for users and groups, and is not allowed for other requests. + # It must not be disabled for ownership transfers. + # @param [Boolean] transfer_ownership + # Whether to transfer ownership to the specified user and downgrade the current + # owner to a writer. This parameter is required as an acknowledgement of the + # side effect. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DriveV3::Permission] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DriveV3::Permission] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def create_permission(file_id, permission_object = nil, email_message: nil, send_notification_email: nil, transfer_ownership: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, 'files/{fileId}/permissions', options) + command.request_representation = Google::Apis::DriveV3::Permission::Representation + command.request_object = permission_object + command.response_representation = Google::Apis::DriveV3::Permission::Representation + command.response_class = Google::Apis::DriveV3::Permission + command.params['fileId'] = file_id unless file_id.nil? + command.query['emailMessage'] = email_message unless email_message.nil? + command.query['sendNotificationEmail'] = send_notification_email unless send_notification_email.nil? + command.query['transferOwnership'] = transfer_ownership unless transfer_ownership.nil? + command.query['fields'] = fields unless fields.nil? + command.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 permission. + # @param [String] file_id + # The ID of the file. + # @param [String] permission_id + # The ID of the permission. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [NilClass] No result returned for this method + # @yieldparam err [StandardError] error object if request failed + # + # @return [void] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_permission(file_id, permission_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:delete, 'files/{fileId}/permissions/{permissionId}', options) + command.params['fileId'] = file_id unless file_id.nil? + command.params['permissionId'] = permission_id unless permission_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Gets a permission by ID. + # @param [String] file_id + # The ID of the file. + # @param [String] permission_id + # The ID of the permission. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DriveV3::Permission] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DriveV3::Permission] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_permission(file_id, permission_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'files/{fileId}/permissions/{permissionId}', options) + command.response_representation = Google::Apis::DriveV3::Permission::Representation + command.response_class = Google::Apis::DriveV3::Permission + command.params['fileId'] = file_id unless file_id.nil? + command.params['permissionId'] = permission_id unless permission_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Lists a file's permissions. + # @param [String] file_id + # The ID of the file. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DriveV3::PermissionList] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DriveV3::PermissionList] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_permissions(file_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'files/{fileId}/permissions', options) + command.response_representation = Google::Apis::DriveV3::PermissionList::Representation + command.response_class = Google::Apis::DriveV3::PermissionList + command.params['fileId'] = file_id unless file_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Updates a permission with patch semantics. + # @param [String] file_id + # The ID of the file. + # @param [String] permission_id + # The ID of the permission. + # @param [Google::Apis::DriveV3::Permission] permission_object + # @param [Boolean] transfer_ownership + # Whether to transfer ownership to the specified user and downgrade the current + # owner to a writer. This parameter is required as an acknowledgement of the + # side effect. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DriveV3::Permission] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DriveV3::Permission] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def update_permission(file_id, permission_id, permission_object = nil, transfer_ownership: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:patch, 'files/{fileId}/permissions/{permissionId}', options) + command.request_representation = Google::Apis::DriveV3::Permission::Representation + command.request_object = permission_object + command.response_representation = Google::Apis::DriveV3::Permission::Representation + command.response_class = Google::Apis::DriveV3::Permission + command.params['fileId'] = file_id unless file_id.nil? + command.params['permissionId'] = permission_id unless permission_id.nil? + command.query['transferOwnership'] = transfer_ownership unless transfer_ownership.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Creates a new reply to a comment. + # @param [String] file_id + # The ID of the file. + # @param [String] comment_id + # The ID of the comment. + # @param [Google::Apis::DriveV3::Reply] reply_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DriveV3::Reply] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DriveV3::Reply] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def create_reply(file_id, comment_id, reply_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, 'files/{fileId}/comments/{commentId}/replies', options) + command.request_representation = Google::Apis::DriveV3::Reply::Representation + command.request_object = reply_object + command.response_representation = Google::Apis::DriveV3::Reply::Representation + command.response_class = Google::Apis::DriveV3::Reply + command.params['fileId'] = file_id unless file_id.nil? + command.params['commentId'] = comment_id unless comment_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Deletes a reply. + # @param [String] file_id + # The ID of the file. + # @param [String] comment_id + # The ID of the comment. + # @param [String] reply_id + # The ID of the reply. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [NilClass] No result returned for this method + # @yieldparam err [StandardError] error object if request failed + # + # @return [void] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_reply(file_id, comment_id, reply_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:delete, 'files/{fileId}/comments/{commentId}/replies/{replyId}', options) + command.params['fileId'] = file_id unless file_id.nil? + command.params['commentId'] = comment_id unless comment_id.nil? + command.params['replyId'] = reply_id unless reply_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Gets a reply by ID. + # @param [String] file_id + # The ID of the file. + # @param [String] comment_id + # The ID of the comment. + # @param [String] reply_id + # The ID of the reply. + # @param [Boolean] include_deleted + # Whether to return deleted replies. Deleted replies will not include their + # original content. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DriveV3::Reply] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DriveV3::Reply] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_reply(file_id, comment_id, reply_id, include_deleted: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'files/{fileId}/comments/{commentId}/replies/{replyId}', options) + command.response_representation = Google::Apis::DriveV3::Reply::Representation + command.response_class = Google::Apis::DriveV3::Reply + command.params['fileId'] = file_id unless file_id.nil? + command.params['commentId'] = comment_id unless comment_id.nil? + command.params['replyId'] = reply_id unless reply_id.nil? + command.query['includeDeleted'] = include_deleted unless include_deleted.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Lists a comment's replies. + # @param [String] file_id + # The ID of the file. + # @param [String] comment_id + # The ID of the comment. + # @param [Boolean] include_deleted + # Whether to include deleted replies. Deleted replies will not include their + # original content. + # @param [Fixnum] page_size + # The maximum number of replies to return per page. + # @param [String] page_token + # The token for continuing a previous list request on the next page. This should + # be set to the value of 'nextPageToken' from the previous response. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DriveV3::ReplyList] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DriveV3::ReplyList] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_replies(file_id, comment_id, include_deleted: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'files/{fileId}/comments/{commentId}/replies', options) + command.response_representation = Google::Apis::DriveV3::ReplyList::Representation + command.response_class = Google::Apis::DriveV3::ReplyList + command.params['fileId'] = file_id unless file_id.nil? + command.params['commentId'] = comment_id unless comment_id.nil? + command.query['includeDeleted'] = include_deleted unless include_deleted.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Updates a reply with patch semantics. + # @param [String] file_id + # The ID of the file. + # @param [String] comment_id + # The ID of the comment. + # @param [String] reply_id + # The ID of the reply. + # @param [Google::Apis::DriveV3::Reply] reply_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DriveV3::Reply] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DriveV3::Reply] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_reply(file_id, comment_id, reply_id, reply_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:patch, 'files/{fileId}/comments/{commentId}/replies/{replyId}', options) + command.request_representation = Google::Apis::DriveV3::Reply::Representation + command.request_object = reply_object + command.response_representation = Google::Apis::DriveV3::Reply::Representation + command.response_class = Google::Apis::DriveV3::Reply + command.params['fileId'] = file_id unless file_id.nil? + command.params['commentId'] = comment_id unless comment_id.nil? + command.params['replyId'] = reply_id unless reply_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Permanently deletes a revision. This method is only applicable to files with + # binary content in Drive. + # @param [String] file_id + # The ID of the file. + # @param [String] revision_id + # The ID of the revision. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [NilClass] No result returned for this method + # @yieldparam err [StandardError] error object if request failed + # + # @return [void] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_revision(file_id, revision_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:delete, 'files/{fileId}/revisions/{revisionId}', options) + command.params['fileId'] = file_id unless file_id.nil? + command.params['revisionId'] = revision_id unless revision_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Gets a revision's metadata or content by ID. + # @param [String] file_id + # The ID of the file. + # @param [String] revision_id + # The ID of the revision. + # @param [Boolean] acknowledge_abuse + # Whether the user is acknowledging the risk of downloading known malware or + # other abusive files. This is only applicable when alt=media. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [IO, String] download_dest + # IO stream or filename to receive content download + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DriveV3::Revision] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DriveV3::Revision] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_revision(file_id, revision_id, acknowledge_abuse: nil, fields: nil, quota_user: nil, user_ip: nil, download_dest: nil, options: nil, &block) + if download_dest.nil? + command = make_simple_command(:get, 'files/{fileId}/revisions/{revisionId}', options) + else + command = make_download_command(:get, 'files/{fileId}/revisions/{revisionId}', options) + command.download_dest = download_dest + end + command.response_representation = Google::Apis::DriveV3::Revision::Representation + command.response_class = Google::Apis::DriveV3::Revision + command.params['fileId'] = file_id unless file_id.nil? + command.params['revisionId'] = revision_id unless revision_id.nil? + command.query['acknowledgeAbuse'] = acknowledge_abuse unless acknowledge_abuse.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Lists a file's revisions. + # @param [String] file_id + # The ID of the file. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DriveV3::RevisionList] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DriveV3::RevisionList] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_revisions(file_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'files/{fileId}/revisions', options) + command.response_representation = Google::Apis::DriveV3::RevisionList::Representation + command.response_class = Google::Apis::DriveV3::RevisionList + command.params['fileId'] = file_id unless file_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Updates a revision with patch semantics. + # @param [String] file_id + # The ID of the file. + # @param [String] revision_id + # The ID of the revision. + # @param [Google::Apis::DriveV3::Revision] revision_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DriveV3::Revision] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DriveV3::Revision] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_revision(file_id, revision_id, revision_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:patch, 'files/{fileId}/revisions/{revisionId}', options) + command.request_representation = Google::Apis::DriveV3::Revision::Representation + command.request_object = revision_object + command.response_representation = Google::Apis::DriveV3::Revision::Representation + command.response_class = Google::Apis::DriveV3::Revision + command.params['fileId'] = file_id unless file_id.nil? + command.params['revisionId'] = revision_id unless revision_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + protected + + def apply_command_defaults(command) + command.query['key'] = key unless key.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + end + end + end + end +end diff --git a/generated/google/apis/games_configuration_v1configuration.rb b/generated/google/apis/games_configuration_v1configuration.rb index e9b1a51a1..2ec0b5f92 100644 --- a/generated/google/apis/games_configuration_v1configuration.rb +++ b/generated/google/apis/games_configuration_v1configuration.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/games/services module GamesConfigurationV1configuration VERSION = 'V1configuration' - REVISION = '20151125' + REVISION = '20151202' # View and manage your Google Play Developer account AUTH_ANDROIDPUBLISHER = 'https://www.googleapis.com/auth/androidpublisher' diff --git a/generated/google/apis/games_management_v1management.rb b/generated/google/apis/games_management_v1management.rb index 01378c2c5..84b5f3a6d 100644 --- a/generated/google/apis/games_management_v1management.rb +++ b/generated/google/apis/games_management_v1management.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/games/services module GamesManagementV1management VERSION = 'V1management' - REVISION = '20151125' + REVISION = '20151202' # Share your Google+ profile information and view and manage your game activity AUTH_GAMES = 'https://www.googleapis.com/auth/games' diff --git a/generated/google/apis/games_v1.rb b/generated/google/apis/games_v1.rb index 6160819e7..db9d51232 100644 --- a/generated/google/apis/games_v1.rb +++ b/generated/google/apis/games_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/games/services/ module GamesV1 VERSION = 'V1' - REVISION = '20151125' + REVISION = '20151202' # View and manage its own configuration data in your Google Drive AUTH_DRIVE_APPDATA = 'https://www.googleapis.com/auth/drive.appdata' diff --git a/generated/google/apis/games_v1/classes.rb b/generated/google/apis/games_v1/classes.rb index 7d751fe96..59383b945 100644 --- a/generated/google/apis/games_v1/classes.rb +++ b/generated/google/apis/games_v1/classes.rb @@ -645,6 +645,33 @@ module Google end end + # This is a JSON template for a third party application verification response + # resource. + class ApplicationVerifyResponse + include Google::Apis::Core::Hashable + + # Uniquely identifies the type of this resource. Value is always the fixed + # string games#applicationVerifyResponse. + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # The ID of the player that was issued the auth token used in this request. + # Corresponds to the JSON property `player_id` + # @return [String] + attr_accessor :player_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @kind = args[:kind] unless args[:kind].nil? + @player_id = args[:player_id] unless args[:player_id].nil? + end + end + # This is a JSON template for data related to individual game categories. class Category include Google::Apis::Core::Hashable diff --git a/generated/google/apis/games_v1/representations.rb b/generated/google/apis/games_v1/representations.rb index 6d7643d3c..ef7739895 100644 --- a/generated/google/apis/games_v1/representations.rb +++ b/generated/google/apis/games_v1/representations.rb @@ -78,6 +78,10 @@ module Google class Representation < Google::Apis::Core::JsonRepresentation; end end + class ApplicationVerifyResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + end + class Category class Representation < Google::Apis::Core::JsonRepresentation; end end @@ -571,6 +575,14 @@ module Google end end + class ApplicationVerifyResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :kind, as: 'kind' + property :player_id, as: 'player_id' + end + end + class Category # @private class Representation < Google::Apis::Core::JsonRepresentation diff --git a/generated/google/apis/games_v1/service.rb b/generated/google/apis/games_v1/service.rb index 7afc99db6..4d58c33b7 100644 --- a/generated/google/apis/games_v1/service.rb +++ b/generated/google/apis/games_v1/service.rb @@ -411,6 +411,42 @@ module Google execute_or_queue_command(command, &block) end + # Verifies the auth token provided with this request is for the application with + # the specified ID, and returns the ID of the player it was granted for. + # @param [String] application_id + # The application ID from the Google Play developer console. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::GamesV1::ApplicationVerifyResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::GamesV1::ApplicationVerifyResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def verify_application(application_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'applications/{applicationId}/verify', options) + command.response_representation = Google::Apis::GamesV1::ApplicationVerifyResponse::Representation + command.response_class = Google::Apis::GamesV1::ApplicationVerifyResponse + command.params['applicationId'] = application_id unless application_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + # Returns a list showing the current progress on events in this application for # the currently authenticated user. # @param [String] language diff --git a/generated/google/apis/genomics_v1.rb b/generated/google/apis/genomics_v1.rb index 2b143a7a2..ec8055531 100644 --- a/generated/google/apis/genomics_v1.rb +++ b/generated/google/apis/genomics_v1.rb @@ -20,13 +20,15 @@ module Google module Apis # Genomics API # - # An API to store, process, explore, and share DNA sequence reads, reference- - # based alignments, and variant calls. + # An API to store, process, explore, and share genomic data. It supports + # reference-based alignements, genetic variants, and reference genomes. This API + # provides an implementation of the Global Alliance for Genomics and Health ( + # GA4GH) v0.5.1 API as well as several extensions. # # @see module GenomicsV1 VERSION = 'V1' - REVISION = '20151130' + REVISION = '20151210' # View and manage your data in Google BigQuery AUTH_BIGQUERY = 'https://www.googleapis.com/auth/bigquery' diff --git a/generated/google/apis/genomics_v1/classes.rb b/generated/google/apis/genomics_v1/classes.rb index 635ad21b1..d7fecfe0a 100644 --- a/generated/google/apis/genomics_v1/classes.rb +++ b/generated/google/apis/genomics_v1/classes.rb @@ -520,7 +520,8 @@ module Google class ExportReadGroupSetRequest include Google::Apis::Core::Hashable - # Required. The Google Developers Console project ID that owns this export. + # Required. The Google Developers Console project ID that owns this export. The + # caller must have WRITE access to this project. # Corresponds to the JSON property `projectId` # @return [String] attr_accessor :project_id @@ -574,8 +575,8 @@ module Google # @return [String] attr_accessor :page_token - # Specifies number of results to return in a single page. If unspecified, it - # will default to 256. The maximum value is 1024. + # The maximum number of results to return in a single page. If unspecified, + # defaults to 256. The maximum value is 1024. # Corresponds to the JSON property `pageSize` # @return [Fixnum] attr_accessor :page_size @@ -635,12 +636,12 @@ module Google # @return [String] attr_accessor :id - # The dataset ID. + # The dataset to which this read group set belongs. # Corresponds to the JSON property `datasetId` # @return [String] attr_accessor :dataset_id - # The reference set the reads in this read group set are aligned to. + # The reference set to which the reads in this read group set are aligned. # Corresponds to the JSON property `referenceSetId` # @return [String] attr_accessor :reference_set_id @@ -688,13 +689,12 @@ module Google include Google::Apis::Core::Hashable # The server-generated read group ID, unique for all read groups. Note: This is - # different than the `@RG ID` field in the SAM spec. For that value, see the ` - # name` field. + # different than the @RG ID field in the SAM spec. For that value, see name. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id - # The ID of the dataset this read group belongs to. + # The dataset to which this read group belongs. # Corresponds to the JSON property `datasetId` # @return [String] attr_accessor :dataset_id @@ -709,9 +709,7 @@ module Google # @return [String] attr_accessor :description - # The sample this read group's data was generated from. Note: This is not an - # actual ID within this repository, but rather an identifier for a sample which - # may be meaningful to some external system. + # A client-supplied sample identifier for the reads in this read group. # Corresponds to the JSON property `sampleId` # @return [String] attr_accessor :sample_id @@ -734,8 +732,7 @@ module Google # @return [Array] attr_accessor :programs - # The reference set the reads in this read group are aligned to. Required if - # there are any read alignments. + # The reference set the reads in this read group are aligned to. # Corresponds to the JSON property `referenceSetId` # @return [String] attr_accessor :reference_set_id @@ -769,16 +766,17 @@ module Google class Experiment include Google::Apis::Core::Hashable - # The library used as part of this experiment. Note: This is not an actual ID - # within this repository, but rather an identifier for a library which may be - # meaningful to some external system. + # A client-supplied library identifier; a library is a collection of DNA + # fragments which have been prepared for sequencing from a sample. This field is + # important for quality control as error or bias can be introduced during sample + # preparation. # Corresponds to the JSON property `libraryId` # @return [String] attr_accessor :library_id - # The platform unit used as part of this experiment e.g. flowcell-barcode.lane - # for Illumina or slide for SOLiD. Corresponds to the @RG PU field in the SAM - # spec. + # The platform unit used as part of this experiment, for example flowcell- + # barcode.lane for Illumina or slide for SOLiD. Corresponds to the @RG PU field + # in the SAM spec. # Corresponds to the JSON property `platformUnit` # @return [String] attr_accessor :platform_unit @@ -789,7 +787,7 @@ module Google attr_accessor :sequencing_center # The instrument model used as part of this experiment. This maps to sequencing - # technology in BAM. + # technology in the SAM spec. # Corresponds to the JSON property `instrumentModel` # @return [String] attr_accessor :instrument_model @@ -822,7 +820,8 @@ module Google # @return [String] attr_accessor :id - # The name of the program. + # The display name of the program. This is typically the colloquial name of the + # tool used, for example 'bwa' or 'picard'. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -967,8 +966,9 @@ module Google # @return [Array] attr_accessor :read_group_ids - # The reference sequence name, for example `chr1`, `1`, or `chrX`. If set to *, - # only unmapped reads are returned. + # The reference sequence name, for example `chr1`, `1`, or `chrX`. If set to `*`, + # only unmapped reads are returned. If unspecified, all reads (mapped and + # unmapped) are returned. # Corresponds to the JSON property `referenceName` # @return [String] attr_accessor :reference_name @@ -992,8 +992,8 @@ module Google # @return [String] attr_accessor :page_token - # Specifies number of results to return in a single page. If unspecified, it - # will default to 256. The maximum value is 2048. + # The maximum number of results to return in a single page. If unspecified, + # defaults to 256. The maximum value is 2048. # Corresponds to the JSON property `pageSize` # @return [Fixnum] attr_accessor :page_size @@ -1050,12 +1050,25 @@ module Google # read is equivalent to a line in a SAM file. A read belongs to exactly one read # group and exactly one read group set. For more genomics resource definitions, # see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/ - # fundamentals-of-google-genomics) ### Generating a reference-aligned sequence - # string When interacting with mapped reads, it's often useful to produce a - # string representing the local alignment of the read to reference. The - # following pseudocode demonstrates one way of doing this: out = "" offset = 0 - # for c in read.alignment.cigar ` switch c.operation ` case "ALIGNMENT_MATCH", " - # SEQUENCE_MATCH", "SEQUENCE_MISMATCH": out += read.alignedSequence[offset: + # fundamentals-of-google-genomics) ### Reverse-stranded reads Mapped reads ( + # reads having a non-null `alignment`) can be aligned to either the forward or + # the reverse strand of their associated reference. Strandedness of a mapped + # read is encoded by `alignment.position.reverseStrand`. If we consider the + # reference to be a forward-stranded coordinate space of `[0, reference.length)` + # with `0` as the left-most position and `reference.length` as the right-most + # position, reads are always aligned left to right. That is, `alignment.position. + # position` always refers to the left-most reference coordinate and `alignment. + # cigar` describes the alignment of this read to the reference from left to + # right. All per-base fields such as `alignedSequence` and `alignedQuality` + # share this same left-to-right orientation; this is true of reads which are + # aligned to either strand. For reverse-stranded reads, this means that ` + # alignedSequence` is the reverse complement of the bases that were originally + # reported by the sequencing machine. ### Generating a reference-aligned + # sequence string When interacting with mapped reads, it's often useful to + # produce a string representing the local alignment of the read to reference. + # The following pseudocode demonstrates one way of doing this: out = "" offset = + # 0 for c in read.alignment.cigar ` switch c.operation ` case "ALIGNMENT_MATCH", + # "SEQUENCE_MATCH", "SEQUENCE_MISMATCH": out += read.alignedSequence[offset: # offset+c.operationLength] offset += c.operationLength break case "CLIP_SOFT", " # INSERT": offset += c.operationLength break case "PAD": out += repeat("*", c. # operationLength) break case "DELETE": out += repeat("-", c.operationLength) @@ -1076,14 +1089,15 @@ module Google # @return [String] attr_accessor :id - # The ID of the read group this read belongs to. (Every read must belong to - # exactly one read group.) + # The ID of the read group this read belongs to. A read belongs to exactly one + # read group. This is a server-generated ID which is distinct from SAM's RG tag ( + # for that value, see ReadGroup.name). # Corresponds to the JSON property `readGroupId` # @return [String] attr_accessor :read_group_id - # The ID of the read group set this read belongs to. (Every read must belong to - # exactly one read group set.) + # The ID of the read group set this read belongs to. A read belongs to exactly + # one read group set. # Corresponds to the JSON property `readGroupSetId` # @return [String] attr_accessor :read_group_set_id @@ -1094,13 +1108,13 @@ module Google attr_accessor :fragment_name # The orientation and the distance between reads from the fragment are - # consistent with the sequencing protocol (SAM flag 0x2) + # consistent with the sequencing protocol (SAM flag 0x2). # Corresponds to the JSON property `properPlacement` # @return [Boolean] attr_accessor :proper_placement alias_method :proper_placement?, :proper_placement - # The fragment is a PCR or optical duplicate (SAM flag 0x400) + # The fragment is a PCR or optical duplicate (SAM flag 0x400). # Corresponds to the JSON property `duplicateFragment` # @return [Boolean] attr_accessor :duplicate_fragment @@ -1122,7 +1136,8 @@ module Google # @return [Fixnum] attr_accessor :number_reads - # SAM flag 0x200 + # Whether this read did not pass filters, such as platform or vendor quality + # controls (SAM flag 0x200). # Corresponds to the JSON property `failedVendorQualityChecks` # @return [Boolean] attr_accessor :failed_vendor_quality_checks @@ -1160,22 +1175,22 @@ module Google attr_accessor :supplementary_alignment alias_method :supplementary_alignment?, :supplementary_alignment - # The bases of the read sequence contained in this alignment record, *without - # CIGAR operations applied*. `alignedSequence` and `alignedQuality` may be - # shorter than the full read sequence and quality. This will occur if the - # alignment is part of a chimeric alignment, or if the read was trimmed. When - # this occurs, the CIGAR for this read will begin/end with a hard clip operator - # that will indicate the length of the excised sequence. + # The bases of the read sequence contained in this alignment record, **without + # CIGAR operations applied** (equivalent to SEQ in SAM). `alignedSequence` and ` + # alignedQuality` may be shorter than the full read sequence and quality. This + # will occur if the alignment is part of a chimeric alignment, or if the read + # was trimmed. When this occurs, the CIGAR for this read will begin/end with a + # hard clip operator that will indicate the length of the excised sequence. # Corresponds to the JSON property `alignedSequence` # @return [String] attr_accessor :aligned_sequence - # The quality of the read sequence contained in this alignment record. ` - # alignedSequence` and `alignedQuality` may be shorter than the full read - # sequence and quality. This will occur if the alignment is part of a chimeric - # alignment, or if the read was trimmed. When this occurs, the CIGAR for this - # read will begin/end with a hard clip operator that will indicate the length of - # the excised sequence. + # The quality of the read sequence contained in this alignment record ( + # equivalent to QUAL in SAM). `alignedSequence` and `alignedQuality` may be + # shorter than the full read sequence and quality. This will occur if the + # alignment is part of a chimeric alignment, or if the read was trimmed. When + # this occurs, the CIGAR for this read will begin/end with a hard clip operator + # that will indicate the length of the excised sequence. # Corresponds to the JSON property `alignedQuality` # @return [Array] attr_accessor :aligned_quality @@ -1234,7 +1249,8 @@ module Google attr_accessor :position # The mapping quality of this alignment. Represents how likely the read maps to - # this position as opposed to other locations. + # this position as opposed to other locations. Specifically, this is -10 log10 + # Pr(mapping position is wrong), rounded to the nearest integer. # Corresponds to the JSON property `mappingQuality` # @return [Fixnum] attr_accessor :mapping_quality @@ -1326,21 +1342,84 @@ module Google end end + # The stream reads request. + class StreamReadsRequest + include Google::Apis::Core::Hashable + + # The Google Developers Console project ID or number which will be billed for + # this access. The caller must have WRITE access to this project. Required. + # Corresponds to the JSON property `projectId` + # @return [String] + attr_accessor :project_id + + # The ID of the read group set from which to stream reads. + # Corresponds to the JSON property `readGroupSetId` + # @return [String] + attr_accessor :read_group_set_id + + # The reference sequence name, for example `chr1`, `1`, or `chrX`. If set to *, + # only unmapped reads are returned. + # Corresponds to the JSON property `referenceName` + # @return [String] + attr_accessor :reference_name + + # The start position of the range on the reference, 0-based inclusive. If + # specified, `referenceName` must also be specified. + # Corresponds to the JSON property `start` + # @return [String] + attr_accessor :start + + # The end position of the range on the reference, 0-based exclusive. If + # specified, `referenceName` must also be specified. + # Corresponds to the JSON property `end` + # @return [String] + attr_accessor :end + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @project_id = args[:project_id] unless args[:project_id].nil? + @read_group_set_id = args[:read_group_set_id] unless args[:read_group_set_id].nil? + @reference_name = args[:reference_name] unless args[:reference_name].nil? + @start = args[:start] unless args[:start].nil? + @end = args[:end] unless args[:end].nil? + end + end + + # + class StreamReadsResponse + include Google::Apis::Core::Hashable + + # + # Corresponds to the JSON property `alignments` + # @return [Array] + attr_accessor :alignments + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @alignments = args[:alignments] unless args[:alignments].nil? + end + end + # class SearchReferenceSetsRequest include Google::Apis::Core::Hashable - # If present, return references for which the `md5checksum` matches. See ` - # ReferenceSet.md5checksum` for details. + # If present, return reference sets for which the md5checksum matches exactly. # Corresponds to the JSON property `md5checksums` # @return [Array] attr_accessor :md5checksums - # If present, return references for which the accession matches any of these - # strings. Best to give a version number, for example `GCF_000001405.26`. If - # only the main accession number is given then all records with that main - # accession will be returned, whichever version. Note that different versions - # will have different sequences. + # If present, return reference sets for which a prefix of any of + # sourceAccessions match any of these strings. Accession numbers typically have + # a main number and a version, for example `NC_000001.11`. # Corresponds to the JSON property `accessions` # @return [Array] attr_accessor :accessions @@ -1358,7 +1437,8 @@ module Google # @return [String] attr_accessor :page_token - # Specifies the maximum number of results to return in a single page. + # The maximum number of results to return in a single page. If unspecified, + # defaults to 1024. The maximum value is 4096. # Corresponds to the JSON property `pageSize` # @return [Fixnum] attr_accessor :page_size @@ -1434,11 +1514,11 @@ module Google # @return [String] attr_accessor :md5checksum - # ID from http://www.ncbi.nlm.nih.gov/taxonomy (e.g. 9606->human) indicating the - # species which this assembly is intended to model. Note that contained - # references may specify a different `ncbiTaxonId`, as assemblies may contain - # reference sequences which do not belong to the modeled species, e.g. EBV in a - # human reference genome. + # ID from http://www.ncbi.nlm.nih.gov/taxonomy (for example, 9606 for human) + # indicating the species which this reference set is intended to model. Note + # that contained references may specify a different `ncbiTaxonId`, as assemblies + # may contain reference sequences which do not belong to the modeled species, + # for example EBV in a human reference genome. # Corresponds to the JSON property `ncbiTaxonId` # @return [Fixnum] attr_accessor :ncbi_taxon_id @@ -1485,17 +1565,14 @@ module Google class SearchReferencesRequest include Google::Apis::Core::Hashable - # If present, return references for which the `md5checksum` matches. See ` - # Reference.md5checksum` for construction details. + # If present, return references for which the md5checksum matches exactly. # Corresponds to the JSON property `md5checksums` # @return [Array] attr_accessor :md5checksums - # If present, return references for which the accession matches this string. - # Best to give a version number, for example `GCF_000001405.26`. If only the - # main accession number is given then all records with that main accession will - # be returned, whichever version. Note that different versions will have - # different sequences. + # If present, return references for which a prefix of any of sourceAccessions + # match any of these strings. Accession numbers typically have a main number and + # a version, for example `GCF_000001405.26`. # Corresponds to the JSON property `accessions` # @return [Array] attr_accessor :accessions @@ -1512,7 +1589,8 @@ module Google # @return [String] attr_accessor :page_token - # Specifies the maximum number of results to return in a single page. + # The maximum number of results to return in a single page. If unspecified, + # defaults to 1024. The maximum value is 4096. # Corresponds to the JSON property `pageSize` # @return [Fixnum] attr_accessor :page_size @@ -1589,8 +1667,8 @@ module Google # @return [String] attr_accessor :name - # The URI from which the sequence was obtained. Specifies a FASTA format file/ - # string with one name, sequence pair. + # The URI from which the sequence was obtained. Typically specifies a FASTA + # format file. # Corresponds to the JSON property `sourceUri` # @return [String] attr_accessor :source_uri @@ -1601,8 +1679,7 @@ module Google # @return [Array] attr_accessor :source_accessions - # ID from http://www.ncbi.nlm.nih.gov/taxonomy (e.g. 9606->human) if not - # specified by the containing reference set. + # ID from http://www.ncbi.nlm.nih.gov/taxonomy. For example, 9606 for human. # Corresponds to the JSON property `ncbiTaxonId` # @return [Fixnum] attr_accessor :ncbi_taxon_id @@ -1763,7 +1840,7 @@ module Google class ReferenceBound include Google::Apis::Core::Hashable - # The reference the bound is associate with. + # The name of the reference associated with this ReferenceBound. # Corresponds to the JSON property `referenceName` # @return [String] attr_accessor :reference_name @@ -1911,7 +1988,8 @@ module Google # @return [String] attr_accessor :page_token - # The maximum number of variant sets to return in a request. + # The maximum number of results to return in a single page. If unspecified, + # defaults to 1024. # Corresponds to the JSON property `pageSize` # @return [Fixnum] attr_accessor :page_size @@ -2003,14 +2081,16 @@ module Google # @return [String] attr_accessor :page_token - # The maximum number of variants to return. If unspecified, defaults to 5000. + # The maximum number of variants to return in a single page. If unspecified, + # defaults to 5000. The maximum value is 10000. # Corresponds to the JSON property `pageSize` # @return [Fixnum] attr_accessor :page_size - # The maximum number of calls to return. However, at least one variant will - # always be returned, even if it has more calls than this limit. If unspecified, - # defaults to 5000. + # The maximum number of calls to return in a single page. Note that this limit + # may be exceeded; at least one variant is always returned per page, even if it + # has more calls than this limit. If unspecified, defaults to 5000. The maximum + # value is 10000. # Corresponds to the JSON property `maxCalls` # @return [Fixnum] attr_accessor :max_calls @@ -2256,7 +2336,8 @@ module Google # @return [String] attr_accessor :page_token - # The maximum number of call sets to return. If unspecified, defaults to 1000. + # The maximum number of results to return in a single page. If unspecified, + # defaults to 1024. # Corresponds to the JSON property `pageSize` # @return [Fixnum] attr_accessor :page_size @@ -2357,6 +2438,78 @@ module Google end end + # The stream variants request. + class StreamVariantsRequest + include Google::Apis::Core::Hashable + + # The Google Developers Console project ID or number which will be billed for + # this access. The caller must have WRITE access to this project. Required. + # Corresponds to the JSON property `projectId` + # @return [String] + attr_accessor :project_id + + # The variant set ID from which to stream variants. + # Corresponds to the JSON property `variantSetId` + # @return [String] + attr_accessor :variant_set_id + + # Only return variant calls which belong to call sets with these IDs. Leaving + # this blank returns all variant calls. + # Corresponds to the JSON property `callSetIds` + # @return [Array] + attr_accessor :call_set_ids + + # Required. Only return variants in this reference sequence. + # Corresponds to the JSON property `referenceName` + # @return [String] + attr_accessor :reference_name + + # The beginning of the window (0-based, inclusive) for which overlapping + # variants should be returned. + # Corresponds to the JSON property `start` + # @return [String] + attr_accessor :start + + # The end of the window (0-based, exclusive) for which overlapping variants + # should be returned. + # Corresponds to the JSON property `end` + # @return [String] + attr_accessor :end + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @project_id = args[:project_id] unless args[:project_id].nil? + @variant_set_id = args[:variant_set_id] unless args[:variant_set_id].nil? + @call_set_ids = args[:call_set_ids] unless args[:call_set_ids].nil? + @reference_name = args[:reference_name] unless args[:reference_name].nil? + @start = args[:start] unless args[:start].nil? + @end = args[:end] unless args[:end].nil? + end + end + + # + class StreamVariantsResponse + include Google::Apis::Core::Hashable + + # + # Corresponds to the JSON property `variants` + # @return [Array] + attr_accessor :variants + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @variants = args[:variants] unless args[:variants].nil? + end + end + # The read group set import response. class ImportReadGroupSetsResponse include Google::Apis::Core::Hashable @@ -2380,7 +2533,7 @@ module Google class ImportVariantsResponse include Google::Apis::Core::Hashable - # IDs of the call sets that were created. + # IDs of the call sets created during the import. # Corresponds to the JSON property `callSetIds` # @return [Array] attr_accessor :call_set_ids diff --git a/generated/google/apis/genomics_v1/representations.rb b/generated/google/apis/genomics_v1/representations.rb index 208e0c68b..7338d1185 100644 --- a/generated/google/apis/genomics_v1/representations.rb +++ b/generated/google/apis/genomics_v1/representations.rb @@ -146,6 +146,14 @@ module Google class Representation < Google::Apis::Core::JsonRepresentation; end end + class StreamReadsRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + end + + class StreamReadsResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + end + class SearchReferenceSetsRequest class Representation < Google::Apis::Core::JsonRepresentation; end end @@ -230,6 +238,14 @@ module Google class Representation < Google::Apis::Core::JsonRepresentation; end end + class StreamVariantsRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + end + + class StreamVariantsResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + end + class ImportReadGroupSetsResponse class Representation < Google::Apis::Core::JsonRepresentation; end end @@ -566,6 +582,25 @@ module Google end end + class StreamReadsRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :project_id, as: 'projectId' + property :read_group_set_id, as: 'readGroupSetId' + property :reference_name, as: 'referenceName' + property :start, as: 'start' + property :end, as: 'end' + end + end + + class StreamReadsResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :alignments, as: 'alignments', class: Google::Apis::GenomicsV1::Read, decorator: Google::Apis::GenomicsV1::Read::Representation + + end + end + class SearchReferenceSetsRequest # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -818,6 +853,26 @@ module Google end end + class StreamVariantsRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :project_id, as: 'projectId' + property :variant_set_id, as: 'variantSetId' + collection :call_set_ids, as: 'callSetIds' + property :reference_name, as: 'referenceName' + property :start, as: 'start' + property :end, as: 'end' + end + end + + class StreamVariantsResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :variants, as: 'variants', class: Google::Apis::GenomicsV1::Variant, decorator: Google::Apis::GenomicsV1::Variant::Representation + + end + end + class ImportReadGroupSetsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation diff --git a/generated/google/apis/genomics_v1/service.rb b/generated/google/apis/genomics_v1/service.rb index 765e0c843..dcee152d8 100644 --- a/generated/google/apis/genomics_v1/service.rb +++ b/generated/google/apis/genomics_v1/service.rb @@ -22,8 +22,10 @@ module Google module GenomicsV1 # Genomics API # - # An API to store, process, explore, and share DNA sequence reads, reference- - # based alignments, and variant calls. + # An API to store, process, explore, and share genomic data. It supports + # reference-based alignements, genetic variants, and reference genomes. This API + # provides an implementation of the Global Alliance for Genomics and Health ( + # GA4GH) v0.5.1 API as well as several extensions. # # @example # require 'google/apis/genomics_v1' @@ -53,7 +55,7 @@ module Google # @param [String] project_id # Required. The project to list datasets for. # @param [Fixnum] page_size - # The maximum number of results returned by this request. If unspecified, + # The maximum number of results to return in a single page. If unspecified, # defaults to 50. The maximum value is 1024. # @param [String] page_token # The continuation token, which is used to page through large result sets. To @@ -564,7 +566,8 @@ module Google # ImportReadGroupSets](google.genomics.v1.ReadServiceV1.ImportReadGroupSets) for # caveats. # @param [String] read_group_set_id - # Required. The ID of the read group set to export. + # Required. The ID of the read group set to export. The caller must have READ + # access to this read group set. # @param [Google::Apis::GenomicsV1::ExportReadGroupSetRequest] export_read_group_set_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -638,9 +641,9 @@ module Google # permissions to the dataset associated with this read group set. # @param [Google::Apis::GenomicsV1::ReadGroupSet] read_group_set_object # @param [String] update_mask - # An optional mask specifying which fields to update. At this time, mutable - # fields are referenceSetId and name. Acceptable values are "referenceSetId" and - # "name". If unspecified, all mutable fields will be updated. + # An optional mask specifying which fields to update. Supported fields: * name. * + # referenceSetId. Leaving `updateMask` unset is equivalent to specifying all + # mutable fields. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -813,10 +816,13 @@ module Google # returns all reads whose alignment to the reference genome overlap the range. A # query which specifies only read group set IDs yields all reads in those read # group sets, including unmapped reads. All reads returned (including reads on - # subsequent pages) are ordered by genomic coordinate (reference sequence & - # position). Reads with equivalent genomic coordinates are returned in a - # deterministic order. Implements [GlobalAllianceApi.searchReads](https://github. - # com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/readmethods.avdl#L85). + # subsequent pages) are ordered by genomic coordinate (by reference sequence, + # then position). Reads with equivalent genomic coordinates are returned in an + # unspecified order. This order is consistent, such that two queries for the + # same content (regardless of page size) yield reads in the same order across + # their respective streams of paginated responses. Implements [GlobalAllianceApi. + # searchReads](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/ + # avro/readmethods.avdl#L85). # @param [Google::Apis::GenomicsV1::SearchReadsRequest] search_reads_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -846,11 +852,43 @@ module Google execute_or_queue_command(command, &block) end + # Returns a stream of all the reads matching the search request, ordered by + # reference name, position, and ID. + # @param [Google::Apis::GenomicsV1::StreamReadsRequest] stream_reads_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::GenomicsV1::StreamReadsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::GenomicsV1::StreamReadsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def stream_reads(stream_reads_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/reads:stream', options) + command.request_representation = Google::Apis::GenomicsV1::StreamReadsRequest::Representation + command.request_object = stream_reads_request_object + command.response_representation = Google::Apis::GenomicsV1::StreamReadsResponse::Representation + command.response_class = Google::Apis::GenomicsV1::StreamReadsResponse + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + # Searches for reference sets which match the given criteria. For the # definitions of references and other genomics resources, see [Fundamentals of # Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google- - # genomics) Implements [GlobalAllianceApi.searchReferenceSets](http://ga4gh.org/ - # documentation/api/v0.5.1/ga4gh_api.html#/schema/org.ga4gh.searchReferenceSets). + # genomics) Implements [GlobalAllianceApi.searchReferenceSets](https://github. + # com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/referencemethods.avdl# + # L71) # @param [Google::Apis::GenomicsV1::SearchReferenceSetsRequest] search_reference_sets_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -999,7 +1037,9 @@ module Google # get the next page of results, set this parameter to the value of ` # nextPageToken` from the previous response. # @param [Fixnum] page_size - # Specifies the maximum number of bases to return in a single page. + # The maximum number of bases to return in a single page. If unspecified, + # defaults to 200Kbp (kilo base pairs). The maximum value is 10Mbp (mega base + # pairs). # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1245,6 +1285,37 @@ module Google execute_or_queue_command(command, &block) end + # Returns a stream of all the variants matching the search request, ordered by + # reference name, position, and ID. + # @param [Google::Apis::GenomicsV1::StreamVariantsRequest] stream_variants_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::GenomicsV1::StreamVariantsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::GenomicsV1::StreamVariantsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def stream_variants(stream_variants_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/variants:stream', options) + command.request_representation = Google::Apis::GenomicsV1::StreamVariantsRequest::Representation + command.request_object = stream_variants_request_object + command.response_representation = Google::Apis::GenomicsV1::StreamVariantsResponse::Representation + command.response_class = Google::Apis::GenomicsV1::StreamVariantsResponse + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + # Creates a new variant set. For the definitions of variant sets and other # genomics resources, see [Fundamentals of Google Genomics](https://cloud.google. # com/genomics/fundamentals-of-google-genomics) The provided variant set must diff --git a/generated/google/apis/licensing_v1.rb b/generated/google/apis/licensing_v1.rb index 89d980207..655450fb4 100644 --- a/generated/google/apis/licensing_v1.rb +++ b/generated/google/apis/licensing_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/google-apps/licensing/ module LicensingV1 VERSION = 'V1' - REVISION = '20150525' + REVISION = '20150901' # View and manage Google Apps licenses for your domain AUTH_APPS_LICENSING = 'https://www.googleapis.com/auth/apps.licensing' diff --git a/generated/google/apis/mapsengine_v1.rb b/generated/google/apis/mapsengine_v1.rb index 537472c0b..17ae6e429 100644 --- a/generated/google/apis/mapsengine_v1.rb +++ b/generated/google/apis/mapsengine_v1.rb @@ -26,7 +26,7 @@ module Google # @see https://developers.google.com/maps-engine/ module MapsengineV1 VERSION = 'V1' - REVISION = '20150629' + REVISION = '20151202' # View and manage your Google My Maps data AUTH_MAPSENGINE = 'https://www.googleapis.com/auth/mapsengine' diff --git a/generated/google/apis/mirror_v1.rb b/generated/google/apis/mirror_v1.rb index 03d44770d..17ae8ac2e 100644 --- a/generated/google/apis/mirror_v1.rb +++ b/generated/google/apis/mirror_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/glass module MirrorV1 VERSION = 'V1' - REVISION = '20151102' + REVISION = '20151206' # View your location AUTH_GLASS_LOCATION = 'https://www.googleapis.com/auth/glass.location' diff --git a/generated/google/apis/plus_domains_v1.rb b/generated/google/apis/plus_domains_v1.rb index 58a9ca5b1..e32762f39 100644 --- a/generated/google/apis/plus_domains_v1.rb +++ b/generated/google/apis/plus_domains_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/+/domains/ module PlusDomainsV1 VERSION = 'V1' - REVISION = '20151130' + REVISION = '20151209' # View your circles and the people and pages in them AUTH_PLUS_CIRCLES_READ = 'https://www.googleapis.com/auth/plus.circles.read' diff --git a/generated/google/apis/plus_v1.rb b/generated/google/apis/plus_v1.rb index 9b13df1f0..7cc4a263c 100644 --- a/generated/google/apis/plus_v1.rb +++ b/generated/google/apis/plus_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/+/api/ module PlusV1 VERSION = 'V1' - REVISION = '20151130' + REVISION = '20151209' # Know your basic profile info and list of people in your circles. AUTH_PLUS_LOGIN = 'https://www.googleapis.com/auth/plus.login' diff --git a/generated/google/apis/sqladmin_v1beta4.rb b/generated/google/apis/sqladmin_v1beta4.rb index b6dfc6c35..c96836438 100644 --- a/generated/google/apis/sqladmin_v1beta4.rb +++ b/generated/google/apis/sqladmin_v1beta4.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/sql/docs/reference/latest module SqladminV1beta4 VERSION = 'V1beta4' - REVISION = '20151117' + REVISION = '20151201' # 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/storage_v1.rb b/generated/google/apis/storage_v1.rb index eeaa57b91..2bfa34b3b 100644 --- a/generated/google/apis/storage_v1.rb +++ b/generated/google/apis/storage_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/storage/docs/json_api/ module StorageV1 VERSION = 'V1' - REVISION = '20151113' + REVISION = '20151207' # 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/youtube_analytics_v1.rb b/generated/google/apis/youtube_analytics_v1.rb index e36c0534f..2b1228e20 100644 --- a/generated/google/apis/youtube_analytics_v1.rb +++ b/generated/google/apis/youtube_analytics_v1.rb @@ -25,7 +25,7 @@ module Google # @see http://developers.google.com/youtube/analytics/ module YoutubeAnalyticsV1 VERSION = 'V1' - REVISION = '20150921' + REVISION = '20151211' # Manage your YouTube account AUTH_YOUTUBE = 'https://www.googleapis.com/auth/youtube' diff --git a/generated/google/apis/youtube_analytics_v1/classes.rb b/generated/google/apis/youtube_analytics_v1/classes.rb index d5d40b006..c93f635b2 100644 --- a/generated/google/apis/youtube_analytics_v1/classes.rb +++ b/generated/google/apis/youtube_analytics_v1/classes.rb @@ -444,6 +444,11 @@ module Google # @return [String] attr_accessor :kind + # + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + def initialize(**args) update!(**args) end @@ -453,6 +458,7 @@ module Google @etag = args[:etag] unless args[:etag].nil? @items = args[:items] unless args[:items].nil? @kind = args[:kind] unless args[:kind].nil? + @next_page_token = args[:next_page_token] unless args[:next_page_token].nil? end end diff --git a/generated/google/apis/youtube_analytics_v1/representations.rb b/generated/google/apis/youtube_analytics_v1/representations.rb index 552e9979e..f51a8fe66 100644 --- a/generated/google/apis/youtube_analytics_v1/representations.rb +++ b/generated/google/apis/youtube_analytics_v1/representations.rb @@ -212,6 +212,7 @@ module Google collection :items, as: 'items', class: Google::Apis::YoutubeAnalyticsV1::Group, decorator: Google::Apis::YoutubeAnalyticsV1::Group::Representation property :kind, as: 'kind' + property :next_page_token, as: 'nextPageToken' end end diff --git a/generated/google/apis/youtube_analytics_v1/service.rb b/generated/google/apis/youtube_analytics_v1/service.rb index efecc6bd9..a5aa51147 100644 --- a/generated/google/apis/youtube_analytics_v1/service.rb +++ b/generated/google/apis/youtube_analytics_v1/service.rb @@ -377,6 +377,10 @@ module Google # to all their video and channel data, without having to provide authentication # credentials for each individual channel. The CMS account that the user # authenticates with must be linked to the specified YouTube content owner. + # @param [String] page_token + # The pageToken parameter identifies a specific page in the result set that + # should be returned. In an API response, the nextPageToken property identifies + # the next page that can be retrieved. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -398,13 +402,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_groups(id: nil, mine: nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def list_groups(id: nil, mine: nil, on_behalf_of_content_owner: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'groups', options) command.response_representation = Google::Apis::YoutubeAnalyticsV1::ListGroupsResponse::Representation command.response_class = Google::Apis::YoutubeAnalyticsV1::ListGroupsResponse command.query['id'] = id unless id.nil? command.query['mine'] = mine unless mine.nil? command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil? + command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? diff --git a/generated/google/apis/youtube_v3.rb b/generated/google/apis/youtube_v3.rb index 03c406d56..aa1a060a2 100644 --- a/generated/google/apis/youtube_v3.rb +++ b/generated/google/apis/youtube_v3.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/youtube/v3 module YoutubeV3 VERSION = 'V3' - REVISION = '20151201' + REVISION = '20151209' # Manage your YouTube account AUTH_YOUTUBE = 'https://www.googleapis.com/auth/youtube'