diff --git a/api_names_out.yaml b/api_names_out.yaml index 19e7770b4..cfc781f21 100644 --- a/api_names_out.yaml +++ b/api_names_out.yaml @@ -14513,6 +14513,7 @@ "/bigqueryreservation:v1/BiReservation/updateTime": update_time "/bigqueryreservation:v1/CapacityCommitment": capacity_commitment "/bigqueryreservation:v1/CapacityCommitment/commitmentEndTime": commitment_end_time +"/bigqueryreservation:v1/CapacityCommitment/commitmentStartTime": commitment_start_time "/bigqueryreservation:v1/CapacityCommitment/failureStatus": failure_status "/bigqueryreservation:v1/CapacityCommitment/name": name "/bigqueryreservation:v1/CapacityCommitment/plan": plan @@ -14555,6 +14556,10 @@ "/bigqueryreservation:v1/Reservation/ignoreIdleSlots": ignore_idle_slots "/bigqueryreservation:v1/Reservation/name": name "/bigqueryreservation:v1/Reservation/slotCapacity": slot_capacity +"/bigqueryreservation:v1/SearchAllAssignmentsResponse": search_all_assignments_response +"/bigqueryreservation:v1/SearchAllAssignmentsResponse/assignments": assignments +"/bigqueryreservation:v1/SearchAllAssignmentsResponse/assignments/assignment": assignment +"/bigqueryreservation:v1/SearchAllAssignmentsResponse/nextPageToken": next_page_token "/bigqueryreservation:v1/SearchAssignmentsResponse": search_assignments_response "/bigqueryreservation:v1/SearchAssignmentsResponse/assignments": assignments "/bigqueryreservation:v1/SearchAssignmentsResponse/assignments/assignment": assignment @@ -14621,6 +14626,11 @@ "/bigqueryreservation:v1/bigqueryreservation.projects.locations.reservations.patch": patch_project_location_reservation "/bigqueryreservation:v1/bigqueryreservation.projects.locations.reservations.patch/name": name "/bigqueryreservation:v1/bigqueryreservation.projects.locations.reservations.patch/updateMask": update_mask +"/bigqueryreservation:v1/bigqueryreservation.projects.locations.searchAllAssignments": search_project_location_all_assignments +"/bigqueryreservation:v1/bigqueryreservation.projects.locations.searchAllAssignments/pageSize": page_size +"/bigqueryreservation:v1/bigqueryreservation.projects.locations.searchAllAssignments/pageToken": page_token +"/bigqueryreservation:v1/bigqueryreservation.projects.locations.searchAllAssignments/parent": parent +"/bigqueryreservation:v1/bigqueryreservation.projects.locations.searchAllAssignments/query": query "/bigqueryreservation:v1/bigqueryreservation.projects.locations.searchAssignments": search_project_location_assignments "/bigqueryreservation:v1/bigqueryreservation.projects.locations.searchAssignments/pageSize": page_size "/bigqueryreservation:v1/bigqueryreservation.projects.locations.searchAssignments/pageToken": page_token @@ -14740,6 +14750,7 @@ "/bigqueryreservation:v1beta1/BiReservation/updateTime": update_time "/bigqueryreservation:v1beta1/CapacityCommitment": capacity_commitment "/bigqueryreservation:v1beta1/CapacityCommitment/commitmentEndTime": commitment_end_time +"/bigqueryreservation:v1beta1/CapacityCommitment/commitmentStartTime": commitment_start_time "/bigqueryreservation:v1beta1/CapacityCommitment/failureStatus": failure_status "/bigqueryreservation:v1beta1/CapacityCommitment/name": name "/bigqueryreservation:v1beta1/CapacityCommitment/plan": plan @@ -56483,14 +56494,129 @@ "/customsearch:v1/Result/title": title "/customsearch:v1/Search": search "/customsearch:v1/Search/context": context +"/customsearch:v1/Search/context/context": context "/customsearch:v1/Search/items": items "/customsearch:v1/Search/items/item": item "/customsearch:v1/Search/kind": kind "/customsearch:v1/Search/promotions": promotions "/customsearch:v1/Search/promotions/promotion": promotion "/customsearch:v1/Search/queries": queries +"/customsearch:v1/Search/queries/nextPage": next_page +"/customsearch:v1/Search/queries/nextPage/next_page": next_page +"/customsearch:v1/Search/queries/nextPage/next_page/count": count +"/customsearch:v1/Search/queries/nextPage/next_page/cr": cr +"/customsearch:v1/Search/queries/nextPage/next_page/cx": cx +"/customsearch:v1/Search/queries/nextPage/next_page/dateRestrict": date_restrict +"/customsearch:v1/Search/queries/nextPage/next_page/disableCnTwTranslation": disable_cn_tw_translation +"/customsearch:v1/Search/queries/nextPage/next_page/exactTerms": exact_terms +"/customsearch:v1/Search/queries/nextPage/next_page/excludeTerms": exclude_terms +"/customsearch:v1/Search/queries/nextPage/next_page/fileType": file_type +"/customsearch:v1/Search/queries/nextPage/next_page/filter": filter +"/customsearch:v1/Search/queries/nextPage/next_page/gl": gl +"/customsearch:v1/Search/queries/nextPage/next_page/googleHost": google_host +"/customsearch:v1/Search/queries/nextPage/next_page/highRange": high_range +"/customsearch:v1/Search/queries/nextPage/next_page/hl": hl +"/customsearch:v1/Search/queries/nextPage/next_page/hq": hq +"/customsearch:v1/Search/queries/nextPage/next_page/imgColorType": img_color_type +"/customsearch:v1/Search/queries/nextPage/next_page/imgDominantColor": img_dominant_color +"/customsearch:v1/Search/queries/nextPage/next_page/imgSize": img_size +"/customsearch:v1/Search/queries/nextPage/next_page/imgType": img_type +"/customsearch:v1/Search/queries/nextPage/next_page/inputEncoding": input_encoding +"/customsearch:v1/Search/queries/nextPage/next_page/language": language +"/customsearch:v1/Search/queries/nextPage/next_page/linkSite": link_site +"/customsearch:v1/Search/queries/nextPage/next_page/lowRange": low_range +"/customsearch:v1/Search/queries/nextPage/next_page/orTerms": or_terms +"/customsearch:v1/Search/queries/nextPage/next_page/outputEncoding": output_encoding +"/customsearch:v1/Search/queries/nextPage/next_page/relatedSite": related_site +"/customsearch:v1/Search/queries/nextPage/next_page/rights": rights +"/customsearch:v1/Search/queries/nextPage/next_page/safe": safe +"/customsearch:v1/Search/queries/nextPage/next_page/searchTerms": search_terms +"/customsearch:v1/Search/queries/nextPage/next_page/searchType": search_type +"/customsearch:v1/Search/queries/nextPage/next_page/siteSearch": site_search +"/customsearch:v1/Search/queries/nextPage/next_page/siteSearchFilter": site_search_filter +"/customsearch:v1/Search/queries/nextPage/next_page/sort": sort +"/customsearch:v1/Search/queries/nextPage/next_page/startIndex": start_index +"/customsearch:v1/Search/queries/nextPage/next_page/startPage": start_page +"/customsearch:v1/Search/queries/nextPage/next_page/title": title +"/customsearch:v1/Search/queries/nextPage/next_page/totalResults": total_results +"/customsearch:v1/Search/queries/previousPage": previous_page +"/customsearch:v1/Search/queries/previousPage/previous_page": previous_page +"/customsearch:v1/Search/queries/previousPage/previous_page/count": count +"/customsearch:v1/Search/queries/previousPage/previous_page/cr": cr +"/customsearch:v1/Search/queries/previousPage/previous_page/cx": cx +"/customsearch:v1/Search/queries/previousPage/previous_page/dateRestrict": date_restrict +"/customsearch:v1/Search/queries/previousPage/previous_page/disableCnTwTranslation": disable_cn_tw_translation +"/customsearch:v1/Search/queries/previousPage/previous_page/exactTerms": exact_terms +"/customsearch:v1/Search/queries/previousPage/previous_page/excludeTerms": exclude_terms +"/customsearch:v1/Search/queries/previousPage/previous_page/fileType": file_type +"/customsearch:v1/Search/queries/previousPage/previous_page/filter": filter +"/customsearch:v1/Search/queries/previousPage/previous_page/gl": gl +"/customsearch:v1/Search/queries/previousPage/previous_page/googleHost": google_host +"/customsearch:v1/Search/queries/previousPage/previous_page/highRange": high_range +"/customsearch:v1/Search/queries/previousPage/previous_page/hl": hl +"/customsearch:v1/Search/queries/previousPage/previous_page/hq": hq +"/customsearch:v1/Search/queries/previousPage/previous_page/imgColorType": img_color_type +"/customsearch:v1/Search/queries/previousPage/previous_page/imgDominantColor": img_dominant_color +"/customsearch:v1/Search/queries/previousPage/previous_page/imgSize": img_size +"/customsearch:v1/Search/queries/previousPage/previous_page/imgType": img_type +"/customsearch:v1/Search/queries/previousPage/previous_page/inputEncoding": input_encoding +"/customsearch:v1/Search/queries/previousPage/previous_page/language": language +"/customsearch:v1/Search/queries/previousPage/previous_page/linkSite": link_site +"/customsearch:v1/Search/queries/previousPage/previous_page/lowRange": low_range +"/customsearch:v1/Search/queries/previousPage/previous_page/orTerms": or_terms +"/customsearch:v1/Search/queries/previousPage/previous_page/outputEncoding": output_encoding +"/customsearch:v1/Search/queries/previousPage/previous_page/relatedSite": related_site +"/customsearch:v1/Search/queries/previousPage/previous_page/rights": rights +"/customsearch:v1/Search/queries/previousPage/previous_page/safe": safe +"/customsearch:v1/Search/queries/previousPage/previous_page/searchTerms": search_terms +"/customsearch:v1/Search/queries/previousPage/previous_page/searchType": search_type +"/customsearch:v1/Search/queries/previousPage/previous_page/siteSearch": site_search +"/customsearch:v1/Search/queries/previousPage/previous_page/siteSearchFilter": site_search_filter +"/customsearch:v1/Search/queries/previousPage/previous_page/sort": sort +"/customsearch:v1/Search/queries/previousPage/previous_page/startIndex": start_index +"/customsearch:v1/Search/queries/previousPage/previous_page/startPage": start_page +"/customsearch:v1/Search/queries/previousPage/previous_page/title": title +"/customsearch:v1/Search/queries/previousPage/previous_page/totalResults": total_results "/customsearch:v1/Search/queries/query": query "/customsearch:v1/Search/queries/query/query": query +"/customsearch:v1/Search/queries/request": request +"/customsearch:v1/Search/queries/request/request": request +"/customsearch:v1/Search/queries/request/request/count": count +"/customsearch:v1/Search/queries/request/request/cr": cr +"/customsearch:v1/Search/queries/request/request/cx": cx +"/customsearch:v1/Search/queries/request/request/dateRestrict": date_restrict +"/customsearch:v1/Search/queries/request/request/disableCnTwTranslation": disable_cn_tw_translation +"/customsearch:v1/Search/queries/request/request/exactTerms": exact_terms +"/customsearch:v1/Search/queries/request/request/excludeTerms": exclude_terms +"/customsearch:v1/Search/queries/request/request/fileType": file_type +"/customsearch:v1/Search/queries/request/request/filter": filter +"/customsearch:v1/Search/queries/request/request/gl": gl +"/customsearch:v1/Search/queries/request/request/googleHost": google_host +"/customsearch:v1/Search/queries/request/request/highRange": high_range +"/customsearch:v1/Search/queries/request/request/hl": hl +"/customsearch:v1/Search/queries/request/request/hq": hq +"/customsearch:v1/Search/queries/request/request/imgColorType": img_color_type +"/customsearch:v1/Search/queries/request/request/imgDominantColor": img_dominant_color +"/customsearch:v1/Search/queries/request/request/imgSize": img_size +"/customsearch:v1/Search/queries/request/request/imgType": img_type +"/customsearch:v1/Search/queries/request/request/inputEncoding": input_encoding +"/customsearch:v1/Search/queries/request/request/language": language +"/customsearch:v1/Search/queries/request/request/linkSite": link_site +"/customsearch:v1/Search/queries/request/request/lowRange": low_range +"/customsearch:v1/Search/queries/request/request/orTerms": or_terms +"/customsearch:v1/Search/queries/request/request/outputEncoding": output_encoding +"/customsearch:v1/Search/queries/request/request/relatedSite": related_site +"/customsearch:v1/Search/queries/request/request/rights": rights +"/customsearch:v1/Search/queries/request/request/safe": safe +"/customsearch:v1/Search/queries/request/request/searchTerms": search_terms +"/customsearch:v1/Search/queries/request/request/searchType": search_type +"/customsearch:v1/Search/queries/request/request/siteSearch": site_search +"/customsearch:v1/Search/queries/request/request/siteSearchFilter": site_search_filter +"/customsearch:v1/Search/queries/request/request/sort": sort +"/customsearch:v1/Search/queries/request/request/startIndex": start_index +"/customsearch:v1/Search/queries/request/request/startPage": start_page +"/customsearch:v1/Search/queries/request/request/title": title +"/customsearch:v1/Search/queries/request/request/totalResults": total_results "/customsearch:v1/Search/searchInformation": search_information "/customsearch:v1/Search/searchInformation/formattedSearchTime": formatted_search_time "/customsearch:v1/Search/searchInformation/formattedTotalResults": formatted_total_results @@ -92365,6 +92491,38 @@ "/firebasedynamiclinks:v1/firebasedynamiclinks.shortLinks.create": create_short_link_short_dynamic_link "/firebasedynamiclinks:v1/key": key "/firebasedynamiclinks:v1/quotaUser": quota_user +"/firebasehosting:v1/CancelOperationRequest": cancel_operation_request +"/firebasehosting:v1/Empty": empty +"/firebasehosting:v1/ListOperationsResponse": list_operations_response +"/firebasehosting:v1/ListOperationsResponse/nextPageToken": next_page_token +"/firebasehosting:v1/ListOperationsResponse/operations": operations +"/firebasehosting:v1/ListOperationsResponse/operations/operation": operation +"/firebasehosting:v1/Operation": operation +"/firebasehosting:v1/Operation/done": done +"/firebasehosting:v1/Operation/error": error +"/firebasehosting:v1/Operation/metadata": metadata +"/firebasehosting:v1/Operation/metadata/metadatum": metadatum +"/firebasehosting:v1/Operation/name": name +"/firebasehosting:v1/Operation/response": response +"/firebasehosting:v1/Operation/response/response": response +"/firebasehosting:v1/Status": status +"/firebasehosting:v1/Status/code": code +"/firebasehosting:v1/Status/details": details +"/firebasehosting:v1/Status/details/detail": detail +"/firebasehosting:v1/Status/details/detail/detail": detail +"/firebasehosting:v1/Status/message": message +"/firebasehosting:v1/fields": fields +"/firebasehosting:v1/firebasehosting.operations.cancel": cancel_operation +"/firebasehosting:v1/firebasehosting.operations.cancel/name": name +"/firebasehosting:v1/firebasehosting.operations.delete": delete_operation +"/firebasehosting:v1/firebasehosting.operations.delete/name": name +"/firebasehosting:v1/firebasehosting.operations.list": list_operations +"/firebasehosting:v1/firebasehosting.operations.list/filter": filter +"/firebasehosting:v1/firebasehosting.operations.list/name": name +"/firebasehosting:v1/firebasehosting.operations.list/pageSize": page_size +"/firebasehosting:v1/firebasehosting.operations.list/pageToken": page_token +"/firebasehosting:v1/key": key +"/firebasehosting:v1/quotaUser": quota_user "/firebasehosting:v1beta1/ActingUser": acting_user "/firebasehosting:v1beta1/ActingUser/email": email "/firebasehosting:v1beta1/ActingUser/imageUrl": image_url diff --git a/generated/google/apis/admob_v1.rb b/generated/google/apis/admob_v1.rb index c3c9c895d..aee3c982d 100644 --- a/generated/google/apis/admob_v1.rb +++ b/generated/google/apis/admob_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/admob/api/ module AdmobV1 VERSION = 'V1' - REVISION = '20200603' + REVISION = '20200708' end end end diff --git a/generated/google/apis/admob_v1/service.rb b/generated/google/apis/admob_v1/service.rb index 1ce99b7ba..2fd8b67c4 100644 --- a/generated/google/apis/admob_v1/service.rb +++ b/generated/google/apis/admob_v1/service.rb @@ -49,7 +49,7 @@ module Google # Gets information about the specified AdMob publisher account. # @param [String] name - # Resource name of the publisher account to retrieve. + # Required. Resource name of the publisher account to retrieve. # Example: accounts/pub-9876543210987654 # @param [String] fields # Selector specifying which fields to include in a partial response. diff --git a/generated/google/apis/androidpublisher_v1/classes.rb b/generated/google/apis/androidpublisher_v1/classes.rb deleted file mode 100644 index cc62d1349..000000000 --- a/generated/google/apis/androidpublisher_v1/classes.rb +++ /dev/null @@ -1,26 +0,0 @@ -# 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 AndroidpublisherV1 - end - end -end diff --git a/generated/google/apis/androidpublisher_v1/representations.rb b/generated/google/apis/androidpublisher_v1/representations.rb deleted file mode 100644 index cc62d1349..000000000 --- a/generated/google/apis/androidpublisher_v1/representations.rb +++ /dev/null @@ -1,26 +0,0 @@ -# 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 AndroidpublisherV1 - end - end -end diff --git a/generated/google/apis/androidpublisher_v1/service.rb b/generated/google/apis/androidpublisher_v1/service.rb deleted file mode 100644 index 54173c450..000000000 --- a/generated/google/apis/androidpublisher_v1/service.rb +++ /dev/null @@ -1,64 +0,0 @@ -# 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 AndroidpublisherV1 - # Google Play Developer API - # - # Accesses Android application developers' Google Play accounts. - # - # @example - # require 'google/apis/androidpublisher_v1' - # - # Androidpublisher = Google::Apis::AndroidpublisherV1 # Alias the module - # service = Androidpublisher::AndroidPublisherService.new - # - # @see https://developers.google.com/android-publisher - class AndroidPublisherService < 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] - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - attr_accessor :quota_user - - # @return [String] - # Deprecated. Please use quotaUser instead. - attr_accessor :user_ip - - def initialize - super('https://www.googleapis.com/', '') - @batch_path = 'batch/androidpublisher/v1' - 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/androidpublisher_v1_1.rb b/generated/google/apis/androidpublisher_v1_1.rb deleted file mode 100644 index 4d31b9c4e..000000000 --- a/generated/google/apis/androidpublisher_v1_1.rb +++ /dev/null @@ -1,34 +0,0 @@ -# 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/androidpublisher_v1_1/service.rb' -require 'google/apis/androidpublisher_v1_1/classes.rb' -require 'google/apis/androidpublisher_v1_1/representations.rb' - -module Google - module Apis - # Google Play Developer API - # - # Accesses Android application developers' Google Play accounts. - # - # @see https://developers.google.com/android-publisher - module AndroidpublisherV1_1 - VERSION = 'V1_1' - REVISION = '20200428' - - # View and manage your Google Play Developer account - AUTH_ANDROIDPUBLISHER = 'https://www.googleapis.com/auth/androidpublisher' - end - end -end diff --git a/generated/google/apis/androidpublisher_v1_1/classes.rb b/generated/google/apis/androidpublisher_v1_1/classes.rb deleted file mode 100644 index 62cc2553e..000000000 --- a/generated/google/apis/androidpublisher_v1_1/classes.rb +++ /dev/null @@ -1,94 +0,0 @@ -# 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 AndroidpublisherV1_1 - - # An InappPurchase resource indicates the status of a user's inapp product - # purchase. - class InappPurchase - include Google::Apis::Core::Hashable - - # The consumption state of the inapp product. Possible values are: - # - Yet to be consumed - # - Consumed - # Corresponds to the JSON property `consumptionState` - # @return [Fixnum] - attr_accessor :consumption_state - - # A developer-specified string that contains supplemental information about an - # order. - # Corresponds to the JSON property `developerPayload` - # @return [String] - attr_accessor :developer_payload - - # This kind represents an inappPurchase object in the androidpublisher service. - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - # The order id associated with the purchase of the inapp product. - # Corresponds to the JSON property `orderId` - # @return [String] - attr_accessor :order_id - - # The purchase state of the order. Possible values are: - # - Purchased - # - Canceled - # - Pending - # Corresponds to the JSON property `purchaseState` - # @return [Fixnum] - attr_accessor :purchase_state - - # The time the product was purchased, in milliseconds since the epoch (Jan 1, - # 1970). - # Corresponds to the JSON property `purchaseTime` - # @return [Fixnum] - attr_accessor :purchase_time - - # The type of purchase of the inapp product. This field is only set if this - # purchase was not made using the standard in-app billing flow. Possible values - # are: - # - Test (i.e. purchased from a license testing account) - # - Promo (i.e. purchased using a promo code) - # - Rewarded (i.e. from watching a video ad instead of paying) - # Corresponds to the JSON property `purchaseType` - # @return [Fixnum] - attr_accessor :purchase_type - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @consumption_state = args[:consumption_state] if args.key?(:consumption_state) - @developer_payload = args[:developer_payload] if args.key?(:developer_payload) - @kind = args[:kind] if args.key?(:kind) - @order_id = args[:order_id] if args.key?(:order_id) - @purchase_state = args[:purchase_state] if args.key?(:purchase_state) - @purchase_time = args[:purchase_time] if args.key?(:purchase_time) - @purchase_type = args[:purchase_type] if args.key?(:purchase_type) - end - end - end - end -end diff --git a/generated/google/apis/androidpublisher_v1_1/representations.rb b/generated/google/apis/androidpublisher_v1_1/representations.rb deleted file mode 100644 index b6fa4dc02..000000000 --- a/generated/google/apis/androidpublisher_v1_1/representations.rb +++ /dev/null @@ -1,45 +0,0 @@ -# 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 AndroidpublisherV1_1 - - class InappPurchase - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class InappPurchase - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :consumption_state, as: 'consumptionState' - property :developer_payload, as: 'developerPayload' - property :kind, as: 'kind' - property :order_id, as: 'orderId' - property :purchase_state, as: 'purchaseState' - property :purchase_time, :numeric_string => true, as: 'purchaseTime' - property :purchase_type, as: 'purchaseType' - end - end - end - end -end diff --git a/generated/google/apis/androidpublisher_v1_1/service.rb b/generated/google/apis/androidpublisher_v1_1/service.rb deleted file mode 100644 index c6e343006..000000000 --- a/generated/google/apis/androidpublisher_v1_1/service.rb +++ /dev/null @@ -1,104 +0,0 @@ -# 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 AndroidpublisherV1_1 - # Google Play Developer API - # - # Accesses Android application developers' Google Play accounts. - # - # @example - # require 'google/apis/androidpublisher_v1_1' - # - # Androidpublisher = Google::Apis::AndroidpublisherV1_1 # Alias the module - # service = Androidpublisher::AndroidPublisherService.new - # - # @see https://developers.google.com/android-publisher - class AndroidPublisherService < 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] - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - attr_accessor :quota_user - - # @return [String] - # Deprecated. Please use quotaUser instead. - attr_accessor :user_ip - - def initialize - super('https://www.googleapis.com/', 'androidpublisher/v1.1/applications/') - @batch_path = 'batch/androidpublisher/v1.1' - end - - # Checks the purchase and consumption status of an inapp item. - # @param [String] package_name - # The package name of the application the inapp product was sold in (for example, - # 'com.some.thing'). - # @param [String] product_id - # The inapp product SKU (for example, 'com.some.thing.inapp1'). - # @param [String] token - # The token provided to the user's device when the inapp product was purchased. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::AndroidpublisherV1_1::InappPurchase] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::AndroidpublisherV1_1::InappPurchase] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_inapppurchase(package_name, product_id, token, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, '{packageName}/inapp/{productId}/purchases/{token}', options) - command.response_representation = Google::Apis::AndroidpublisherV1_1::InappPurchase::Representation - command.response_class = Google::Apis::AndroidpublisherV1_1::InappPurchase - command.params['packageName'] = package_name unless package_name.nil? - command.params['productId'] = product_id unless product_id.nil? - command.params['token'] = token unless token.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - 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/androidpublisher_v2.rb b/generated/google/apis/androidpublisher_v2.rb deleted file mode 100644 index efcef6355..000000000 --- a/generated/google/apis/androidpublisher_v2.rb +++ /dev/null @@ -1,34 +0,0 @@ -# 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/androidpublisher_v2/service.rb' -require 'google/apis/androidpublisher_v2/classes.rb' -require 'google/apis/androidpublisher_v2/representations.rb' - -module Google - module Apis - # Google Play Developer API - # - # Accesses Android application developers' Google Play accounts. - # - # @see https://developers.google.com/android-publisher - module AndroidpublisherV2 - VERSION = 'V2' - REVISION = '20200428' - - # View and manage your Google Play Developer account - AUTH_ANDROIDPUBLISHER = 'https://www.googleapis.com/auth/androidpublisher' - end - end -end diff --git a/generated/google/apis/androidpublisher_v2/classes.rb b/generated/google/apis/androidpublisher_v2/classes.rb deleted file mode 100644 index 5652ddb21..000000000 --- a/generated/google/apis/androidpublisher_v2/classes.rb +++ /dev/null @@ -1,223 +0,0 @@ -# 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 AndroidpublisherV2 - - # - class PageInfo - include Google::Apis::Core::Hashable - - # - # Corresponds to the JSON property `resultPerPage` - # @return [Fixnum] - attr_accessor :result_per_page - - # - # Corresponds to the JSON property `startIndex` - # @return [Fixnum] - attr_accessor :start_index - - # - # Corresponds to the JSON property `totalResults` - # @return [Fixnum] - attr_accessor :total_results - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @result_per_page = args[:result_per_page] if args.key?(:result_per_page) - @start_index = args[:start_index] if args.key?(:start_index) - @total_results = args[:total_results] if args.key?(:total_results) - end - end - - # A ProductPurchase resource indicates the status of a user's inapp product - # purchase. - class ProductPurchase - include Google::Apis::Core::Hashable - - # The consumption state of the inapp product. Possible values are: - # - Yet to be consumed - # - Consumed - # Corresponds to the JSON property `consumptionState` - # @return [Fixnum] - attr_accessor :consumption_state - - # A developer-specified string that contains supplemental information about an - # order. - # Corresponds to the JSON property `developerPayload` - # @return [String] - attr_accessor :developer_payload - - # This kind represents an inappPurchase object in the androidpublisher service. - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - # The order id associated with the purchase of the inapp product. - # Corresponds to the JSON property `orderId` - # @return [String] - attr_accessor :order_id - - # The purchase state of the order. Possible values are: - # - Purchased - # - Canceled - # - Pending - # Corresponds to the JSON property `purchaseState` - # @return [Fixnum] - attr_accessor :purchase_state - - # The time the product was purchased, in milliseconds since the epoch (Jan 1, - # 1970). - # Corresponds to the JSON property `purchaseTimeMillis` - # @return [Fixnum] - attr_accessor :purchase_time_millis - - # The type of purchase of the inapp product. This field is only set if this - # purchase was not made using the standard in-app billing flow. Possible values - # are: - # - Test (i.e. purchased from a license testing account) - # - Promo (i.e. purchased using a promo code) - # - Rewarded (i.e. from watching a video ad instead of paying) - # Corresponds to the JSON property `purchaseType` - # @return [Fixnum] - attr_accessor :purchase_type - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @consumption_state = args[:consumption_state] if args.key?(:consumption_state) - @developer_payload = args[:developer_payload] if args.key?(:developer_payload) - @kind = args[:kind] if args.key?(:kind) - @order_id = args[:order_id] if args.key?(:order_id) - @purchase_state = args[:purchase_state] if args.key?(:purchase_state) - @purchase_time_millis = args[:purchase_time_millis] if args.key?(:purchase_time_millis) - @purchase_type = args[:purchase_type] if args.key?(:purchase_type) - end - end - - # - class TokenPagination - include Google::Apis::Core::Hashable - - # - # Corresponds to the JSON property `nextPageToken` - # @return [String] - attr_accessor :next_page_token - - # - # Corresponds to the JSON property `previousPageToken` - # @return [String] - attr_accessor :previous_page_token - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @next_page_token = args[:next_page_token] if args.key?(:next_page_token) - @previous_page_token = args[:previous_page_token] if args.key?(:previous_page_token) - end - end - - # A VoidedPurchase resource indicates a purchase that was either canceled/ - # refunded/charged-back. - class VoidedPurchase - include Google::Apis::Core::Hashable - - # This kind represents a voided purchase object in the androidpublisher service. - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - # The time at which the purchase was made, in milliseconds since the epoch (Jan - # 1, 1970). - # Corresponds to the JSON property `purchaseTimeMillis` - # @return [Fixnum] - attr_accessor :purchase_time_millis - - # The token which uniquely identifies a one-time purchase or subscription. To - # uniquely identify subscription renewals use order_id (available starting from - # version 3 of the API). - # Corresponds to the JSON property `purchaseToken` - # @return [String] - attr_accessor :purchase_token - - # The time at which the purchase was canceled/refunded/charged-back, in - # milliseconds since the epoch (Jan 1, 1970). - # Corresponds to the JSON property `voidedTimeMillis` - # @return [Fixnum] - attr_accessor :voided_time_millis - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @kind = args[:kind] if args.key?(:kind) - @purchase_time_millis = args[:purchase_time_millis] if args.key?(:purchase_time_millis) - @purchase_token = args[:purchase_token] if args.key?(:purchase_token) - @voided_time_millis = args[:voided_time_millis] if args.key?(:voided_time_millis) - end - end - - # - class VoidedPurchasesListResponse - include Google::Apis::Core::Hashable - - # - # Corresponds to the JSON property `pageInfo` - # @return [Google::Apis::AndroidpublisherV2::PageInfo] - attr_accessor :page_info - - # - # Corresponds to the JSON property `tokenPagination` - # @return [Google::Apis::AndroidpublisherV2::TokenPagination] - attr_accessor :token_pagination - - # - # Corresponds to the JSON property `voidedPurchases` - # @return [Array] - attr_accessor :voided_purchases - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @page_info = args[:page_info] if args.key?(:page_info) - @token_pagination = args[:token_pagination] if args.key?(:token_pagination) - @voided_purchases = args[:voided_purchases] if args.key?(:voided_purchases) - end - end - end - end -end diff --git a/generated/google/apis/androidpublisher_v2/service.rb b/generated/google/apis/androidpublisher_v2/service.rb deleted file mode 100644 index 38880ec0b..000000000 --- a/generated/google/apis/androidpublisher_v2/service.rb +++ /dev/null @@ -1,160 +0,0 @@ -# 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 AndroidpublisherV2 - # Google Play Developer API - # - # Accesses Android application developers' Google Play accounts. - # - # @example - # require 'google/apis/androidpublisher_v2' - # - # Androidpublisher = Google::Apis::AndroidpublisherV2 # Alias the module - # service = Androidpublisher::AndroidPublisherService.new - # - # @see https://developers.google.com/android-publisher - class AndroidPublisherService < 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] - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - attr_accessor :quota_user - - # @return [String] - # Deprecated. Please use quotaUser instead. - attr_accessor :user_ip - - def initialize - super('https://www.googleapis.com/', 'androidpublisher/v2/applications/') - @batch_path = 'batch/androidpublisher/v2' - end - - # Checks the purchase and consumption status of an inapp item. - # @param [String] package_name - # The package name of the application the inapp product was sold in (for example, - # 'com.some.thing'). - # @param [String] product_id - # The inapp product SKU (for example, 'com.some.thing.inapp1'). - # @param [String] token - # The token provided to the user's device when the inapp product was purchased. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::AndroidpublisherV2::ProductPurchase] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::AndroidpublisherV2::ProductPurchase] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_purchase_product(package_name, product_id, token, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, '{packageName}/purchases/products/{productId}/tokens/{token}', options) - command.response_representation = Google::Apis::AndroidpublisherV2::ProductPurchase::Representation - command.response_class = Google::Apis::AndroidpublisherV2::ProductPurchase - command.params['packageName'] = package_name unless package_name.nil? - command.params['productId'] = product_id unless product_id.nil? - command.params['token'] = token unless token.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Lists the purchases that were canceled, refunded or charged-back. - # @param [String] package_name - # The package name of the application for which voided purchases need to be - # returned (for example, 'com.some.thing'). - # @param [Fixnum] end_time - # The time, in milliseconds since the Epoch, of the newest voided purchase that - # you want to see in the response. The value of this parameter cannot be greater - # than the current time and is ignored if a pagination token is set. Default - # value is current time. Note: This filter is applied on the time at which the - # record is seen as voided by our systems and not the actual voided time - # returned in the response. - # @param [Fixnum] max_results - # @param [Fixnum] start_index - # @param [Fixnum] start_time - # The time, in milliseconds since the Epoch, of the oldest voided purchase that - # you want to see in the response. The value of this parameter cannot be older - # than 30 days and is ignored if a pagination token is set. Default value is - # current time minus 30 days. Note: This filter is applied on the time at which - # the record is seen as voided by our systems and not the actual voided time - # returned in the response. - # @param [String] token - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::AndroidpublisherV2::VoidedPurchasesListResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::AndroidpublisherV2::VoidedPurchasesListResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_purchase_voidedpurchases(package_name, end_time: nil, max_results: nil, start_index: nil, start_time: nil, token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, '{packageName}/purchases/voidedpurchases', options) - command.response_representation = Google::Apis::AndroidpublisherV2::VoidedPurchasesListResponse::Representation - command.response_class = Google::Apis::AndroidpublisherV2::VoidedPurchasesListResponse - command.params['packageName'] = package_name unless package_name.nil? - command.query['endTime'] = end_time unless end_time.nil? - command.query['maxResults'] = max_results unless max_results.nil? - command.query['startIndex'] = start_index unless start_index.nil? - command.query['startTime'] = start_time unless start_time.nil? - command.query['token'] = token unless token.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - 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/appsmarket_v2.rb b/generated/google/apis/appsmarket_v2.rb index efe4c2fcf..5d76d5d06 100644 --- a/generated/google/apis/appsmarket_v2.rb +++ b/generated/google/apis/appsmarket_v2.rb @@ -26,7 +26,7 @@ module Google # @see https://developers.google.com/apps-marketplace module AppsmarketV2 VERSION = 'V2' - REVISION = '20200615' + REVISION = '20200706' # View your installed application's licensing information AUTH_APPSMARKETPLACE_LICENSE = 'https://www.googleapis.com/auth/appsmarketplace.license' diff --git a/generated/google/apis/bigqueryreservation_v1.rb b/generated/google/apis/bigqueryreservation_v1.rb index f95f03957..bfd10ff6a 100644 --- a/generated/google/apis/bigqueryreservation_v1.rb +++ b/generated/google/apis/bigqueryreservation_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/bigquery/ module BigqueryreservationV1 VERSION = 'V1' - REVISION = '20200619' + REVISION = '20200702' # View and manage your data in Google BigQuery AUTH_BIGQUERY = 'https://www.googleapis.com/auth/bigquery' diff --git a/generated/google/apis/bigqueryreservation_v1/classes.rb b/generated/google/apis/bigqueryreservation_v1/classes.rb index 3c7532b09..bae2cea83 100644 --- a/generated/google/apis/bigqueryreservation_v1/classes.rb +++ b/generated/google/apis/bigqueryreservation_v1/classes.rb @@ -113,6 +113,13 @@ module Google # @return [String] attr_accessor :commitment_end_time + # Output only. The start of the current commitment period. It is applicable only + # for + # ACTIVE capacity commitments. + # Corresponds to the JSON property `commitmentStartTime` + # @return [String] + attr_accessor :commitment_start_time + # The `Status` type defines a logical error model that is suitable for # different programming environments, including REST APIs and RPC APIs. It is # used by [gRPC](https://github.com/grpc). Each `Status` message contains @@ -158,6 +165,7 @@ module Google # Update properties of this object def update!(**args) @commitment_end_time = args[:commitment_end_time] if args.key?(:commitment_end_time) + @commitment_start_time = args[:commitment_start_time] if args.key?(:commitment_start_time) @failure_status = args[:failure_status] if args.key?(:failure_status) @name = args[:name] if args.key?(:name) @plan = args[:plan] if args.key?(:plan) @@ -465,6 +473,32 @@ module Google end end + # The response for ReservationService.SearchAllAssignments. + class SearchAllAssignmentsResponse + include Google::Apis::Core::Hashable + + # List of assignments visible to the user. + # Corresponds to the JSON property `assignments` + # @return [Array] + attr_accessor :assignments + + # Token to retrieve the next page of results, or empty if there are no + # more results in the list. + # 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) + @assignments = args[:assignments] if args.key?(:assignments) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + end + end + # The response for ReservationService.SearchAssignments. class SearchAssignmentsResponse include Google::Apis::Core::Hashable diff --git a/generated/google/apis/bigqueryreservation_v1/representations.rb b/generated/google/apis/bigqueryreservation_v1/representations.rb index bf5984f64..c44fa04f3 100644 --- a/generated/google/apis/bigqueryreservation_v1/representations.rb +++ b/generated/google/apis/bigqueryreservation_v1/representations.rb @@ -100,6 +100,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class SearchAllAssignmentsResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class SearchAssignmentsResponse class Representation < Google::Apis::Core::JsonRepresentation; end @@ -147,6 +153,7 @@ module Google # @private class Representation < Google::Apis::Core::JsonRepresentation property :commitment_end_time, as: 'commitmentEndTime' + property :commitment_start_time, as: 'commitmentStartTime' property :failure_status, as: 'failureStatus', class: Google::Apis::BigqueryreservationV1::Status, decorator: Google::Apis::BigqueryreservationV1::Status::Representation property :name, as: 'name' @@ -241,6 +248,15 @@ module Google end end + class SearchAllAssignmentsResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :assignments, as: 'assignments', class: Google::Apis::BigqueryreservationV1::Assignment, decorator: Google::Apis::BigqueryreservationV1::Assignment::Representation + + property :next_page_token, as: 'nextPageToken' + end + end + class SearchAssignmentsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation diff --git a/generated/google/apis/bigqueryreservation_v1/service.rb b/generated/google/apis/bigqueryreservation_v1/service.rb index 6d60525e0..1340b90fe 100644 --- a/generated/google/apis/bigqueryreservation_v1/service.rb +++ b/generated/google/apis/bigqueryreservation_v1/service.rb @@ -158,6 +158,66 @@ module Google execute_or_queue_command(command, &block) end + # Looks up assignments for a specified resource for a particular region. + # If the request is about a project: + # 1. Assignments created on the project will be returned if they exist. + # 2. Otherwise assignments created on the closest ancestor will be + # returned. + # 3. Assignments for different JobTypes will all be returned. + # The same logic applies if the request is about a folder. + # If the request is about an organization, then assignments created on the + # organization will be returned (organization doesn't have ancestors). + # Comparing to ListAssignments, there are some behavior + # differences: + # 1. permission on the assignee will be verified in this API. + # 2. Hierarchy lookup (project->folder->organization) happens in this API. + # 3. Parent here is `projects/*/locations/*`, instead of + # `projects/*/locations/*reservations/*`. + # @param [String] parent + # Required. The resource name with location (project name could be the wildcard ' + # -'), + # e.g.: + # `projects/-/locations/US`. + # @param [Fixnum] page_size + # The maximum number of items to return per page. + # @param [String] page_token + # The next_page_token value returned from a previous List request, if any. + # @param [String] query + # Please specify resource name as assignee in the query. + # Examples: + # * `assignee=projects/myproject` + # * `assignee=folders/123` + # * `assignee=organizations/456` + # @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::BigqueryreservationV1::SearchAllAssignmentsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::BigqueryreservationV1::SearchAllAssignmentsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def search_project_location_all_assignments(parent, page_size: nil, page_token: nil, query: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+parent}:searchAllAssignments', options) + command.response_representation = Google::Apis::BigqueryreservationV1::SearchAllAssignmentsResponse::Representation + command.response_class = Google::Apis::BigqueryreservationV1::SearchAllAssignmentsResponse + command.params['parent'] = parent unless parent.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['query'] = query unless query.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + # Looks up assignments for a specified resource for a particular region. # If the request is about a project: # 1. Assignments created on the project will be returned if they exist. diff --git a/generated/google/apis/bigqueryreservation_v1beta1.rb b/generated/google/apis/bigqueryreservation_v1beta1.rb index 6efd6b06c..732c82421 100644 --- a/generated/google/apis/bigqueryreservation_v1beta1.rb +++ b/generated/google/apis/bigqueryreservation_v1beta1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/bigquery/ module BigqueryreservationV1beta1 VERSION = 'V1beta1' - REVISION = '20200619' + REVISION = '20200702' # View and manage your data in Google BigQuery AUTH_BIGQUERY = 'https://www.googleapis.com/auth/bigquery' diff --git a/generated/google/apis/bigqueryreservation_v1beta1/classes.rb b/generated/google/apis/bigqueryreservation_v1beta1/classes.rb index 2be2d5a36..06fbff9e2 100644 --- a/generated/google/apis/bigqueryreservation_v1beta1/classes.rb +++ b/generated/google/apis/bigqueryreservation_v1beta1/classes.rb @@ -113,6 +113,13 @@ module Google # @return [String] attr_accessor :commitment_end_time + # Output only. The start of the current commitment period. It is applicable only + # for + # ACTIVE capacity commitments. + # Corresponds to the JSON property `commitmentStartTime` + # @return [String] + attr_accessor :commitment_start_time + # The `Status` type defines a logical error model that is suitable for # different programming environments, including REST APIs and RPC APIs. It is # used by [gRPC](https://github.com/grpc). Each `Status` message contains @@ -158,6 +165,7 @@ module Google # Update properties of this object def update!(**args) @commitment_end_time = args[:commitment_end_time] if args.key?(:commitment_end_time) + @commitment_start_time = args[:commitment_start_time] if args.key?(:commitment_start_time) @failure_status = args[:failure_status] if args.key?(:failure_status) @name = args[:name] if args.key?(:name) @plan = args[:plan] if args.key?(:plan) diff --git a/generated/google/apis/bigqueryreservation_v1beta1/representations.rb b/generated/google/apis/bigqueryreservation_v1beta1/representations.rb index 6cb92b796..73a326693 100644 --- a/generated/google/apis/bigqueryreservation_v1beta1/representations.rb +++ b/generated/google/apis/bigqueryreservation_v1beta1/representations.rb @@ -135,6 +135,7 @@ module Google # @private class Representation < Google::Apis::Core::JsonRepresentation property :commitment_end_time, as: 'commitmentEndTime' + property :commitment_start_time, as: 'commitmentStartTime' property :failure_status, as: 'failureStatus', class: Google::Apis::BigqueryreservationV1beta1::Status, decorator: Google::Apis::BigqueryreservationV1beta1::Status::Representation property :name, as: 'name' diff --git a/generated/google/apis/classroom_v1.rb b/generated/google/apis/classroom_v1.rb index 973b8d0e9..39873c15d 100644 --- a/generated/google/apis/classroom_v1.rb +++ b/generated/google/apis/classroom_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/classroom/ module ClassroomV1 VERSION = 'V1' - REVISION = '20200408' + REVISION = '20200706' # View and manage announcements in Google Classroom AUTH_CLASSROOM_ANNOUNCEMENTS = 'https://www.googleapis.com/auth/classroom.announcements' diff --git a/generated/google/apis/classroom_v1/service.rb b/generated/google/apis/classroom_v1/service.rb index bf4185fef..d5b1e805a 100644 --- a/generated/google/apis/classroom_v1/service.rb +++ b/generated/google/apis/classroom_v1/service.rb @@ -1626,7 +1626,7 @@ module Google # This identifier can be either the Classroom-assigned identifier or an # alias. # @param [Fixnum] page_size - # Maximum number of items to return. Zero means no maximum. + # Maximum number of items to return. The default is 30 if unspecified or `0`. # The server may return fewer than the specified number of results. # @param [String] page_token # nextPageToken @@ -1811,7 +1811,7 @@ module Google # This identifier can be either the Classroom-assigned identifier or an # alias. # @param [Fixnum] page_size - # Maximum number of items to return. Zero means no maximum. + # Maximum number of items to return. The default is 30 if unspecified or `0`. # The server may return fewer than the specified number of results. # @param [String] page_token # nextPageToken @@ -2231,7 +2231,8 @@ module Google # Restricts returned invitations to those for a course with the specified # identifier. # @param [Fixnum] page_size - # Maximum number of items to return. Zero means no maximum. + # Maximum number of items to return. The default is 500 if unspecified or + # `0`. # The server may return fewer than the specified number of results. # @param [String] page_token # nextPageToken diff --git a/generated/google/apis/androidpublisher_v1.rb b/generated/google/apis/customsearch_v1.rb similarity index 63% rename from generated/google/apis/androidpublisher_v1.rb rename to generated/google/apis/customsearch_v1.rb index d3aa740dc..e78cd98be 100644 --- a/generated/google/apis/androidpublisher_v1.rb +++ b/generated/google/apis/customsearch_v1.rb @@ -12,20 +12,20 @@ # See the License for the specific language governing permissions and # limitations under the License. -require 'google/apis/androidpublisher_v1/service.rb' -require 'google/apis/androidpublisher_v1/classes.rb' -require 'google/apis/androidpublisher_v1/representations.rb' +require 'google/apis/customsearch_v1/service.rb' +require 'google/apis/customsearch_v1/classes.rb' +require 'google/apis/customsearch_v1/representations.rb' module Google module Apis - # Google Play Developer API + # Custom Search API # - # Accesses Android application developers' Google Play accounts. + # Searches over a website or collection of websites # - # @see https://developers.google.com/android-publisher - module AndroidpublisherV1 + # @see https://developers.google.com/custom-search/v1/introduction + module CustomsearchV1 VERSION = 'V1' - REVISION = '20200428' + REVISION = '20200707' end end end diff --git a/generated/google/apis/customsearch_v1/classes.rb b/generated/google/apis/customsearch_v1/classes.rb new file mode 100644 index 000000000..35607e2d3 --- /dev/null +++ b/generated/google/apis/customsearch_v1/classes.rb @@ -0,0 +1,1606 @@ +# 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 CustomsearchV1 + + # Promotion result. + class Promotion + include Google::Apis::Core::Hashable + + # An array of block objects for this promotion. See [Google WebSearch + # Protocol + # reference](https://developers.google.com/custom-search/docs/xml_results) + # for more information. + # Corresponds to the JSON property `bodyLines` + # @return [Array] + attr_accessor :body_lines + + # An abridged version of this search's result URL, e.g. www.example.com. + # Corresponds to the JSON property `displayLink` + # @return [String] + attr_accessor :display_link + + # The title of the promotion, in HTML. + # Corresponds to the JSON property `htmlTitle` + # @return [String] + attr_accessor :html_title + + # Image belonging to a promotion. + # Corresponds to the JSON property `image` + # @return [Google::Apis::CustomsearchV1::Promotion::Image] + attr_accessor :image + + # The URL of the promotion. + # Corresponds to the JSON property `link` + # @return [String] + attr_accessor :link + + # The title of the promotion. + # Corresponds to the JSON property `title` + # @return [String] + attr_accessor :title + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @body_lines = args[:body_lines] if args.key?(:body_lines) + @display_link = args[:display_link] if args.key?(:display_link) + @html_title = args[:html_title] if args.key?(:html_title) + @image = args[:image] if args.key?(:image) + @link = args[:link] if args.key?(:link) + @title = args[:title] if args.key?(:title) + end + + # Block object belonging to a promotion. + class BodyLine + include Google::Apis::Core::Hashable + + # The block object's text in HTML, if it has text. + # Corresponds to the JSON property `htmlTitle` + # @return [String] + attr_accessor :html_title + + # The anchor text of the block object's link, if it has a link. + # Corresponds to the JSON property `link` + # @return [String] + attr_accessor :link + + # The block object's text, if it has text. + # Corresponds to the JSON property `title` + # @return [String] + attr_accessor :title + + # The URL of the block object's link, if it has one. + # Corresponds to the JSON property `url` + # @return [String] + attr_accessor :url + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @html_title = args[:html_title] if args.key?(:html_title) + @link = args[:link] if args.key?(:link) + @title = args[:title] if args.key?(:title) + @url = args[:url] if args.key?(:url) + end + end + + # Image belonging to a promotion. + class Image + include Google::Apis::Core::Hashable + + # Image height in pixels. + # Corresponds to the JSON property `height` + # @return [Fixnum] + attr_accessor :height + + # URL of the image for this promotion link. + # Corresponds to the JSON property `source` + # @return [String] + attr_accessor :source + + # Image width 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) + @height = args[:height] if args.key?(:height) + @source = args[:source] if args.key?(:source) + @width = args[:width] if args.key?(:width) + end + end + end + + # A custom search result. + class Result + include Google::Apis::Core::Hashable + + # Indicates the ID of Google's cached version of the search result. + # Corresponds to the JSON property `cacheId` + # @return [String] + attr_accessor :cache_id + + # An abridged version of this search result’s URL, e.g. www.example.com. + # Corresponds to the JSON property `displayLink` + # @return [String] + attr_accessor :display_link + + # The file format of the search result. + # Corresponds to the JSON property `fileFormat` + # @return [String] + attr_accessor :file_format + + # The URL displayed after the snippet for each search result. + # Corresponds to the JSON property `formattedUrl` + # @return [String] + attr_accessor :formatted_url + + # The HTML-formatted URL displayed after the snippet for each search result. + # Corresponds to the JSON property `htmlFormattedUrl` + # @return [String] + attr_accessor :html_formatted_url + + # The snippet of the search result, in HTML. + # Corresponds to the JSON property `htmlSnippet` + # @return [String] + attr_accessor :html_snippet + + # The title of the search result, in HTML. + # Corresponds to the JSON property `htmlTitle` + # @return [String] + attr_accessor :html_title + + # Image belonging to a custom search result. + # Corresponds to the JSON property `image` + # @return [Google::Apis::CustomsearchV1::Result::Image] + attr_accessor :image + + # A unique identifier for the type of current object. For this API, it is + # `customsearch#result.` + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Encapsulates all information about [refinement + # labels](https://developers.google.com/custom-search/docs/xml_results). + # Corresponds to the JSON property `labels` + # @return [Array] + attr_accessor :labels + + # The full URL to which the search result is pointing, e.g. + # http://www.example.com/foo/bar. + # Corresponds to the JSON property `link` + # @return [String] + attr_accessor :link + + # The MIME type of the search result. + # Corresponds to the JSON property `mime` + # @return [String] + attr_accessor :mime + + # Contains + # [PageMap](https://developers.google.com/custom-search/docs/structured_data# + # pagemaps) + # information for this search result. + # Corresponds to the JSON property `pagemap` + # @return [Hash] + attr_accessor :pagemap + + # The snippet of the search result, in plain text. + # Corresponds to the JSON property `snippet` + # @return [String] + attr_accessor :snippet + + # The title of the search result, in plain text. + # Corresponds to the JSON property `title` + # @return [String] + attr_accessor :title + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @cache_id = args[:cache_id] if args.key?(:cache_id) + @display_link = args[:display_link] if args.key?(:display_link) + @file_format = args[:file_format] if args.key?(:file_format) + @formatted_url = args[:formatted_url] if args.key?(:formatted_url) + @html_formatted_url = args[:html_formatted_url] if args.key?(:html_formatted_url) + @html_snippet = args[:html_snippet] if args.key?(:html_snippet) + @html_title = args[:html_title] if args.key?(:html_title) + @image = args[:image] if args.key?(:image) + @kind = args[:kind] if args.key?(:kind) + @labels = args[:labels] if args.key?(:labels) + @link = args[:link] if args.key?(:link) + @mime = args[:mime] if args.key?(:mime) + @pagemap = args[:pagemap] if args.key?(:pagemap) + @snippet = args[:snippet] if args.key?(:snippet) + @title = args[:title] if args.key?(:title) + end + + # Image belonging to a custom search result. + class Image + include Google::Apis::Core::Hashable + + # The size of the image, in pixels. + # Corresponds to the JSON property `byteSize` + # @return [Fixnum] + attr_accessor :byte_size + + # A URL pointing to the webpage hosting the image. + # Corresponds to the JSON property `contextLink` + # @return [String] + attr_accessor :context_link + + # The height of the image, in pixels. + # Corresponds to the JSON property `height` + # @return [Fixnum] + attr_accessor :height + + # The height of the thumbnail image, in pixels. + # Corresponds to the JSON property `thumbnailHeight` + # @return [Fixnum] + attr_accessor :thumbnail_height + + # A URL to the thumbnail image. + # Corresponds to the JSON property `thumbnailLink` + # @return [String] + attr_accessor :thumbnail_link + + # The width of the thumbnail image, in pixels. + # Corresponds to the JSON property `thumbnailWidth` + # @return [Fixnum] + attr_accessor :thumbnail_width + + # 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) + @byte_size = args[:byte_size] if args.key?(:byte_size) + @context_link = args[:context_link] if args.key?(:context_link) + @height = args[:height] if args.key?(:height) + @thumbnail_height = args[:thumbnail_height] if args.key?(:thumbnail_height) + @thumbnail_link = args[:thumbnail_link] if args.key?(:thumbnail_link) + @thumbnail_width = args[:thumbnail_width] if args.key?(:thumbnail_width) + @width = args[:width] if args.key?(:width) + end + end + + # Refinement label associated with a custom search result. + class Label + include Google::Apis::Core::Hashable + + # The display name of a refinement label. This is the name you should + # display in your user interface. + # Corresponds to the JSON property `displayName` + # @return [String] + attr_accessor :display_name + + # Refinement label and the associated refinement operation. + # Corresponds to the JSON property `label_with_op` + # @return [String] + attr_accessor :label_with_op + + # The name of a refinement label, which you can use to refine searches. + # Don't display this in your user interface; instead, use displayName. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @display_name = args[:display_name] if args.key?(:display_name) + @label_with_op = args[:label_with_op] if args.key?(:label_with_op) + @name = args[:name] if args.key?(:name) + end + end + end + + # Response to a custom search request. + class Search + include Google::Apis::Core::Hashable + + # Metadata and refinements associated with the given search engine, + # including: + # * The name of the search engine that was used for the query. + # * A set of [facet + # objects](https://developers.google.com/custom-search/docs/refinements#create) + # (refinements) you can use for refining a search. + # Corresponds to the JSON property `context` + # @return [Hash] + attr_accessor :context + + # The current set of custom search results. + # Corresponds to the JSON property `items` + # @return [Array] + attr_accessor :items + + # Unique identifier for the type of current object. For this API, it is + # customsearch#search. + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # The set of + # [promotions](https://developers.google.com/custom-search/docs/promotions). + # Present only if the custom search engine's configuration files define any + # promotions for the given query. + # Corresponds to the JSON property `promotions` + # @return [Array] + attr_accessor :promotions + + # Query metadata for the previous, current, and next pages of results. + # Corresponds to the JSON property `queries` + # @return [Google::Apis::CustomsearchV1::Search::Queries] + attr_accessor :queries + + # Metadata about a search operation. + # Corresponds to the JSON property `searchInformation` + # @return [Google::Apis::CustomsearchV1::Search::SearchInformation] + attr_accessor :search_information + + # Spell correction information for a query. + # Corresponds to the JSON property `spelling` + # @return [Google::Apis::CustomsearchV1::Search::Spelling] + attr_accessor :spelling + + # OpenSearch template and URL. + # Corresponds to the JSON property `url` + # @return [Google::Apis::CustomsearchV1::Search::Url] + attr_accessor :url + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @context = args[:context] if args.key?(:context) + @items = args[:items] if args.key?(:items) + @kind = args[:kind] if args.key?(:kind) + @promotions = args[:promotions] if args.key?(:promotions) + @queries = args[:queries] if args.key?(:queries) + @search_information = args[:search_information] if args.key?(:search_information) + @spelling = args[:spelling] if args.key?(:spelling) + @url = args[:url] if args.key?(:url) + end + + # Query metadata for the previous, current, and next pages of results. + class Queries + include Google::Apis::Core::Hashable + + # Metadata representing the next page of results, if applicable. + # Corresponds to the JSON property `nextPage` + # @return [Array] + attr_accessor :next_page + + # Metadata representing the previous page of results, if applicable. + # Corresponds to the JSON property `previousPage` + # @return [Array] + attr_accessor :previous_page + + # Metadata representing the current request. + # Corresponds to the JSON property `request` + # @return [Array] + attr_accessor :request + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @next_page = args[:next_page] if args.key?(:next_page) + @previous_page = args[:previous_page] if args.key?(:previous_page) + @request = args[:request] if args.key?(:request) + end + + # Custom search request metadata. + class NextPage + include Google::Apis::Core::Hashable + + # Number of search results returned in this set. + # Corresponds to the JSON property `count` + # @return [Fixnum] + attr_accessor :count + + # Restricts search results to documents originating in a particular + # country. You may use [Boolean + # operators](https://developers.google.com/custom-search/docs/xml_results# + # booleanOperators) + # in the `cr` parameter's value. + # Google WebSearch determines the country of a document by analyzing the + # following: + # * The top-level domain (TLD) of the document's URL. + # * The geographic location of the web server's IP address. + # See [Country (cr) Parameter + # Values](https://developers.google.com/custom-search/docs/xml_results# + # countryCollections) + # for a list of valid values for this parameter. + # Corresponds to the JSON property `cr` + # @return [String] + attr_accessor :cr + + # The identifier of a custom search engine created using the Custom Search + # [Control Panel](https://cse.google.com/). This is a custom property not + # defined in the OpenSearch spec. This parameter is **required**. + # Corresponds to the JSON property `cx` + # @return [String] + attr_accessor :cx + + # Restricts results to URLs based on date. Supported values include: + # * `d[number]`: requests results from the specified number of past days. + # * `w[number]`: requests results from the specified number of past weeks. + # * `m[number]`: requests results from the specified number of past months. + # * `y[number]`: requests results from the specified number of past years. + # Corresponds to the JSON property `dateRestrict` + # @return [String] + attr_accessor :date_restrict + + # Enables or disables the [Simplified and Traditional Chinese + # Search](https://developers.google.com/custom-search/docs/xml_results# + # chineseSearch) + # feature. + # Supported values are: + # * `0`: enabled (default) + # * `1`: disabled + # Corresponds to the JSON property `disableCnTwTranslation` + # @return [String] + attr_accessor :disable_cn_tw_translation + + # Identifies a phrase that all documents in the search results must + # contain. + # Corresponds to the JSON property `exactTerms` + # @return [String] + attr_accessor :exact_terms + + # Identifies a word or phrase that should not appear in any documents in + # the search results. + # Corresponds to the JSON property `excludeTerms` + # @return [String] + attr_accessor :exclude_terms + + # Restricts results to files of a specified extension. Filetypes supported + # by Google include: + # * Adobe Portable Document Format (`pdf`) + # * Adobe PostScript (`ps`) + # * Lotus 1-2-3 (`wk1`, `wk2`, `wk3`, `wk4`, `wk5`, `wki`, `wks`, `wku`) + # * Lotus WordPro (`lwp`) + # * Macwrite (`mw`) + # * Microsoft Excel (`xls`) + # * Microsoft PowerPoint (`ppt`) + # * Microsoft Word (`doc`) + # * Microsoft Works (`wks`, `wps`, `wdb`) + # * Microsoft Write (`wri`) + # * Rich Text Format (`rtf`) + # * Shockwave Flash (`swf`) + # * Text (`ans`, `txt`). + # Additional filetypes may be added in the future. An up-to-date list can + # always be found in Google's [file type + # FAQ](https://support.google.com/webmasters/answer/35287). + # Corresponds to the JSON property `fileType` + # @return [String] + attr_accessor :file_type + + # Activates or deactivates the automatic filtering of Google search + # results. See [Automatic + # Filtering](https://developers.google.com/custom-search/docs/xml_results# + # automaticFiltering) + # for more information about Google's search results filters. Valid values + # for this parameter are: + # * `0`: Disabled + # * `1`: Enabled (default) + # **Note**: By default, Google applies filtering to all search results to + # improve the quality of those results. + # Corresponds to the JSON property `filter` + # @return [String] + attr_accessor :filter + + # Boosts search results whose country of origin matches the parameter + # value. See [Country + # Codes](https://developers.google.com/custom-search/docs/xml_results# + # countryCodes) + # for a list of valid values. + # Specifying a `gl` parameter value in WebSearch requests should improve + # the relevance of results. This is particularly true for international + # customers and, even more specifically, for customers in English-speaking + # countries other than the United States. + # Corresponds to the JSON property `gl` + # @return [String] + attr_accessor :gl + + # Specifies the Google domain (for example, google.com, google.de, or + # google.fr) to which the search should be limited. + # Corresponds to the JSON property `googleHost` + # @return [String] + attr_accessor :google_host + + # Specifies the ending value for a search range. Use `cse:lowRange` and + # `cse:highrange` to append an inclusive search range of + # `lowRange...highRange` to the query. + # Corresponds to the JSON property `highRange` + # @return [String] + attr_accessor :high_range + + # Specifies the interface language (host language) of your user interface. + # Explicitly setting this parameter improves the performance and the + # quality of your search results. + # See the [Interface + # Languages](https://developers.google.com/custom-search/docs/xml_results# + # wsInterfaceLanguages) + # section of [Internationalizing Queries and Results + # Presentation](https://developers.google.com/custom-search/docs/xml_results# + # wsInternationalizing) + # for more information, and [Supported Interface + # Languages](https://developers.google.com/custom-search/docs/ + # xml_results_appendices#interfaceLanguages) + # for a list of supported languages. + # Corresponds to the JSON property `hl` + # @return [String] + attr_accessor :hl + + # Appends the specified query terms to the query, as if they were combined + # with a logical `AND` operator. + # Corresponds to the JSON property `hq` + # @return [String] + attr_accessor :hq + + # Restricts results to images of a specified color type. Supported values + # are: + # * `mono` (black and white) + # * `gray` (grayscale) + # * `color` (color) + # Corresponds to the JSON property `imgColorType` + # @return [String] + attr_accessor :img_color_type + + # Restricts results to images with a specific dominant color. Supported + # values are: + # * `red` + # * `orange` + # * `yellow` + # * `green` + # * `teal` + # * `blue` + # * `purple` + # * `pink` + # * `white` + # * `gray` + # * `black` + # * `brown` + # Corresponds to the JSON property `imgDominantColor` + # @return [String] + attr_accessor :img_dominant_color + + # Restricts results to images of a specified size. Supported values are: + # * `icon` (small) + # * `small | medium | large | xlarge` (medium) + # * `xxlarge` (large) + # * `huge` (extra-large) + # Corresponds to the JSON property `imgSize` + # @return [String] + attr_accessor :img_size + + # Restricts results to images of a specified type. Supported values are: + # * `clipart` (Clip art) + # * `face` (Face) + # * `lineart` (Line drawing) + # * `photo` (Photo) + # * `animated` (Animated) + # * `stock` (Stock) + # Corresponds to the JSON property `imgType` + # @return [String] + attr_accessor :img_type + + # The character encoding supported for search requests. + # Corresponds to the JSON property `inputEncoding` + # @return [String] + attr_accessor :input_encoding + + # The language of the search results. + # Corresponds to the JSON property `language` + # @return [String] + attr_accessor :language + + # Specifies that all results should contain a link to a specific URL. + # Corresponds to the JSON property `linkSite` + # @return [String] + attr_accessor :link_site + + # Specifies the starting value for a search range. Use `cse:lowRange` and + # `cse:highrange` to append an inclusive search range of + # `lowRange...highRange` to the query. + # Corresponds to the JSON property `lowRange` + # @return [String] + attr_accessor :low_range + + # Provides additional search terms to check for in a document, where each + # document in the search results must contain at least one of the + # additional search terms. You can also use the [Boolean + # OR](https://developers.google.com/custom-search/docs/xml_results#BooleanOrqt) + # query term for this type of query. + # Corresponds to the JSON property `orTerms` + # @return [String] + attr_accessor :or_terms + + # The character encoding supported for search results. + # Corresponds to the JSON property `outputEncoding` + # @return [String] + attr_accessor :output_encoding + + # Specifies that all search results should be pages that are related to the + # specified URL. The parameter value should be a URL. + # Corresponds to the JSON property `relatedSite` + # @return [String] + attr_accessor :related_site + + # Filters based on licensing. Supported values include: + # * `cc_publicdomain` + # * `cc_attribute` + # * `cc_sharealike` + # * `cc_noncommercial` + # * `cc_nonderived` + # Corresponds to the JSON property `rights` + # @return [String] + attr_accessor :rights + + # Specifies the [SafeSearch + # level](https://developers.google.com/custom-search/docs/xml_results# + # safeSearchLevels) + # used for filtering out adult results. This is a custom property not + # defined in the OpenSearch spec. Valid parameter values are: + # * `"off"`: Disable SafeSearch + # * `"active"`: Enable SafeSearch + # Corresponds to the JSON property `safe` + # @return [String] + attr_accessor :safe + + # The search terms entered by the user. + # Corresponds to the JSON property `searchTerms` + # @return [String] + attr_accessor :search_terms + + # Allowed values are `web` or `image`. If unspecified, results are limited + # to webpages. + # Corresponds to the JSON property `searchType` + # @return [String] + attr_accessor :search_type + + # Restricts results to URLs from a specified site. + # Corresponds to the JSON property `siteSearch` + # @return [String] + attr_accessor :site_search + + # Specifies whether to include or exclude results from the site named in + # the `sitesearch` parameter. Supported values are: + # * `i`: include content from site + # * `e`: exclude content from site + # Corresponds to the JSON property `siteSearchFilter` + # @return [String] + attr_accessor :site_search_filter + + # Specifies that results should be sorted according to the specified + # expression. For example, sort by date. + # Corresponds to the JSON property `sort` + # @return [String] + attr_accessor :sort + + # The index of the current set of search results into the total set of + # results, where the index of the first result is 1. + # Corresponds to the JSON property `startIndex` + # @return [Fixnum] + attr_accessor :start_index + + # The page number of this set of results, where the page length is set by + # the `count` property. + # Corresponds to the JSON property `startPage` + # @return [Fixnum] + attr_accessor :start_page + + # A description of the query. + # Corresponds to the JSON property `title` + # @return [String] + attr_accessor :title + + # Estimated number of total search results. May not be accurate. + # Corresponds to the JSON property `totalResults` + # @return [Fixnum] + attr_accessor :total_results + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @count = args[:count] if args.key?(:count) + @cr = args[:cr] if args.key?(:cr) + @cx = args[:cx] if args.key?(:cx) + @date_restrict = args[:date_restrict] if args.key?(:date_restrict) + @disable_cn_tw_translation = args[:disable_cn_tw_translation] if args.key?(:disable_cn_tw_translation) + @exact_terms = args[:exact_terms] if args.key?(:exact_terms) + @exclude_terms = args[:exclude_terms] if args.key?(:exclude_terms) + @file_type = args[:file_type] if args.key?(:file_type) + @filter = args[:filter] if args.key?(:filter) + @gl = args[:gl] if args.key?(:gl) + @google_host = args[:google_host] if args.key?(:google_host) + @high_range = args[:high_range] if args.key?(:high_range) + @hl = args[:hl] if args.key?(:hl) + @hq = args[:hq] if args.key?(:hq) + @img_color_type = args[:img_color_type] if args.key?(:img_color_type) + @img_dominant_color = args[:img_dominant_color] if args.key?(:img_dominant_color) + @img_size = args[:img_size] if args.key?(:img_size) + @img_type = args[:img_type] if args.key?(:img_type) + @input_encoding = args[:input_encoding] if args.key?(:input_encoding) + @language = args[:language] if args.key?(:language) + @link_site = args[:link_site] if args.key?(:link_site) + @low_range = args[:low_range] if args.key?(:low_range) + @or_terms = args[:or_terms] if args.key?(:or_terms) + @output_encoding = args[:output_encoding] if args.key?(:output_encoding) + @related_site = args[:related_site] if args.key?(:related_site) + @rights = args[:rights] if args.key?(:rights) + @safe = args[:safe] if args.key?(:safe) + @search_terms = args[:search_terms] if args.key?(:search_terms) + @search_type = args[:search_type] if args.key?(:search_type) + @site_search = args[:site_search] if args.key?(:site_search) + @site_search_filter = args[:site_search_filter] if args.key?(:site_search_filter) + @sort = args[:sort] if args.key?(:sort) + @start_index = args[:start_index] if args.key?(:start_index) + @start_page = args[:start_page] if args.key?(:start_page) + @title = args[:title] if args.key?(:title) + @total_results = args[:total_results] if args.key?(:total_results) + end + end + + # Custom search request metadata. + class PreviousPage + include Google::Apis::Core::Hashable + + # Number of search results returned in this set. + # Corresponds to the JSON property `count` + # @return [Fixnum] + attr_accessor :count + + # Restricts search results to documents originating in a particular + # country. You may use [Boolean + # operators](https://developers.google.com/custom-search/docs/xml_results# + # booleanOperators) + # in the `cr` parameter's value. + # Google WebSearch determines the country of a document by analyzing the + # following: + # * The top-level domain (TLD) of the document's URL. + # * The geographic location of the web server's IP address. + # See [Country (cr) Parameter + # Values](https://developers.google.com/custom-search/docs/xml_results# + # countryCollections) + # for a list of valid values for this parameter. + # Corresponds to the JSON property `cr` + # @return [String] + attr_accessor :cr + + # The identifier of a custom search engine created using the Custom Search + # [Control Panel](https://cse.google.com/). This is a custom property not + # defined in the OpenSearch spec. This parameter is **required**. + # Corresponds to the JSON property `cx` + # @return [String] + attr_accessor :cx + + # Restricts results to URLs based on date. Supported values include: + # * `d[number]`: requests results from the specified number of past days. + # * `w[number]`: requests results from the specified number of past weeks. + # * `m[number]`: requests results from the specified number of past months. + # * `y[number]`: requests results from the specified number of past years. + # Corresponds to the JSON property `dateRestrict` + # @return [String] + attr_accessor :date_restrict + + # Enables or disables the [Simplified and Traditional Chinese + # Search](https://developers.google.com/custom-search/docs/xml_results# + # chineseSearch) + # feature. + # Supported values are: + # * `0`: enabled (default) + # * `1`: disabled + # Corresponds to the JSON property `disableCnTwTranslation` + # @return [String] + attr_accessor :disable_cn_tw_translation + + # Identifies a phrase that all documents in the search results must + # contain. + # Corresponds to the JSON property `exactTerms` + # @return [String] + attr_accessor :exact_terms + + # Identifies a word or phrase that should not appear in any documents in + # the search results. + # Corresponds to the JSON property `excludeTerms` + # @return [String] + attr_accessor :exclude_terms + + # Restricts results to files of a specified extension. Filetypes supported + # by Google include: + # * Adobe Portable Document Format (`pdf`) + # * Adobe PostScript (`ps`) + # * Lotus 1-2-3 (`wk1`, `wk2`, `wk3`, `wk4`, `wk5`, `wki`, `wks`, `wku`) + # * Lotus WordPro (`lwp`) + # * Macwrite (`mw`) + # * Microsoft Excel (`xls`) + # * Microsoft PowerPoint (`ppt`) + # * Microsoft Word (`doc`) + # * Microsoft Works (`wks`, `wps`, `wdb`) + # * Microsoft Write (`wri`) + # * Rich Text Format (`rtf`) + # * Shockwave Flash (`swf`) + # * Text (`ans`, `txt`). + # Additional filetypes may be added in the future. An up-to-date list can + # always be found in Google's [file type + # FAQ](https://support.google.com/webmasters/answer/35287). + # Corresponds to the JSON property `fileType` + # @return [String] + attr_accessor :file_type + + # Activates or deactivates the automatic filtering of Google search + # results. See [Automatic + # Filtering](https://developers.google.com/custom-search/docs/xml_results# + # automaticFiltering) + # for more information about Google's search results filters. Valid values + # for this parameter are: + # * `0`: Disabled + # * `1`: Enabled (default) + # **Note**: By default, Google applies filtering to all search results to + # improve the quality of those results. + # Corresponds to the JSON property `filter` + # @return [String] + attr_accessor :filter + + # Boosts search results whose country of origin matches the parameter + # value. See [Country + # Codes](https://developers.google.com/custom-search/docs/xml_results# + # countryCodes) + # for a list of valid values. + # Specifying a `gl` parameter value in WebSearch requests should improve + # the relevance of results. This is particularly true for international + # customers and, even more specifically, for customers in English-speaking + # countries other than the United States. + # Corresponds to the JSON property `gl` + # @return [String] + attr_accessor :gl + + # Specifies the Google domain (for example, google.com, google.de, or + # google.fr) to which the search should be limited. + # Corresponds to the JSON property `googleHost` + # @return [String] + attr_accessor :google_host + + # Specifies the ending value for a search range. Use `cse:lowRange` and + # `cse:highrange` to append an inclusive search range of + # `lowRange...highRange` to the query. + # Corresponds to the JSON property `highRange` + # @return [String] + attr_accessor :high_range + + # Specifies the interface language (host language) of your user interface. + # Explicitly setting this parameter improves the performance and the + # quality of your search results. + # See the [Interface + # Languages](https://developers.google.com/custom-search/docs/xml_results# + # wsInterfaceLanguages) + # section of [Internationalizing Queries and Results + # Presentation](https://developers.google.com/custom-search/docs/xml_results# + # wsInternationalizing) + # for more information, and [Supported Interface + # Languages](https://developers.google.com/custom-search/docs/ + # xml_results_appendices#interfaceLanguages) + # for a list of supported languages. + # Corresponds to the JSON property `hl` + # @return [String] + attr_accessor :hl + + # Appends the specified query terms to the query, as if they were combined + # with a logical `AND` operator. + # Corresponds to the JSON property `hq` + # @return [String] + attr_accessor :hq + + # Restricts results to images of a specified color type. Supported values + # are: + # * `mono` (black and white) + # * `gray` (grayscale) + # * `color` (color) + # Corresponds to the JSON property `imgColorType` + # @return [String] + attr_accessor :img_color_type + + # Restricts results to images with a specific dominant color. Supported + # values are: + # * `red` + # * `orange` + # * `yellow` + # * `green` + # * `teal` + # * `blue` + # * `purple` + # * `pink` + # * `white` + # * `gray` + # * `black` + # * `brown` + # Corresponds to the JSON property `imgDominantColor` + # @return [String] + attr_accessor :img_dominant_color + + # Restricts results to images of a specified size. Supported values are: + # * `icon` (small) + # * `small | medium | large | xlarge` (medium) + # * `xxlarge` (large) + # * `huge` (extra-large) + # Corresponds to the JSON property `imgSize` + # @return [String] + attr_accessor :img_size + + # Restricts results to images of a specified type. Supported values are: + # * `clipart` (Clip art) + # * `face` (Face) + # * `lineart` (Line drawing) + # * `photo` (Photo) + # * `animated` (Animated) + # * `stock` (Stock) + # Corresponds to the JSON property `imgType` + # @return [String] + attr_accessor :img_type + + # The character encoding supported for search requests. + # Corresponds to the JSON property `inputEncoding` + # @return [String] + attr_accessor :input_encoding + + # The language of the search results. + # Corresponds to the JSON property `language` + # @return [String] + attr_accessor :language + + # Specifies that all results should contain a link to a specific URL. + # Corresponds to the JSON property `linkSite` + # @return [String] + attr_accessor :link_site + + # Specifies the starting value for a search range. Use `cse:lowRange` and + # `cse:highrange` to append an inclusive search range of + # `lowRange...highRange` to the query. + # Corresponds to the JSON property `lowRange` + # @return [String] + attr_accessor :low_range + + # Provides additional search terms to check for in a document, where each + # document in the search results must contain at least one of the + # additional search terms. You can also use the [Boolean + # OR](https://developers.google.com/custom-search/docs/xml_results#BooleanOrqt) + # query term for this type of query. + # Corresponds to the JSON property `orTerms` + # @return [String] + attr_accessor :or_terms + + # The character encoding supported for search results. + # Corresponds to the JSON property `outputEncoding` + # @return [String] + attr_accessor :output_encoding + + # Specifies that all search results should be pages that are related to the + # specified URL. The parameter value should be a URL. + # Corresponds to the JSON property `relatedSite` + # @return [String] + attr_accessor :related_site + + # Filters based on licensing. Supported values include: + # * `cc_publicdomain` + # * `cc_attribute` + # * `cc_sharealike` + # * `cc_noncommercial` + # * `cc_nonderived` + # Corresponds to the JSON property `rights` + # @return [String] + attr_accessor :rights + + # Specifies the [SafeSearch + # level](https://developers.google.com/custom-search/docs/xml_results# + # safeSearchLevels) + # used for filtering out adult results. This is a custom property not + # defined in the OpenSearch spec. Valid parameter values are: + # * `"off"`: Disable SafeSearch + # * `"active"`: Enable SafeSearch + # Corresponds to the JSON property `safe` + # @return [String] + attr_accessor :safe + + # The search terms entered by the user. + # Corresponds to the JSON property `searchTerms` + # @return [String] + attr_accessor :search_terms + + # Allowed values are `web` or `image`. If unspecified, results are limited + # to webpages. + # Corresponds to the JSON property `searchType` + # @return [String] + attr_accessor :search_type + + # Restricts results to URLs from a specified site. + # Corresponds to the JSON property `siteSearch` + # @return [String] + attr_accessor :site_search + + # Specifies whether to include or exclude results from the site named in + # the `sitesearch` parameter. Supported values are: + # * `i`: include content from site + # * `e`: exclude content from site + # Corresponds to the JSON property `siteSearchFilter` + # @return [String] + attr_accessor :site_search_filter + + # Specifies that results should be sorted according to the specified + # expression. For example, sort by date. + # Corresponds to the JSON property `sort` + # @return [String] + attr_accessor :sort + + # The index of the current set of search results into the total set of + # results, where the index of the first result is 1. + # Corresponds to the JSON property `startIndex` + # @return [Fixnum] + attr_accessor :start_index + + # The page number of this set of results, where the page length is set by + # the `count` property. + # Corresponds to the JSON property `startPage` + # @return [Fixnum] + attr_accessor :start_page + + # A description of the query. + # Corresponds to the JSON property `title` + # @return [String] + attr_accessor :title + + # Estimated number of total search results. May not be accurate. + # Corresponds to the JSON property `totalResults` + # @return [Fixnum] + attr_accessor :total_results + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @count = args[:count] if args.key?(:count) + @cr = args[:cr] if args.key?(:cr) + @cx = args[:cx] if args.key?(:cx) + @date_restrict = args[:date_restrict] if args.key?(:date_restrict) + @disable_cn_tw_translation = args[:disable_cn_tw_translation] if args.key?(:disable_cn_tw_translation) + @exact_terms = args[:exact_terms] if args.key?(:exact_terms) + @exclude_terms = args[:exclude_terms] if args.key?(:exclude_terms) + @file_type = args[:file_type] if args.key?(:file_type) + @filter = args[:filter] if args.key?(:filter) + @gl = args[:gl] if args.key?(:gl) + @google_host = args[:google_host] if args.key?(:google_host) + @high_range = args[:high_range] if args.key?(:high_range) + @hl = args[:hl] if args.key?(:hl) + @hq = args[:hq] if args.key?(:hq) + @img_color_type = args[:img_color_type] if args.key?(:img_color_type) + @img_dominant_color = args[:img_dominant_color] if args.key?(:img_dominant_color) + @img_size = args[:img_size] if args.key?(:img_size) + @img_type = args[:img_type] if args.key?(:img_type) + @input_encoding = args[:input_encoding] if args.key?(:input_encoding) + @language = args[:language] if args.key?(:language) + @link_site = args[:link_site] if args.key?(:link_site) + @low_range = args[:low_range] if args.key?(:low_range) + @or_terms = args[:or_terms] if args.key?(:or_terms) + @output_encoding = args[:output_encoding] if args.key?(:output_encoding) + @related_site = args[:related_site] if args.key?(:related_site) + @rights = args[:rights] if args.key?(:rights) + @safe = args[:safe] if args.key?(:safe) + @search_terms = args[:search_terms] if args.key?(:search_terms) + @search_type = args[:search_type] if args.key?(:search_type) + @site_search = args[:site_search] if args.key?(:site_search) + @site_search_filter = args[:site_search_filter] if args.key?(:site_search_filter) + @sort = args[:sort] if args.key?(:sort) + @start_index = args[:start_index] if args.key?(:start_index) + @start_page = args[:start_page] if args.key?(:start_page) + @title = args[:title] if args.key?(:title) + @total_results = args[:total_results] if args.key?(:total_results) + end + end + + # Custom search request metadata. + class Request + include Google::Apis::Core::Hashable + + # Number of search results returned in this set. + # Corresponds to the JSON property `count` + # @return [Fixnum] + attr_accessor :count + + # Restricts search results to documents originating in a particular + # country. You may use [Boolean + # operators](https://developers.google.com/custom-search/docs/xml_results# + # booleanOperators) + # in the `cr` parameter's value. + # Google WebSearch determines the country of a document by analyzing the + # following: + # * The top-level domain (TLD) of the document's URL. + # * The geographic location of the web server's IP address. + # See [Country (cr) Parameter + # Values](https://developers.google.com/custom-search/docs/xml_results# + # countryCollections) + # for a list of valid values for this parameter. + # Corresponds to the JSON property `cr` + # @return [String] + attr_accessor :cr + + # The identifier of a custom search engine created using the Custom Search + # [Control Panel](https://cse.google.com/). This is a custom property not + # defined in the OpenSearch spec. This parameter is **required**. + # Corresponds to the JSON property `cx` + # @return [String] + attr_accessor :cx + + # Restricts results to URLs based on date. Supported values include: + # * `d[number]`: requests results from the specified number of past days. + # * `w[number]`: requests results from the specified number of past weeks. + # * `m[number]`: requests results from the specified number of past months. + # * `y[number]`: requests results from the specified number of past years. + # Corresponds to the JSON property `dateRestrict` + # @return [String] + attr_accessor :date_restrict + + # Enables or disables the [Simplified and Traditional Chinese + # Search](https://developers.google.com/custom-search/docs/xml_results# + # chineseSearch) + # feature. + # Supported values are: + # * `0`: enabled (default) + # * `1`: disabled + # Corresponds to the JSON property `disableCnTwTranslation` + # @return [String] + attr_accessor :disable_cn_tw_translation + + # Identifies a phrase that all documents in the search results must + # contain. + # Corresponds to the JSON property `exactTerms` + # @return [String] + attr_accessor :exact_terms + + # Identifies a word or phrase that should not appear in any documents in + # the search results. + # Corresponds to the JSON property `excludeTerms` + # @return [String] + attr_accessor :exclude_terms + + # Restricts results to files of a specified extension. Filetypes supported + # by Google include: + # * Adobe Portable Document Format (`pdf`) + # * Adobe PostScript (`ps`) + # * Lotus 1-2-3 (`wk1`, `wk2`, `wk3`, `wk4`, `wk5`, `wki`, `wks`, `wku`) + # * Lotus WordPro (`lwp`) + # * Macwrite (`mw`) + # * Microsoft Excel (`xls`) + # * Microsoft PowerPoint (`ppt`) + # * Microsoft Word (`doc`) + # * Microsoft Works (`wks`, `wps`, `wdb`) + # * Microsoft Write (`wri`) + # * Rich Text Format (`rtf`) + # * Shockwave Flash (`swf`) + # * Text (`ans`, `txt`). + # Additional filetypes may be added in the future. An up-to-date list can + # always be found in Google's [file type + # FAQ](https://support.google.com/webmasters/answer/35287). + # Corresponds to the JSON property `fileType` + # @return [String] + attr_accessor :file_type + + # Activates or deactivates the automatic filtering of Google search + # results. See [Automatic + # Filtering](https://developers.google.com/custom-search/docs/xml_results# + # automaticFiltering) + # for more information about Google's search results filters. Valid values + # for this parameter are: + # * `0`: Disabled + # * `1`: Enabled (default) + # **Note**: By default, Google applies filtering to all search results to + # improve the quality of those results. + # Corresponds to the JSON property `filter` + # @return [String] + attr_accessor :filter + + # Boosts search results whose country of origin matches the parameter + # value. See [Country + # Codes](https://developers.google.com/custom-search/docs/xml_results# + # countryCodes) + # for a list of valid values. + # Specifying a `gl` parameter value in WebSearch requests should improve + # the relevance of results. This is particularly true for international + # customers and, even more specifically, for customers in English-speaking + # countries other than the United States. + # Corresponds to the JSON property `gl` + # @return [String] + attr_accessor :gl + + # Specifies the Google domain (for example, google.com, google.de, or + # google.fr) to which the search should be limited. + # Corresponds to the JSON property `googleHost` + # @return [String] + attr_accessor :google_host + + # Specifies the ending value for a search range. Use `cse:lowRange` and + # `cse:highrange` to append an inclusive search range of + # `lowRange...highRange` to the query. + # Corresponds to the JSON property `highRange` + # @return [String] + attr_accessor :high_range + + # Specifies the interface language (host language) of your user interface. + # Explicitly setting this parameter improves the performance and the + # quality of your search results. + # See the [Interface + # Languages](https://developers.google.com/custom-search/docs/xml_results# + # wsInterfaceLanguages) + # section of [Internationalizing Queries and Results + # Presentation](https://developers.google.com/custom-search/docs/xml_results# + # wsInternationalizing) + # for more information, and [Supported Interface + # Languages](https://developers.google.com/custom-search/docs/ + # xml_results_appendices#interfaceLanguages) + # for a list of supported languages. + # Corresponds to the JSON property `hl` + # @return [String] + attr_accessor :hl + + # Appends the specified query terms to the query, as if they were combined + # with a logical `AND` operator. + # Corresponds to the JSON property `hq` + # @return [String] + attr_accessor :hq + + # Restricts results to images of a specified color type. Supported values + # are: + # * `mono` (black and white) + # * `gray` (grayscale) + # * `color` (color) + # Corresponds to the JSON property `imgColorType` + # @return [String] + attr_accessor :img_color_type + + # Restricts results to images with a specific dominant color. Supported + # values are: + # * `red` + # * `orange` + # * `yellow` + # * `green` + # * `teal` + # * `blue` + # * `purple` + # * `pink` + # * `white` + # * `gray` + # * `black` + # * `brown` + # Corresponds to the JSON property `imgDominantColor` + # @return [String] + attr_accessor :img_dominant_color + + # Restricts results to images of a specified size. Supported values are: + # * `icon` (small) + # * `small | medium | large | xlarge` (medium) + # * `xxlarge` (large) + # * `huge` (extra-large) + # Corresponds to the JSON property `imgSize` + # @return [String] + attr_accessor :img_size + + # Restricts results to images of a specified type. Supported values are: + # * `clipart` (Clip art) + # * `face` (Face) + # * `lineart` (Line drawing) + # * `photo` (Photo) + # * `animated` (Animated) + # * `stock` (Stock) + # Corresponds to the JSON property `imgType` + # @return [String] + attr_accessor :img_type + + # The character encoding supported for search requests. + # Corresponds to the JSON property `inputEncoding` + # @return [String] + attr_accessor :input_encoding + + # The language of the search results. + # Corresponds to the JSON property `language` + # @return [String] + attr_accessor :language + + # Specifies that all results should contain a link to a specific URL. + # Corresponds to the JSON property `linkSite` + # @return [String] + attr_accessor :link_site + + # Specifies the starting value for a search range. Use `cse:lowRange` and + # `cse:highrange` to append an inclusive search range of + # `lowRange...highRange` to the query. + # Corresponds to the JSON property `lowRange` + # @return [String] + attr_accessor :low_range + + # Provides additional search terms to check for in a document, where each + # document in the search results must contain at least one of the + # additional search terms. You can also use the [Boolean + # OR](https://developers.google.com/custom-search/docs/xml_results#BooleanOrqt) + # query term for this type of query. + # Corresponds to the JSON property `orTerms` + # @return [String] + attr_accessor :or_terms + + # The character encoding supported for search results. + # Corresponds to the JSON property `outputEncoding` + # @return [String] + attr_accessor :output_encoding + + # Specifies that all search results should be pages that are related to the + # specified URL. The parameter value should be a URL. + # Corresponds to the JSON property `relatedSite` + # @return [String] + attr_accessor :related_site + + # Filters based on licensing. Supported values include: + # * `cc_publicdomain` + # * `cc_attribute` + # * `cc_sharealike` + # * `cc_noncommercial` + # * `cc_nonderived` + # Corresponds to the JSON property `rights` + # @return [String] + attr_accessor :rights + + # Specifies the [SafeSearch + # level](https://developers.google.com/custom-search/docs/xml_results# + # safeSearchLevels) + # used for filtering out adult results. This is a custom property not + # defined in the OpenSearch spec. Valid parameter values are: + # * `"off"`: Disable SafeSearch + # * `"active"`: Enable SafeSearch + # Corresponds to the JSON property `safe` + # @return [String] + attr_accessor :safe + + # The search terms entered by the user. + # Corresponds to the JSON property `searchTerms` + # @return [String] + attr_accessor :search_terms + + # Allowed values are `web` or `image`. If unspecified, results are limited + # to webpages. + # Corresponds to the JSON property `searchType` + # @return [String] + attr_accessor :search_type + + # Restricts results to URLs from a specified site. + # Corresponds to the JSON property `siteSearch` + # @return [String] + attr_accessor :site_search + + # Specifies whether to include or exclude results from the site named in + # the `sitesearch` parameter. Supported values are: + # * `i`: include content from site + # * `e`: exclude content from site + # Corresponds to the JSON property `siteSearchFilter` + # @return [String] + attr_accessor :site_search_filter + + # Specifies that results should be sorted according to the specified + # expression. For example, sort by date. + # Corresponds to the JSON property `sort` + # @return [String] + attr_accessor :sort + + # The index of the current set of search results into the total set of + # results, where the index of the first result is 1. + # Corresponds to the JSON property `startIndex` + # @return [Fixnum] + attr_accessor :start_index + + # The page number of this set of results, where the page length is set by + # the `count` property. + # Corresponds to the JSON property `startPage` + # @return [Fixnum] + attr_accessor :start_page + + # A description of the query. + # Corresponds to the JSON property `title` + # @return [String] + attr_accessor :title + + # Estimated number of total search results. May not be accurate. + # Corresponds to the JSON property `totalResults` + # @return [Fixnum] + attr_accessor :total_results + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @count = args[:count] if args.key?(:count) + @cr = args[:cr] if args.key?(:cr) + @cx = args[:cx] if args.key?(:cx) + @date_restrict = args[:date_restrict] if args.key?(:date_restrict) + @disable_cn_tw_translation = args[:disable_cn_tw_translation] if args.key?(:disable_cn_tw_translation) + @exact_terms = args[:exact_terms] if args.key?(:exact_terms) + @exclude_terms = args[:exclude_terms] if args.key?(:exclude_terms) + @file_type = args[:file_type] if args.key?(:file_type) + @filter = args[:filter] if args.key?(:filter) + @gl = args[:gl] if args.key?(:gl) + @google_host = args[:google_host] if args.key?(:google_host) + @high_range = args[:high_range] if args.key?(:high_range) + @hl = args[:hl] if args.key?(:hl) + @hq = args[:hq] if args.key?(:hq) + @img_color_type = args[:img_color_type] if args.key?(:img_color_type) + @img_dominant_color = args[:img_dominant_color] if args.key?(:img_dominant_color) + @img_size = args[:img_size] if args.key?(:img_size) + @img_type = args[:img_type] if args.key?(:img_type) + @input_encoding = args[:input_encoding] if args.key?(:input_encoding) + @language = args[:language] if args.key?(:language) + @link_site = args[:link_site] if args.key?(:link_site) + @low_range = args[:low_range] if args.key?(:low_range) + @or_terms = args[:or_terms] if args.key?(:or_terms) + @output_encoding = args[:output_encoding] if args.key?(:output_encoding) + @related_site = args[:related_site] if args.key?(:related_site) + @rights = args[:rights] if args.key?(:rights) + @safe = args[:safe] if args.key?(:safe) + @search_terms = args[:search_terms] if args.key?(:search_terms) + @search_type = args[:search_type] if args.key?(:search_type) + @site_search = args[:site_search] if args.key?(:site_search) + @site_search_filter = args[:site_search_filter] if args.key?(:site_search_filter) + @sort = args[:sort] if args.key?(:sort) + @start_index = args[:start_index] if args.key?(:start_index) + @start_page = args[:start_page] if args.key?(:start_page) + @title = args[:title] if args.key?(:title) + @total_results = args[:total_results] if args.key?(:total_results) + end + end + end + + # Metadata about a search operation. + class SearchInformation + include Google::Apis::Core::Hashable + + # The time taken for the server to return search results, formatted + # according to locale style. + # Corresponds to the JSON property `formattedSearchTime` + # @return [String] + attr_accessor :formatted_search_time + + # The total number of search results, formatted according to locale style. + # Corresponds to the JSON property `formattedTotalResults` + # @return [String] + attr_accessor :formatted_total_results + + # The time taken for the server to return search results. + # Corresponds to the JSON property `searchTime` + # @return [Float] + attr_accessor :search_time + + # The total number of search results returned by the query. + # Corresponds to the JSON property `totalResults` + # @return [String] + attr_accessor :total_results + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @formatted_search_time = args[:formatted_search_time] if args.key?(:formatted_search_time) + @formatted_total_results = args[:formatted_total_results] if args.key?(:formatted_total_results) + @search_time = args[:search_time] if args.key?(:search_time) + @total_results = args[:total_results] if args.key?(:total_results) + end + end + + # Spell correction information for a query. + class Spelling + include Google::Apis::Core::Hashable + + # The corrected query. + # Corresponds to the JSON property `correctedQuery` + # @return [String] + attr_accessor :corrected_query + + # The corrected query, formatted in HTML. + # Corresponds to the JSON property `htmlCorrectedQuery` + # @return [String] + attr_accessor :html_corrected_query + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @corrected_query = args[:corrected_query] if args.key?(:corrected_query) + @html_corrected_query = args[:html_corrected_query] if args.key?(:html_corrected_query) + end + end + + # OpenSearch template and URL. + class Url + include Google::Apis::Core::Hashable + + # The actual [OpenSearch + # template](http://www.opensearch.org/specifications/opensearch/1.1# + # opensearch_url_template_syntax) + # for this API. + # Corresponds to the JSON property `template` + # @return [String] + attr_accessor :template + + # The MIME type of the OpenSearch URL template for the Custom Search API. + # 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) + @template = args[:template] if args.key?(:template) + @type = args[:type] if args.key?(:type) + end + end + end + end + end +end diff --git a/generated/google/apis/customsearch_v1/representations.rb b/generated/google/apis/customsearch_v1/representations.rb new file mode 100644 index 000000000..7ad933bc4 --- /dev/null +++ b/generated/google/apis/customsearch_v1/representations.rb @@ -0,0 +1,372 @@ +# 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 CustomsearchV1 + + class Promotion + class Representation < Google::Apis::Core::JsonRepresentation; end + + class BodyLine + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Image + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + include Google::Apis::Core::JsonObjectSupport + end + + class Result + class Representation < Google::Apis::Core::JsonRepresentation; end + + class Image + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Label + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + include Google::Apis::Core::JsonObjectSupport + end + + class Search + class Representation < Google::Apis::Core::JsonRepresentation; end + + class Queries + class Representation < Google::Apis::Core::JsonRepresentation; end + + class NextPage + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class PreviousPage + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Request + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + include Google::Apis::Core::JsonObjectSupport + end + + class SearchInformation + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Spelling + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Url + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + include Google::Apis::Core::JsonObjectSupport + end + + class Promotion + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :body_lines, as: 'bodyLines', class: Google::Apis::CustomsearchV1::Promotion::BodyLine, decorator: Google::Apis::CustomsearchV1::Promotion::BodyLine::Representation + + property :display_link, as: 'displayLink' + property :html_title, as: 'htmlTitle' + property :image, as: 'image', class: Google::Apis::CustomsearchV1::Promotion::Image, decorator: Google::Apis::CustomsearchV1::Promotion::Image::Representation + + property :link, as: 'link' + property :title, as: 'title' + end + + class BodyLine + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :html_title, as: 'htmlTitle' + property :link, as: 'link' + property :title, as: 'title' + property :url, as: 'url' + end + end + + class Image + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :height, as: 'height' + property :source, as: 'source' + property :width, as: 'width' + end + end + end + + class Result + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :cache_id, as: 'cacheId' + property :display_link, as: 'displayLink' + property :file_format, as: 'fileFormat' + property :formatted_url, as: 'formattedUrl' + property :html_formatted_url, as: 'htmlFormattedUrl' + property :html_snippet, as: 'htmlSnippet' + property :html_title, as: 'htmlTitle' + property :image, as: 'image', class: Google::Apis::CustomsearchV1::Result::Image, decorator: Google::Apis::CustomsearchV1::Result::Image::Representation + + property :kind, as: 'kind' + collection :labels, as: 'labels', class: Google::Apis::CustomsearchV1::Result::Label, decorator: Google::Apis::CustomsearchV1::Result::Label::Representation + + property :link, as: 'link' + property :mime, as: 'mime' + hash :pagemap, as: 'pagemap' + property :snippet, as: 'snippet' + property :title, as: 'title' + end + + class Image + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :byte_size, as: 'byteSize' + property :context_link, as: 'contextLink' + property :height, as: 'height' + property :thumbnail_height, as: 'thumbnailHeight' + property :thumbnail_link, as: 'thumbnailLink' + property :thumbnail_width, as: 'thumbnailWidth' + property :width, as: 'width' + end + end + + class Label + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :display_name, as: 'displayName' + property :label_with_op, as: 'label_with_op' + property :name, as: 'name' + end + end + end + + class Search + # @private + class Representation < Google::Apis::Core::JsonRepresentation + hash :context, as: 'context' + collection :items, as: 'items', class: Google::Apis::CustomsearchV1::Result, decorator: Google::Apis::CustomsearchV1::Result::Representation + + property :kind, as: 'kind' + collection :promotions, as: 'promotions', class: Google::Apis::CustomsearchV1::Promotion, decorator: Google::Apis::CustomsearchV1::Promotion::Representation + + property :queries, as: 'queries', class: Google::Apis::CustomsearchV1::Search::Queries, decorator: Google::Apis::CustomsearchV1::Search::Queries::Representation + + property :search_information, as: 'searchInformation', class: Google::Apis::CustomsearchV1::Search::SearchInformation, decorator: Google::Apis::CustomsearchV1::Search::SearchInformation::Representation + + property :spelling, as: 'spelling', class: Google::Apis::CustomsearchV1::Search::Spelling, decorator: Google::Apis::CustomsearchV1::Search::Spelling::Representation + + property :url, as: 'url', class: Google::Apis::CustomsearchV1::Search::Url, decorator: Google::Apis::CustomsearchV1::Search::Url::Representation + + end + + class Queries + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :next_page, as: 'nextPage', class: Google::Apis::CustomsearchV1::Search::Queries::NextPage, decorator: Google::Apis::CustomsearchV1::Search::Queries::NextPage::Representation + + collection :previous_page, as: 'previousPage', class: Google::Apis::CustomsearchV1::Search::Queries::PreviousPage, decorator: Google::Apis::CustomsearchV1::Search::Queries::PreviousPage::Representation + + collection :request, as: 'request', class: Google::Apis::CustomsearchV1::Search::Queries::Request, decorator: Google::Apis::CustomsearchV1::Search::Queries::Request::Representation + + end + + class NextPage + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :count, as: 'count' + property :cr, as: 'cr' + property :cx, as: 'cx' + property :date_restrict, as: 'dateRestrict' + property :disable_cn_tw_translation, as: 'disableCnTwTranslation' + property :exact_terms, as: 'exactTerms' + property :exclude_terms, as: 'excludeTerms' + property :file_type, as: 'fileType' + property :filter, as: 'filter' + property :gl, as: 'gl' + property :google_host, as: 'googleHost' + property :high_range, as: 'highRange' + property :hl, as: 'hl' + property :hq, as: 'hq' + property :img_color_type, as: 'imgColorType' + property :img_dominant_color, as: 'imgDominantColor' + property :img_size, as: 'imgSize' + property :img_type, as: 'imgType' + property :input_encoding, as: 'inputEncoding' + property :language, as: 'language' + property :link_site, as: 'linkSite' + property :low_range, as: 'lowRange' + property :or_terms, as: 'orTerms' + property :output_encoding, as: 'outputEncoding' + property :related_site, as: 'relatedSite' + property :rights, as: 'rights' + property :safe, as: 'safe' + property :search_terms, as: 'searchTerms' + property :search_type, as: 'searchType' + property :site_search, as: 'siteSearch' + property :site_search_filter, as: 'siteSearchFilter' + property :sort, as: 'sort' + property :start_index, as: 'startIndex' + property :start_page, as: 'startPage' + property :title, as: 'title' + property :total_results, :numeric_string => true, as: 'totalResults' + end + end + + class PreviousPage + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :count, as: 'count' + property :cr, as: 'cr' + property :cx, as: 'cx' + property :date_restrict, as: 'dateRestrict' + property :disable_cn_tw_translation, as: 'disableCnTwTranslation' + property :exact_terms, as: 'exactTerms' + property :exclude_terms, as: 'excludeTerms' + property :file_type, as: 'fileType' + property :filter, as: 'filter' + property :gl, as: 'gl' + property :google_host, as: 'googleHost' + property :high_range, as: 'highRange' + property :hl, as: 'hl' + property :hq, as: 'hq' + property :img_color_type, as: 'imgColorType' + property :img_dominant_color, as: 'imgDominantColor' + property :img_size, as: 'imgSize' + property :img_type, as: 'imgType' + property :input_encoding, as: 'inputEncoding' + property :language, as: 'language' + property :link_site, as: 'linkSite' + property :low_range, as: 'lowRange' + property :or_terms, as: 'orTerms' + property :output_encoding, as: 'outputEncoding' + property :related_site, as: 'relatedSite' + property :rights, as: 'rights' + property :safe, as: 'safe' + property :search_terms, as: 'searchTerms' + property :search_type, as: 'searchType' + property :site_search, as: 'siteSearch' + property :site_search_filter, as: 'siteSearchFilter' + property :sort, as: 'sort' + property :start_index, as: 'startIndex' + property :start_page, as: 'startPage' + property :title, as: 'title' + property :total_results, :numeric_string => true, as: 'totalResults' + end + end + + class Request + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :count, as: 'count' + property :cr, as: 'cr' + property :cx, as: 'cx' + property :date_restrict, as: 'dateRestrict' + property :disable_cn_tw_translation, as: 'disableCnTwTranslation' + property :exact_terms, as: 'exactTerms' + property :exclude_terms, as: 'excludeTerms' + property :file_type, as: 'fileType' + property :filter, as: 'filter' + property :gl, as: 'gl' + property :google_host, as: 'googleHost' + property :high_range, as: 'highRange' + property :hl, as: 'hl' + property :hq, as: 'hq' + property :img_color_type, as: 'imgColorType' + property :img_dominant_color, as: 'imgDominantColor' + property :img_size, as: 'imgSize' + property :img_type, as: 'imgType' + property :input_encoding, as: 'inputEncoding' + property :language, as: 'language' + property :link_site, as: 'linkSite' + property :low_range, as: 'lowRange' + property :or_terms, as: 'orTerms' + property :output_encoding, as: 'outputEncoding' + property :related_site, as: 'relatedSite' + property :rights, as: 'rights' + property :safe, as: 'safe' + property :search_terms, as: 'searchTerms' + property :search_type, as: 'searchType' + property :site_search, as: 'siteSearch' + property :site_search_filter, as: 'siteSearchFilter' + property :sort, as: 'sort' + property :start_index, as: 'startIndex' + property :start_page, as: 'startPage' + property :title, as: 'title' + property :total_results, :numeric_string => true, as: 'totalResults' + end + end + end + + class SearchInformation + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :formatted_search_time, as: 'formattedSearchTime' + property :formatted_total_results, as: 'formattedTotalResults' + property :search_time, as: 'searchTime' + property :total_results, as: 'totalResults' + end + end + + class Spelling + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :corrected_query, as: 'correctedQuery' + property :html_corrected_query, as: 'htmlCorrectedQuery' + end + end + + class Url + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :template, as: 'template' + property :type, as: 'type' + end + end + end + end + end +end diff --git a/generated/google/apis/customsearch_v1/service.rb b/generated/google/apis/customsearch_v1/service.rb new file mode 100644 index 000000000..dd4c9ae6c --- /dev/null +++ b/generated/google/apis/customsearch_v1/service.rb @@ -0,0 +1,608 @@ +# 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 CustomsearchV1 + # Custom Search API + # + # Searches over a website or collection of websites + # + # @example + # require 'google/apis/customsearch_v1' + # + # Customsearch = Google::Apis::CustomsearchV1 # Alias the module + # service = Customsearch::CustomsearchService.new + # + # @see https://developers.google.com/custom-search/v1/introduction + class CustomsearchService < Google::Apis::Core::BaseService + # @return [String] + # API key. Your API key identifies your project and provides you with API access, + # quota, and reports. Required unless you provide an OAuth 2.0 token. + attr_accessor :key + + # @return [String] + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + attr_accessor :quota_user + + def initialize + super('https://customsearch.googleapis.com/', '') + @batch_path = 'batch' + end + + # Returns metadata about the search performed, metadata about the custom + # search engine used for the search, and the search results. + # @param [String] c2coff + # Enables or disables [Simplified and Traditional Chinese + # Search](https://developers.google.com/custom-search/docs/xml_results# + # chineseSearch). + # The default value for this parameter is 0 (zero), meaning that the feature + # is enabled. Supported values are: + # * `1`: Disabled + # * `0`: Enabled (default) + # @param [String] cr + # Restricts search results to documents originating in a particular country. + # You may use [Boolean + # operators](https://developers.google.com/custom-search/docs/ + # xml_results_appendices#booleanOperators) + # in the cr parameter's value. + # Google Search determines the country of a document by analyzing: + # * the top-level domain (TLD) of the document's URL + # * the geographic location of the Web server's IP address + # See the [Country Parameter + # Values](https://developers.google.com/custom-search/docs/ + # xml_results_appendices#countryCollections) + # page for a list of valid values for this parameter. + # @param [String] cx + # The custom search engine ID to use for this request. + # @param [String] date_restrict + # Restricts results to URLs based on date. Supported values include: + # * `d[number]`: requests results from the specified number of past days. + # * `w[number]`: requests results from the specified number of past weeks. + # * `m[number]`: requests results from the specified number of past months. + # * `y[number]`: requests results from the specified number of past years. + # @param [String] exact_terms + # Identifies a phrase that all documents in the search results must contain. + # @param [String] exclude_terms + # Identifies a word or phrase that should not appear in any documents in the + # search results. + # @param [String] file_type + # Restricts results to files of a specified extension. A list of file types + # indexable by Google can be found in Search Console [Help + # Center](https://support.google.com/webmasters/answer/35287). + # @param [String] filter + # Controls turning on or off the duplicate content filter. + # * See [Automatic + # Filtering](https://developers.google.com/custom-search/docs/xml_results# + # automaticFiltering) + # for more information about Google's search results filters. Note that host + # crowding filtering applies only to multi-site searches. + # * By default, Google applies filtering to all search results to improve the + # quality of those results. + # Acceptable values are: + # * `0`: Turns off duplicate content filter. + # * `1`: Turns on duplicate content filter. + # @param [String] gl + # Geolocation of end user. + # * The `gl` parameter value is a two-letter country code. The `gl` parameter + # boosts search results whose country of origin matches the parameter value. + # See the [Country + # Codes](https://developers.google.com/custom-search/docs/xml_results_appendices# + # countryCodes) + # page for a list of valid values. + # * Specifying a `gl` parameter value should lead to more relevant results. + # This is particularly true for international customers and, even more + # specifically, for customers in English- speaking countries other than the + # United States. + # @param [String] googlehost + # **Deprecated**. Use the `gl` parameter for a similar effect. + # The local Google domain (for example, google.com, google.de, or + # google.fr) to use to perform the search. + # @param [String] high_range + # Specifies the ending value for a search range. + # * Use `lowRange` and `highRange` to append an inclusive search range of + # `lowRange...highRange` to the query. + # @param [String] hl + # Sets the user interface language. + # * Explicitly setting this parameter improves the performance and the + # quality of your search results. + # * See the [Interface + # Languages](https://developers.google.com/custom-search/docs/xml_results# + # wsInterfaceLanguages) + # section of [Internationalizing Queries and Results + # Presentation](https://developers.google.com/custom-search/docs/xml_results# + # wsInternationalizing) + # for more information, and (Supported Interface + # Languages)[https://developers.google.com/custom-search/docs/ + # xml_results_appendices#interfaceLanguages] + # for a list of supported languages. + # @param [String] hq + # Appends the specified query terms to the query, as if they were combined + # with a logical AND operator. + # @param [String] img_color_type + # Returns black and white, grayscale, transparent, or color images. + # Acceptable values are: + # * `"color"` + # * `"gray"` + # * `"mono"`: black and white + # * `"trans"`: transparent background + # @param [String] img_dominant_color + # Returns images of a specific dominant color. Acceptable values are: + # * `"black"` + # * `"blue"` + # * `"brown"` + # * `"gray"` + # * `"green"` + # * `"orange"` + # * `"pink"` + # * `"purple"` + # * `"red"` + # * `"teal"` + # * `"white"` + # * `"yellow"` + # @param [String] img_size + # Returns images of a specified size. Acceptable values are: + # * `"huge"` + # * `"icon"` + # * `"large"` + # * `"medium"` + # * `"small"` + # * `"xlarge"` + # * `"xxlarge"` + # @param [String] img_type + # Returns images of a type. Acceptable values are: + # * `"clipart"` + # * `"face"` + # * `"lineart"` + # * `"stock"` + # * `"photo"` + # * `"animated"` + # @param [String] link_site + # Specifies that all search results should contain a link to a particular + # URL. + # @param [String] low_range + # Specifies the starting value for a search range. Use `lowRange` and + # `highRange` to append an inclusive search range of `lowRange...highRange` + # to the query. + # @param [String] lr + # Restricts the search to documents written in a particular language (e.g., + # `lr=lang_ja`). + # Acceptable values are: + # * `"lang_ar"`: Arabic + # * `"lang_bg"`: Bulgarian + # * `"lang_ca"`: Catalan + # * `"lang_cs"`: Czech + # * `"lang_da"`: Danish + # * `"lang_de"`: German + # * `"lang_el"`: Greek + # * `"lang_en"`: English + # * `"lang_es"`: Spanish + # * `"lang_et"`: Estonian + # * `"lang_fi"`: Finnish + # * `"lang_fr"`: French + # * `"lang_hr"`: Croatian + # * `"lang_hu"`: Hungarian + # * `"lang_id"`: Indonesian + # * `"lang_is"`: Icelandic + # * `"lang_it"`: Italian + # * `"lang_iw"`: Hebrew + # * `"lang_ja"`: Japanese + # * `"lang_ko"`: Korean + # * `"lang_lt"`: Lithuanian + # * `"lang_lv"`: Latvian + # * `"lang_nl"`: Dutch + # * `"lang_no"`: Norwegian + # * `"lang_pl"`: Polish + # * `"lang_pt"`: Portuguese + # * `"lang_ro"`: Romanian + # * `"lang_ru"`: Russian + # * `"lang_sk"`: Slovak + # * `"lang_sl"`: Slovenian + # * `"lang_sr"`: Serbian + # * `"lang_sv"`: Swedish + # * `"lang_tr"`: Turkish + # * `"lang_zh-CN"`: Chinese (Simplified) + # * `"lang_zh-TW"`: Chinese (Traditional) + # @param [Fixnum] num + # Number of search results to return. + # * Valid values are integers between 1 and 10, inclusive. + # @param [String] or_terms + # Provides additional search terms to check for in a document, where each + # document in the search results must contain at least one of the additional + # search terms. + # @param [String] q + # Query + # @param [String] related_site + # Specifies that all search results should be pages that are related to the + # specified URL. + # @param [String] rights + # Filters based on licensing. Supported values include: `cc_publicdomain`, + # `cc_attribute`, `cc_sharealike`, `cc_noncommercial`, `cc_nonderived` and + # combinations of these. See [typical + # combinations](https://wiki.creativecommons.org/wiki/CC_Search_integration). + # @param [String] safe + # Search safety level. Acceptable values are: + # * `"active"`: Enables SafeSearch filtering. + # * `"off"`: Disables SafeSearch filtering. (default) + # @param [String] search_type + # Specifies the search type: `image`. If unspecified, results are limited to + # webpages. + # Acceptable values are: + # * `"image"`: custom image search. + # @param [String] site_search + # Specifies a given site which should always be included or excluded from + # results (see `siteSearchFilter` parameter, below). + # @param [String] site_search_filter + # Controls whether to include or exclude results from the site named in the + # `siteSearch` parameter. + # Acceptable values are: + # * `"e"`: exclude + # * `"i"`: include + # @param [String] sort + # The sort expression to apply to the results. + # @param [Fixnum] start + # The index of the first result to return. The default number of results per + # page is 10, so `&start=11` would start at the top of the second page of + # results. **Note**: The JSON API will never return more than 100 results, + # even if more than 100 documents match the query, so setting the sum of + # `start + num` to a number greater than 100 will produce an error. Also note + # that the maximum value for `num` is 10. + # @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::CustomsearchV1::Search] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::CustomsearchV1::Search] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_cses(c2coff: nil, cr: nil, cx: nil, date_restrict: nil, exact_terms: nil, exclude_terms: nil, file_type: nil, filter: nil, gl: nil, googlehost: nil, high_range: nil, hl: nil, hq: nil, img_color_type: nil, img_dominant_color: nil, img_size: nil, img_type: nil, link_site: nil, low_range: nil, lr: nil, num: nil, or_terms: nil, q: nil, related_site: nil, rights: nil, safe: nil, search_type: nil, site_search: nil, site_search_filter: nil, sort: nil, start: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'customsearch/v1', options) + command.response_representation = Google::Apis::CustomsearchV1::Search::Representation + command.response_class = Google::Apis::CustomsearchV1::Search + command.query['c2coff'] = c2coff unless c2coff.nil? + command.query['cr'] = cr unless cr.nil? + command.query['cx'] = cx unless cx.nil? + command.query['dateRestrict'] = date_restrict unless date_restrict.nil? + command.query['exactTerms'] = exact_terms unless exact_terms.nil? + command.query['excludeTerms'] = exclude_terms unless exclude_terms.nil? + command.query['fileType'] = file_type unless file_type.nil? + command.query['filter'] = filter unless filter.nil? + command.query['gl'] = gl unless gl.nil? + command.query['googlehost'] = googlehost unless googlehost.nil? + command.query['highRange'] = high_range unless high_range.nil? + command.query['hl'] = hl unless hl.nil? + command.query['hq'] = hq unless hq.nil? + command.query['imgColorType'] = img_color_type unless img_color_type.nil? + command.query['imgDominantColor'] = img_dominant_color unless img_dominant_color.nil? + command.query['imgSize'] = img_size unless img_size.nil? + command.query['imgType'] = img_type unless img_type.nil? + command.query['linkSite'] = link_site unless link_site.nil? + command.query['lowRange'] = low_range unless low_range.nil? + command.query['lr'] = lr unless lr.nil? + command.query['num'] = num unless num.nil? + command.query['orTerms'] = or_terms unless or_terms.nil? + command.query['q'] = q unless q.nil? + command.query['relatedSite'] = related_site unless related_site.nil? + command.query['rights'] = rights unless rights.nil? + command.query['safe'] = safe unless safe.nil? + command.query['searchType'] = search_type unless search_type.nil? + command.query['siteSearch'] = site_search unless site_search.nil? + command.query['siteSearchFilter'] = site_search_filter unless site_search_filter.nil? + command.query['sort'] = sort unless sort.nil? + command.query['start'] = start unless start.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Returns metadata about the search performed, metadata about the custom + # search engine used for the search, and the search results. Uses a small set + # of url patterns. + # @param [String] c2coff + # Enables or disables [Simplified and Traditional Chinese + # Search](https://developers.google.com/custom-search/docs/xml_results# + # chineseSearch). + # The default value for this parameter is 0 (zero), meaning that the feature + # is enabled. Supported values are: + # * `1`: Disabled + # * `0`: Enabled (default) + # @param [String] cr + # Restricts search results to documents originating in a particular country. + # You may use [Boolean + # operators](https://developers.google.com/custom-search/docs/ + # xml_results_appendices#booleanOperators) + # in the cr parameter's value. + # Google Search determines the country of a document by analyzing: + # * the top-level domain (TLD) of the document's URL + # * the geographic location of the Web server's IP address + # See the [Country Parameter + # Values](https://developers.google.com/custom-search/docs/ + # xml_results_appendices#countryCollections) + # page for a list of valid values for this parameter. + # @param [String] cx + # The custom search engine ID to use for this request. + # @param [String] date_restrict + # Restricts results to URLs based on date. Supported values include: + # * `d[number]`: requests results from the specified number of past days. + # * `w[number]`: requests results from the specified number of past weeks. + # * `m[number]`: requests results from the specified number of past months. + # * `y[number]`: requests results from the specified number of past years. + # @param [String] exact_terms + # Identifies a phrase that all documents in the search results must contain. + # @param [String] exclude_terms + # Identifies a word or phrase that should not appear in any documents in the + # search results. + # @param [String] file_type + # Restricts results to files of a specified extension. A list of file types + # indexable by Google can be found in Search Console [Help + # Center](https://support.google.com/webmasters/answer/35287). + # @param [String] filter + # Controls turning on or off the duplicate content filter. + # * See [Automatic + # Filtering](https://developers.google.com/custom-search/docs/xml_results# + # automaticFiltering) + # for more information about Google's search results filters. Note that host + # crowding filtering applies only to multi-site searches. + # * By default, Google applies filtering to all search results to improve the + # quality of those results. + # Acceptable values are: + # * `0`: Turns off duplicate content filter. + # * `1`: Turns on duplicate content filter. + # @param [String] gl + # Geolocation of end user. + # * The `gl` parameter value is a two-letter country code. The `gl` parameter + # boosts search results whose country of origin matches the parameter value. + # See the [Country + # Codes](https://developers.google.com/custom-search/docs/xml_results_appendices# + # countryCodes) + # page for a list of valid values. + # * Specifying a `gl` parameter value should lead to more relevant results. + # This is particularly true for international customers and, even more + # specifically, for customers in English- speaking countries other than the + # United States. + # @param [String] googlehost + # **Deprecated**. Use the `gl` parameter for a similar effect. + # The local Google domain (for example, google.com, google.de, or + # google.fr) to use to perform the search. + # @param [String] high_range + # Specifies the ending value for a search range. + # * Use `lowRange` and `highRange` to append an inclusive search range of + # `lowRange...highRange` to the query. + # @param [String] hl + # Sets the user interface language. + # * Explicitly setting this parameter improves the performance and the + # quality of your search results. + # * See the [Interface + # Languages](https://developers.google.com/custom-search/docs/xml_results# + # wsInterfaceLanguages) + # section of [Internationalizing Queries and Results + # Presentation](https://developers.google.com/custom-search/docs/xml_results# + # wsInternationalizing) + # for more information, and (Supported Interface + # Languages)[https://developers.google.com/custom-search/docs/ + # xml_results_appendices#interfaceLanguages] + # for a list of supported languages. + # @param [String] hq + # Appends the specified query terms to the query, as if they were combined + # with a logical AND operator. + # @param [String] img_color_type + # Returns black and white, grayscale, transparent, or color images. + # Acceptable values are: + # * `"color"` + # * `"gray"` + # * `"mono"`: black and white + # * `"trans"`: transparent background + # @param [String] img_dominant_color + # Returns images of a specific dominant color. Acceptable values are: + # * `"black"` + # * `"blue"` + # * `"brown"` + # * `"gray"` + # * `"green"` + # * `"orange"` + # * `"pink"` + # * `"purple"` + # * `"red"` + # * `"teal"` + # * `"white"` + # * `"yellow"` + # @param [String] img_size + # Returns images of a specified size. Acceptable values are: + # * `"huge"` + # * `"icon"` + # * `"large"` + # * `"medium"` + # * `"small"` + # * `"xlarge"` + # * `"xxlarge"` + # @param [String] img_type + # Returns images of a type. Acceptable values are: + # * `"clipart"` + # * `"face"` + # * `"lineart"` + # * `"stock"` + # * `"photo"` + # * `"animated"` + # @param [String] link_site + # Specifies that all search results should contain a link to a particular + # URL. + # @param [String] low_range + # Specifies the starting value for a search range. Use `lowRange` and + # `highRange` to append an inclusive search range of `lowRange...highRange` + # to the query. + # @param [String] lr + # Restricts the search to documents written in a particular language (e.g., + # `lr=lang_ja`). + # Acceptable values are: + # * `"lang_ar"`: Arabic + # * `"lang_bg"`: Bulgarian + # * `"lang_ca"`: Catalan + # * `"lang_cs"`: Czech + # * `"lang_da"`: Danish + # * `"lang_de"`: German + # * `"lang_el"`: Greek + # * `"lang_en"`: English + # * `"lang_es"`: Spanish + # * `"lang_et"`: Estonian + # * `"lang_fi"`: Finnish + # * `"lang_fr"`: French + # * `"lang_hr"`: Croatian + # * `"lang_hu"`: Hungarian + # * `"lang_id"`: Indonesian + # * `"lang_is"`: Icelandic + # * `"lang_it"`: Italian + # * `"lang_iw"`: Hebrew + # * `"lang_ja"`: Japanese + # * `"lang_ko"`: Korean + # * `"lang_lt"`: Lithuanian + # * `"lang_lv"`: Latvian + # * `"lang_nl"`: Dutch + # * `"lang_no"`: Norwegian + # * `"lang_pl"`: Polish + # * `"lang_pt"`: Portuguese + # * `"lang_ro"`: Romanian + # * `"lang_ru"`: Russian + # * `"lang_sk"`: Slovak + # * `"lang_sl"`: Slovenian + # * `"lang_sr"`: Serbian + # * `"lang_sv"`: Swedish + # * `"lang_tr"`: Turkish + # * `"lang_zh-CN"`: Chinese (Simplified) + # * `"lang_zh-TW"`: Chinese (Traditional) + # @param [Fixnum] num + # Number of search results to return. + # * Valid values are integers between 1 and 10, inclusive. + # @param [String] or_terms + # Provides additional search terms to check for in a document, where each + # document in the search results must contain at least one of the additional + # search terms. + # @param [String] q + # Query + # @param [String] related_site + # Specifies that all search results should be pages that are related to the + # specified URL. + # @param [String] rights + # Filters based on licensing. Supported values include: `cc_publicdomain`, + # `cc_attribute`, `cc_sharealike`, `cc_noncommercial`, `cc_nonderived` and + # combinations of these. See [typical + # combinations](https://wiki.creativecommons.org/wiki/CC_Search_integration). + # @param [String] safe + # Search safety level. Acceptable values are: + # * `"active"`: Enables SafeSearch filtering. + # * `"off"`: Disables SafeSearch filtering. (default) + # @param [String] search_type + # Specifies the search type: `image`. If unspecified, results are limited to + # webpages. + # Acceptable values are: + # * `"image"`: custom image search. + # @param [String] site_search + # Specifies a given site which should always be included or excluded from + # results (see `siteSearchFilter` parameter, below). + # @param [String] site_search_filter + # Controls whether to include or exclude results from the site named in the + # `siteSearch` parameter. + # Acceptable values are: + # * `"e"`: exclude + # * `"i"`: include + # @param [String] sort + # The sort expression to apply to the results. + # @param [Fixnum] start + # The index of the first result to return. The default number of results per + # page is 10, so `&start=11` would start at the top of the second page of + # results. **Note**: The JSON API will never return more than 100 results, + # even if more than 100 documents match the query, so setting the sum of + # `start + num` to a number greater than 100 will produce an error. Also note + # that the maximum value for `num` is 10. + # @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::CustomsearchV1::Search] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::CustomsearchV1::Search] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_cse_siterestricts(c2coff: nil, cr: nil, cx: nil, date_restrict: nil, exact_terms: nil, exclude_terms: nil, file_type: nil, filter: nil, gl: nil, googlehost: nil, high_range: nil, hl: nil, hq: nil, img_color_type: nil, img_dominant_color: nil, img_size: nil, img_type: nil, link_site: nil, low_range: nil, lr: nil, num: nil, or_terms: nil, q: nil, related_site: nil, rights: nil, safe: nil, search_type: nil, site_search: nil, site_search_filter: nil, sort: nil, start: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'customsearch/v1/siterestrict', options) + command.response_representation = Google::Apis::CustomsearchV1::Search::Representation + command.response_class = Google::Apis::CustomsearchV1::Search + command.query['c2coff'] = c2coff unless c2coff.nil? + command.query['cr'] = cr unless cr.nil? + command.query['cx'] = cx unless cx.nil? + command.query['dateRestrict'] = date_restrict unless date_restrict.nil? + command.query['exactTerms'] = exact_terms unless exact_terms.nil? + command.query['excludeTerms'] = exclude_terms unless exclude_terms.nil? + command.query['fileType'] = file_type unless file_type.nil? + command.query['filter'] = filter unless filter.nil? + command.query['gl'] = gl unless gl.nil? + command.query['googlehost'] = googlehost unless googlehost.nil? + command.query['highRange'] = high_range unless high_range.nil? + command.query['hl'] = hl unless hl.nil? + command.query['hq'] = hq unless hq.nil? + command.query['imgColorType'] = img_color_type unless img_color_type.nil? + command.query['imgDominantColor'] = img_dominant_color unless img_dominant_color.nil? + command.query['imgSize'] = img_size unless img_size.nil? + command.query['imgType'] = img_type unless img_type.nil? + command.query['linkSite'] = link_site unless link_site.nil? + command.query['lowRange'] = low_range unless low_range.nil? + command.query['lr'] = lr unless lr.nil? + command.query['num'] = num unless num.nil? + command.query['orTerms'] = or_terms unless or_terms.nil? + command.query['q'] = q unless q.nil? + command.query['relatedSite'] = related_site unless related_site.nil? + command.query['rights'] = rights unless rights.nil? + command.query['safe'] = safe unless safe.nil? + command.query['searchType'] = search_type unless search_type.nil? + command.query['siteSearch'] = site_search unless site_search.nil? + command.query['siteSearchFilter'] = site_search_filter unless site_search_filter.nil? + command.query['sort'] = sort unless sort.nil? + command.query['start'] = start unless start.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + protected + + def apply_command_defaults(command) + command.query['key'] = key unless key.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + end + end + end + end +end diff --git a/generated/google/apis/displayvideo_v1.rb b/generated/google/apis/displayvideo_v1.rb index 2d59ac722..a71a86790 100644 --- a/generated/google/apis/displayvideo_v1.rb +++ b/generated/google/apis/displayvideo_v1.rb @@ -26,7 +26,7 @@ module Google # @see https://developers.google.com/display-video/ module DisplayvideoV1 VERSION = 'V1' - REVISION = '20200630' + REVISION = '20200707' # Create, see, edit, and permanently delete your Display & Video 360 entities and reports AUTH_DISPLAY_VIDEO = 'https://www.googleapis.com/auth/display-video' diff --git a/generated/google/apis/dns_v1.rb b/generated/google/apis/dns_v1.rb index 60d2ddbf2..749286b2b 100644 --- a/generated/google/apis/dns_v1.rb +++ b/generated/google/apis/dns_v1.rb @@ -18,14 +18,14 @@ require 'google/apis/dns_v1/representations.rb' module Google module Apis - # Google Cloud DNS API + # Cloud DNS API # - # Configures and serves authoritative DNS records. + # # - # @see https://developers.google.com/cloud-dns + # @see http://developers.google.com/cloud-dns module DnsV1 VERSION = 'V1' - REVISION = '20200515' + REVISION = '20200701' # 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/dns_v1/classes.rb b/generated/google/apis/dns_v1/classes.rb index 7b8ec8f4e..1744fcb88 100644 --- a/generated/google/apis/dns_v1/classes.rb +++ b/generated/google/apis/dns_v1/classes.rb @@ -22,42 +22,51 @@ module Google module Apis module DnsV1 - # + # A Change represents a set of ResourceRecordSet additions and deletions + # applied atomically to a ManagedZone. ResourceRecordSets within a + # ManagedZone are modified by creating a new Change element in the Changes + # collection. In turn the Changes collection also records the past + # modifications to the ResourceRecordSets in a ManagedZone. The current + # state of the ManagedZone is the sum effect of applying all Change + # elements in the Changes collection in sequence. class Change include Google::Apis::Core::Hashable - # + # Which ResourceRecordSets to add? # Corresponds to the JSON property `additions` # @return [Array] attr_accessor :additions - # + # Which ResourceRecordSets to remove? Must match existing data exactly. # Corresponds to the JSON property `deletions` # @return [Array] attr_accessor :deletions - # + # Unique identifier for the resource; defined by the server (output only). # Corresponds to the JSON property `id` # @return [String] attr_accessor :id - # + # If the DNS queries for the zone will be served. # Corresponds to the JSON property `isServing` # @return [Boolean] attr_accessor :is_serving alias_method :is_serving?, :is_serving - # Identifies what kind of resource this is. Value: the fixed string "dns#change". + # # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # + # The time that this operation was started by the server (output only). This + # is in RFC3339 text format. # Corresponds to the JSON property `startTime` # @return [String] attr_accessor :start_time - # + # Status of the operation (output only). A status of "done" means that the + # request to update the authoritative servers has been sent, but the + # servers might not be updated yet. # Corresponds to the JSON property `status` # @return [String] attr_accessor :status @@ -78,16 +87,17 @@ module Google end end - # + # The response to a request to enumerate Changes to a ResourceRecordSets + # collection. class ListChangesResponse include Google::Apis::Core::Hashable - # + # The requested changes. # Corresponds to the JSON property `changes` # @return [Array] attr_accessor :changes - # + # Elements common to every response. # Corresponds to the JSON property `header` # @return [Google::Apis::DnsV1::ResponseHeader] attr_accessor :header @@ -97,7 +107,15 @@ module Google # @return [String] attr_accessor :kind - # + # The presence of this field indicates that there exist more results + # following your last page of results in pagination order. To fetch them, + # make another list request using this value as your pagination token. + # In this way you can retrieve the complete contents of even very large + # collections one page at a time. However, if the contents of the collection + # change between the first and last paginated list request, the set of all + # elements returned will be an inconsistent view of the collection. There is + # no way to retrieve a "snapshot" of collections larger than the maximum + # page size. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -115,62 +133,78 @@ module Google end end - # + # A DNSSEC key pair. class DnsKey include Google::Apis::Core::Hashable - # + # String mnemonic specifying the DNSSEC algorithm of this key. Immutable + # after creation time. # Corresponds to the JSON property `algorithm` # @return [String] attr_accessor :algorithm - # + # The time that this resource was created in the control plane. This is in + # RFC3339 text format. Output only. # Corresponds to the JSON property `creationTime` # @return [String] attr_accessor :creation_time - # + # A mutable string of at most 1024 characters associated with this resource + # for the user's convenience. Has no effect on the resource's function. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description - # + # Cryptographic hashes of the DNSKEY resource record associated with this + # DnsKey. These digests are needed to construct a DS record that points at + # this DNS key. Output only. # Corresponds to the JSON property `digests` # @return [Array] attr_accessor :digests - # + # Unique identifier for the resource; defined by the server (output only). # Corresponds to the JSON property `id` # @return [String] attr_accessor :id - # + # Active keys will be used to sign subsequent changes to the ManagedZone. + # Inactive keys will still be present as DNSKEY Resource Records for the use + # of resolvers validating existing signatures. # Corresponds to the JSON property `isActive` # @return [Boolean] attr_accessor :is_active alias_method :is_active?, :is_active - # + # Length of the key in bits. Specified at creation time then immutable. # Corresponds to the JSON property `keyLength` # @return [Fixnum] attr_accessor :key_length - # + # The key tag is a non-cryptographic hash of the a DNSKEY resource record + # associated with this DnsKey. The key tag can be used to identify a DNSKEY + # more quickly (but it is not a unique identifier). In particular, the key + # tag is used in a parent zone's DS record to point at the DNSKEY in this + # child ManagedZone. The key tag is a number in the range [0, 65535] and the + # algorithm to calculate it is specified in RFC4034 Appendix B. Output only. # Corresponds to the JSON property `keyTag` # @return [Fixnum] attr_accessor :key_tag - # Identifies what kind of resource this is. Value: the fixed string "dns#dnsKey". + # # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # + # Base64 encoded public half of this key. Output only. # Corresponds to the JSON property `publicKey` # @return [String] attr_accessor :public_key - # + # One of "KEY_SIGNING" or "ZONE_SIGNING". Keys of type KEY_SIGNING have the + # Secure Entry Point flag set and, when active, will be used to sign only + # resource record sets of type DNSKEY. Otherwise, the Secure Entry Point + # flag will be cleared and this key will be used to sign only resource + # record sets of other types. Immutable after creation time. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type @@ -199,12 +233,13 @@ module Google class DnsKeyDigest include Google::Apis::Core::Hashable - # + # The base-16 encoded bytes of this digest. Suitable for use in a DS + # resource record. # Corresponds to the JSON property `digest` # @return [String] attr_accessor :digest - # + # Specifies the algorithm used to calculate this digest. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type @@ -220,27 +255,31 @@ module Google end end - # + # Parameters for DnsKey key generation. Used for generating initial keys + # for a new ManagedZone and as default when adding a new DnsKey. class DnsKeySpec include Google::Apis::Core::Hashable - # + # String mnemonic specifying the DNSSEC algorithm of this key. # Corresponds to the JSON property `algorithm` # @return [String] attr_accessor :algorithm - # + # Length of the keys in bits. # Corresponds to the JSON property `keyLength` # @return [Fixnum] attr_accessor :key_length - # + # Specifies whether this is a key signing key (KSK) or a zone signing key + # (ZSK). Key signing keys have the Secure Entry Point flag set and, when + # active, will only be used to sign resource record sets of type DNSKEY. + # Zone signing keys do not have the Secure Entry Point flag set and will be + # used to sign all other types of resource record sets. # Corresponds to the JSON property `keyType` # @return [String] attr_accessor :key_type - # Identifies what kind of resource this is. Value: the fixed string "dns# - # dnsKeySpec". + # # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -258,16 +297,16 @@ module Google end end - # + # The response to a request to enumerate DnsKeys in a ManagedZone. class DnsKeysListResponse include Google::Apis::Core::Hashable - # + # The requested resources. # Corresponds to the JSON property `dnsKeys` # @return [Array] attr_accessor :dns_keys - # + # Elements common to every response. # Corresponds to the JSON property `header` # @return [Google::Apis::DnsV1::ResponseHeader] attr_accessor :header @@ -277,7 +316,15 @@ module Google # @return [String] attr_accessor :kind - # + # The presence of this field indicates that there exist more results + # following your last page of results in pagination order. To fetch them, + # make another list request using this value as your pagination token. + # In this way you can retrieve the complete contents of even very large + # collections one page at a time. However, if the contents of the collection + # change between the first and last paginated list request, the set of all + # elements returned will be an inconsistent view of the collection. There is + # no way to retrieve a "snapshot" of collections larger than the maximum + # page size. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -295,82 +342,98 @@ module Google end end - # + # A zone is a subtree of the DNS namespace under one administrative + # responsibility. A ManagedZone is a resource that represents a DNS zone + # hosted by the Cloud DNS service. class ManagedZone include Google::Apis::Core::Hashable - # + # The time that this resource was created on the server. This is in RFC3339 + # text format. Output only. # Corresponds to the JSON property `creationTime` # @return [String] attr_accessor :creation_time - # + # A mutable string of at most 1024 characters associated with this resource + # for the user's convenience. Has no effect on the managed zone's function. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description - # + # The DNS name of this managed zone, for instance "example.com.". # Corresponds to the JSON property `dnsName` # @return [String] attr_accessor :dns_name - # + # DNSSEC configuration. # Corresponds to the JSON property `dnssecConfig` # @return [Google::Apis::DnsV1::ManagedZoneDnsSecConfig] attr_accessor :dnssec_config - # + # The presence for this field indicates that outbound forwarding is enabled + # for this zone. The value of this field contains the set of destinations + # to forward to. # Corresponds to the JSON property `forwardingConfig` # @return [Google::Apis::DnsV1::ManagedZoneForwardingConfig] attr_accessor :forwarding_config - # + # Unique identifier for the resource; defined by the server (output only) # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id - # Identifies what kind of resource this is. Value: the fixed string "dns# - # managedZone". + # # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # + # User labels. # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels - # + # User assigned name for this resource. Must be unique within the project. + # The name must be 1-63 characters long, must begin with a letter, end with + # a letter or digit, and only contain lowercase letters, digits or dashes. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # + # Optionally specifies the NameServerSet for this ManagedZone. A + # NameServerSet is a set of DNS name servers that all host the same + # ManagedZones. Most users will leave this field unset. # Corresponds to the JSON property `nameServerSet` # @return [String] attr_accessor :name_server_set - # + # Delegate your managed_zone to these virtual name servers; defined by the + # server (output only) # Corresponds to the JSON property `nameServers` # @return [Array] attr_accessor :name_servers - # + # The presence of this field indicates that DNS Peering is enabled for this + # zone. The value of this field contains the network to peer with. # Corresponds to the JSON property `peeringConfig` # @return [Google::Apis::DnsV1::ManagedZonePeeringConfig] attr_accessor :peering_config - # + # For privately visible zones, the set of Virtual Private Cloud resources + # that the zone is visible from. # Corresponds to the JSON property `privateVisibilityConfig` # @return [Google::Apis::DnsV1::ManagedZonePrivateVisibilityConfig] attr_accessor :private_visibility_config - # + # The presence of this field indicates that this is a managed reverse + # lookup zone and Cloud DNS will resolve reverse lookup queries using + # automatically configured records for VPC resources. This only applies + # to networks listed under private_visibility_config. # Corresponds to the JSON property `reverseLookupConfig` # @return [Google::Apis::DnsV1::ManagedZoneReverseLookupConfig] attr_accessor :reverse_lookup_config - # + # The zone's visibility: public zones are exposed to the Internet, while + # private zones are visible only to Virtual Private Cloud resources. # Corresponds to the JSON property `visibility` # @return [String] attr_accessor :visibility @@ -403,23 +466,24 @@ module Google class ManagedZoneDnsSecConfig include Google::Apis::Core::Hashable - # + # Specifies parameters for generating initial DnsKeys for this + # ManagedZone. Can only be changed while the state is OFF. # Corresponds to the JSON property `defaultKeySpecs` # @return [Array] attr_accessor :default_key_specs - # Identifies what kind of resource this is. Value: the fixed string "dns# - # managedZoneDnsSecConfig". + # # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # + # Specifies the mechanism for authenticated denial-of-existence responses. + # Can only be changed while the state is OFF. # Corresponds to the JSON property `nonExistence` # @return [String] attr_accessor :non_existence - # + # Specifies whether DNSSEC is enabled, and what mode it is in. # Corresponds to the JSON property `state` # @return [String] attr_accessor :state @@ -441,13 +505,14 @@ module Google class ManagedZoneForwardingConfig include Google::Apis::Core::Hashable - # Identifies what kind of resource this is. Value: the fixed string "dns# - # managedZoneForwardingConfig". + # # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # + # List of target name servers to forward to. + # Cloud DNS will select the best available name server if more than one + # target is given. # Corresponds to the JSON property `targetNameServers` # @return [Array] attr_accessor :target_name_servers @@ -467,18 +532,21 @@ module Google class ManagedZoneForwardingConfigNameServerTarget include Google::Apis::Core::Hashable - # + # Forwarding path for this NameServerTarget, if unset or set to DEFAULT, + # Cloud DNS will make forwarding decision based on address ranges, + # i.e. RFC1918 addresses go to the VPC, Non-RFC1918 addresses go to the + # Internet. When set to PRIVATE, Cloud DNS will always send queries + # through VPC for this target # Corresponds to the JSON property `forwardingPath` # @return [String] attr_accessor :forwarding_path - # + # IPv4 address of a target name server. # Corresponds to the JSON property `ipv4Address` # @return [String] attr_accessor :ipv4_address - # Identifies what kind of resource this is. Value: the fixed string "dns# - # managedZoneForwardingConfigNameServerTarget". + # # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -499,22 +567,30 @@ module Google class ManagedZoneOperationsListResponse include Google::Apis::Core::Hashable - # + # Elements common to every response. # Corresponds to the JSON property `header` # @return [Google::Apis::DnsV1::ResponseHeader] attr_accessor :header - # Type of resource. + # # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # + # The presence of this field indicates that there exist more results + # following your last page of results in pagination order. To fetch them, + # make another list request using this value as your page token. + # In this way you can retrieve the complete contents of even very large + # collections one page at a time. However, if the contents of the collection + # change between the first and last paginated list request, the set of all + # elements returned will be an inconsistent view of the collection. There is + # no way to retrieve a consistent snapshot of a collection larger than the + # maximum page size. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token - # + # The operation resources. # Corresponds to the JSON property `operations` # @return [Array] attr_accessor :operations @@ -536,13 +612,12 @@ module Google class ManagedZonePeeringConfig include Google::Apis::Core::Hashable - # Identifies what kind of resource this is. Value: the fixed string "dns# - # managedZonePeeringConfig". + # # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # + # The network with which to peer. # Corresponds to the JSON property `targetNetwork` # @return [Google::Apis::DnsV1::ManagedZonePeeringConfigTargetNetwork] attr_accessor :target_network @@ -562,18 +637,24 @@ module Google class ManagedZonePeeringConfigTargetNetwork include Google::Apis::Core::Hashable - # + # The time at which the zone was deactivated, in RFC 3339 date-time + # format. An empty string indicates that the peering connection is + # active. The producer network can deactivate a zone. The zone is + # automatically deactivated if the producer network that the zone + # targeted is deleted. Output only. # Corresponds to the JSON property `deactivateTime` # @return [String] attr_accessor :deactivate_time - # Identifies what kind of resource this is. Value: the fixed string "dns# - # managedZonePeeringConfigTargetNetwork". + # # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # + # The fully qualified URL of the VPC network to forward queries to. + # This should be formatted like + # https://www.googleapis.com/compute/v1/projects/`project`/global/networks/` + # network` # Corresponds to the JSON property `networkUrl` # @return [String] attr_accessor :network_url @@ -594,13 +675,12 @@ module Google class ManagedZonePrivateVisibilityConfig include Google::Apis::Core::Hashable - # Identifies what kind of resource this is. Value: the fixed string "dns# - # managedZonePrivateVisibilityConfig". + # # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # + # The list of VPC networks that can see this zone. # Corresponds to the JSON property `networks` # @return [Array] attr_accessor :networks @@ -620,13 +700,15 @@ module Google class ManagedZonePrivateVisibilityConfigNetwork include Google::Apis::Core::Hashable - # Identifies what kind of resource this is. Value: the fixed string "dns# - # managedZonePrivateVisibilityConfigNetwork". + # # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # + # The fully qualified URL of the VPC network to bind to. + # This should be formatted like + # https://www.googleapis.com/compute/v1/projects/`project`/global/networks/` + # network` # Corresponds to the JSON property `networkUrl` # @return [String] attr_accessor :network_url @@ -646,8 +728,7 @@ module Google class ManagedZoneReverseLookupConfig include Google::Apis::Core::Hashable - # Identifies what kind of resource this is. Value: the fixed string "dns# - # managedZoneReverseLookupConfig". + # # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -666,7 +747,7 @@ module Google class ListManagedZonesResponse include Google::Apis::Core::Hashable - # + # Elements common to every response. # Corresponds to the JSON property `header` # @return [Google::Apis::DnsV1::ResponseHeader] attr_accessor :header @@ -676,12 +757,20 @@ module Google # @return [String] attr_accessor :kind - # + # The managed zone resources. # Corresponds to the JSON property `managedZones` # @return [Array] attr_accessor :managed_zones - # + # The presence of this field indicates that there exist more results + # following your last page of results in pagination order. To fetch them, + # make another list request using this value as your page token. + # In this way you can retrieve the complete contents of even very large + # collections one page at a time. However, if the contents of the collection + # change between the first and last paginated list request, the set of all + # elements returned will be an inconsistent view of the collection. There is + # no way to retrieve a consistent snapshot of a collection larger than the + # maximum page size. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -699,47 +788,61 @@ module Google end end - # + # An operation represents a successful mutation performed on a Cloud DNS + # resource. + # Operations provide: + # - An audit log of server resource mutations. + # - A way to recover/retry API calls in the case where the response is never + # received by the caller. Use the caller specified client_operation_id. class Operation include Google::Apis::Core::Hashable - # + # Only populated if the operation targeted a DnsKey (output only). # Corresponds to the JSON property `dnsKeyContext` # @return [Google::Apis::DnsV1::OperationDnsKeyContext] attr_accessor :dns_key_context - # + # Unique identifier for the resource. This is the client_operation_id if + # the client specified it when the mutation was initiated, otherwise, + # it is generated by the server. The name must be 1-63 characters long + # and match the regular expression [-a-z0-9]? (output only) # Corresponds to the JSON property `id` # @return [String] attr_accessor :id - # Identifies what kind of resource this is. Value: the fixed string "dns# - # operation". + # # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # + # The time that this operation was started by the server. This is in RFC3339 + # text format (output only). # Corresponds to the JSON property `startTime` # @return [String] attr_accessor :start_time - # + # Status of the operation. Can be one of the following: "PENDING" or "DONE" + # (output only). A status of "DONE" means that the + # request to update the authoritative servers has been sent, but the + # servers might not be updated yet. # Corresponds to the JSON property `status` # @return [String] attr_accessor :status - # + # Type of the operation. Operations include insert, update, and delete + # (output only). # Corresponds to the JSON property `type` # @return [String] attr_accessor :type - # + # User who requested the operation, for example: user@example.com. + # cloud-dns-system for operations automatically done by the system. + # (output only) # Corresponds to the JSON property `user` # @return [String] attr_accessor :user - # + # Only populated if the operation targeted a ManagedZone (output only). # Corresponds to the JSON property `zoneContext` # @return [Google::Apis::DnsV1::OperationManagedZoneContext] attr_accessor :zone_context @@ -765,12 +868,12 @@ module Google class OperationDnsKeyContext include Google::Apis::Core::Hashable - # + # A DNSSEC key pair. # Corresponds to the JSON property `newValue` # @return [Google::Apis::DnsV1::DnsKey] attr_accessor :new_value - # + # A DNSSEC key pair. # Corresponds to the JSON property `oldValue` # @return [Google::Apis::DnsV1::DnsKey] attr_accessor :old_value @@ -790,12 +893,16 @@ module Google class OperationManagedZoneContext include Google::Apis::Core::Hashable - # + # A zone is a subtree of the DNS namespace under one administrative + # responsibility. A ManagedZone is a resource that represents a DNS zone + # hosted by the Cloud DNS service. # Corresponds to the JSON property `newValue` # @return [Google::Apis::DnsV1::ManagedZone] attr_accessor :new_value - # + # A zone is a subtree of the DNS namespace under one administrative + # responsibility. A ManagedZone is a resource that represents a DNS zone + # hosted by the Cloud DNS service. # Corresponds to the JSON property `oldValue` # @return [Google::Apis::DnsV1::ManagedZone] attr_accessor :old_value @@ -815,7 +922,7 @@ module Google class PoliciesListResponse include Google::Apis::Core::Hashable - # + # Elements common to every response. # Corresponds to the JSON property `header` # @return [Google::Apis::DnsV1::ResponseHeader] attr_accessor :header @@ -825,12 +932,20 @@ module Google # @return [String] attr_accessor :kind - # + # The presence of this field indicates that there exist more results + # following your last page of results in pagination order. To fetch them, + # make another list request using this value as your page token. + # In this way you can retrieve the complete contents of even very large + # collections one page at a time. However, if the contents of the collection + # change between the first and last paginated list request, the set of all + # elements returned will be an inconsistent view of the collection. There is + # no way to retrieve a consistent snapshot of a collection larger than the + # maximum page size. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token - # + # The policy resources. # Corresponds to the JSON property `policies` # @return [Array] attr_accessor :policies @@ -852,12 +967,13 @@ module Google class PoliciesPatchResponse include Google::Apis::Core::Hashable - # + # Elements common to every response. # Corresponds to the JSON property `header` # @return [Google::Apis::DnsV1::ResponseHeader] attr_accessor :header - # + # A policy is a collection of DNS rules applied to one or more Virtual Private + # Cloud resources. # Corresponds to the JSON property `policy` # @return [Google::Apis::DnsV1::Policy] attr_accessor :policy @@ -877,12 +993,13 @@ module Google class PoliciesUpdateResponse include Google::Apis::Core::Hashable - # + # Elements common to every response. # Corresponds to the JSON property `header` # @return [Google::Apis::DnsV1::ResponseHeader] attr_accessor :header - # + # A policy is a collection of DNS rules applied to one or more Virtual Private + # Cloud resources. # Corresponds to the JSON property `policy` # @return [Google::Apis::DnsV1::Policy] attr_accessor :policy @@ -898,48 +1015,56 @@ module Google end end - # + # A policy is a collection of DNS rules applied to one or more Virtual Private + # Cloud resources. class Policy include Google::Apis::Core::Hashable - # + # Sets an alternative name server for the associated networks. When + # specified, all DNS queries are forwarded to a name server that you + # choose. Names such as .internal are not available when an alternative + # name server is specified. # Corresponds to the JSON property `alternativeNameServerConfig` # @return [Google::Apis::DnsV1::PolicyAlternativeNameServerConfig] attr_accessor :alternative_name_server_config - # + # A mutable string of at most 1024 characters associated with this resource + # for the user's convenience. Has no effect on the policy's function. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description - # + # Allows networks bound to this policy to receive DNS queries sent by VMs or + # applications over VPN connections. When enabled, a virtual IP address will + # be allocated from each of the sub-networks that are bound to this policy. # Corresponds to the JSON property `enableInboundForwarding` # @return [Boolean] attr_accessor :enable_inbound_forwarding alias_method :enable_inbound_forwarding?, :enable_inbound_forwarding - # + # Controls whether logging is enabled for the networks bound to this policy. + # Defaults to no logging if not set. # Corresponds to the JSON property `enableLogging` # @return [Boolean] attr_accessor :enable_logging alias_method :enable_logging?, :enable_logging - # + # Unique identifier for the resource; defined by the server (output only). # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id - # Identifies what kind of resource this is. Value: the fixed string "dns#policy". + # # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # + # User assigned name for this policy. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # + # List of network names specifying networks to which this policy is applied. # Corresponds to the JSON property `networks` # @return [Array] attr_accessor :networks @@ -965,13 +1090,15 @@ module Google class PolicyAlternativeNameServerConfig include Google::Apis::Core::Hashable - # Identifies what kind of resource this is. Value: the fixed string "dns# - # policyAlternativeNameServerConfig". + # # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # + # Sets an alternative name server for the associated networks. When + # specified, all DNS queries are forwarded to a name server that you + # choose. Names such as .internal are not available when an alternative + # name server is specified. # Corresponds to the JSON property `targetNameServers` # @return [Array] attr_accessor :target_name_servers @@ -991,18 +1118,21 @@ module Google class PolicyAlternativeNameServerConfigTargetNameServer include Google::Apis::Core::Hashable - # + # Forwarding path for this TargetNameServer, if unset or set to DEFAULT, + # Cloud DNS will make forwarding decision based on address ranges, + # i.e. RFC1918 addresses go to the VPC, Non-RFC1918 addresses go to the + # Internet. When set to PRIVATE, Cloud DNS will always send queries + # through VPC for this target # Corresponds to the JSON property `forwardingPath` # @return [String] attr_accessor :forwarding_path - # + # IPv4 address to forward to. # Corresponds to the JSON property `ipv4Address` # @return [String] attr_accessor :ipv4_address - # Identifies what kind of resource this is. Value: the fixed string "dns# - # policyAlternativeNameServerConfigTargetNameServer". + # # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -1023,13 +1153,15 @@ module Google class PolicyNetwork include Google::Apis::Core::Hashable - # Identifies what kind of resource this is. Value: the fixed string "dns# - # policyNetwork". + # # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # + # The fully qualified URL of the VPC network to bind to. + # This should be formatted like + # https://www.googleapis.com/compute/v1/projects/`project`/global/networks/` + # network` # Corresponds to the JSON property `networkUrl` # @return [String] attr_accessor :network_url @@ -1045,27 +1177,29 @@ module Google end end - # + # A project resource. The project is a top level container for resources + # including Cloud DNS ManagedZones. Projects can be created only in the APIs + # console. class Project include Google::Apis::Core::Hashable - # + # User assigned unique identifier for the resource (output only). # Corresponds to the JSON property `id` # @return [String] attr_accessor :id - # Identifies what kind of resource this is. Value: the fixed string "dns#project" - # . + # # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # + # Unique numeric identifier for the resource; defined by the server (output + # only). # Corresponds to the JSON property `number` # @return [Fixnum] attr_accessor :number - # + # Limits associated with a Project. # Corresponds to the JSON property `quota` # @return [Google::Apis::DnsV1::Quota] attr_accessor :quota @@ -1083,81 +1217,86 @@ module Google end end - # + # Limits associated with a Project. class Quota include Google::Apis::Core::Hashable - # + # Maximum allowed number of DnsKeys per ManagedZone. # Corresponds to the JSON property `dnsKeysPerManagedZone` # @return [Fixnum] attr_accessor :dns_keys_per_managed_zone - # Identifies what kind of resource this is. Value: the fixed string "dns#quota". + # # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # + # Maximum allowed number of managed zones in the project. # Corresponds to the JSON property `managedZones` # @return [Fixnum] attr_accessor :managed_zones - # + # Maximum allowed number of managed zones which can be attached to a + # network. # Corresponds to the JSON property `managedZonesPerNetwork` # @return [Fixnum] attr_accessor :managed_zones_per_network - # + # Maximum allowed number of networks to which a privately scoped zone can be + # attached. # Corresponds to the JSON property `networksPerManagedZone` # @return [Fixnum] attr_accessor :networks_per_managed_zone - # + # Maximum allowed number of networks per policy. # Corresponds to the JSON property `networksPerPolicy` # @return [Fixnum] attr_accessor :networks_per_policy - # + # Maximum allowed number of policies per project. # Corresponds to the JSON property `policies` # @return [Fixnum] attr_accessor :policies - # + # Maximum allowed number of ResourceRecords per ResourceRecordSet. # Corresponds to the JSON property `resourceRecordsPerRrset` # @return [Fixnum] attr_accessor :resource_records_per_rrset - # + # Maximum allowed number of ResourceRecordSets to add per + # ChangesCreateRequest. # Corresponds to the JSON property `rrsetAdditionsPerChange` # @return [Fixnum] attr_accessor :rrset_additions_per_change - # + # Maximum allowed number of ResourceRecordSets to delete per + # ChangesCreateRequest. # Corresponds to the JSON property `rrsetDeletionsPerChange` # @return [Fixnum] attr_accessor :rrset_deletions_per_change - # + # Maximum allowed number of ResourceRecordSets per zone in the project. # Corresponds to the JSON property `rrsetsPerManagedZone` # @return [Fixnum] attr_accessor :rrsets_per_managed_zone - # + # Maximum allowed number of target name servers per managed forwarding zone. # Corresponds to the JSON property `targetNameServersPerManagedZone` # @return [Fixnum] attr_accessor :target_name_servers_per_managed_zone - # + # Maximum allowed number of alternative target name servers per policy. # Corresponds to the JSON property `targetNameServersPerPolicy` # @return [Fixnum] attr_accessor :target_name_servers_per_policy - # + # Maximum allowed size for total rrdata in one ChangesCreateRequest in + # bytes. # Corresponds to the JSON property `totalRrdataSizePerChange` # @return [Fixnum] attr_accessor :total_rrdata_size_per_change - # + # DNSSEC algorithm and key length types that can be used for DnsKeys. # Corresponds to the JSON property `whitelistedKeySpecs` # @return [Array] attr_accessor :whitelisted_key_specs @@ -1186,37 +1325,39 @@ module Google end end - # + # A unit of data that will be returned by the DNS servers. class ResourceRecordSet include Google::Apis::Core::Hashable - # Identifies what kind of resource this is. Value: the fixed string "dns# - # resourceRecordSet". + # # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # + # For example, www.example.com. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # + # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- see + # examples. # Corresponds to the JSON property `rrdatas` # @return [Array] attr_accessor :rrdatas - # + # As defined in RFC 4034 (section 3.2). # Corresponds to the JSON property `signatureRrdatas` # @return [Array] attr_accessor :signature_rrdatas - # + # Number of seconds that this ResourceRecordSet can be cached by resolvers. # Corresponds to the JSON property `ttl` # @return [Fixnum] attr_accessor :ttl - # + # The identifier of a supported record type. See the list of + # Supported + # DNS record types. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type @@ -1240,7 +1381,7 @@ module Google class ListResourceRecordSetsResponse include Google::Apis::Core::Hashable - # + # Elements common to every response. # Corresponds to the JSON property `header` # @return [Google::Apis::DnsV1::ResponseHeader] attr_accessor :header @@ -1250,12 +1391,20 @@ module Google # @return [String] attr_accessor :kind - # + # The presence of this field indicates that there exist more results + # following your last page of results in pagination order. To fetch them, + # make another list request using this value as your pagination token. + # In this way you can retrieve the complete contents of even very large + # collections one page at a time. However, if the contents of the collection + # change between the first and last paginated list request, the set of all + # elements returned will be an inconsistent view of the collection. There is + # no way to retrieve a consistent snapshot of a collection larger than the + # maximum page size. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token - # + # The resource record set resources. # Corresponds to the JSON property `rrsets` # @return [Array] attr_accessor :rrsets @@ -1273,11 +1422,13 @@ module Google end end - # + # Elements common to every response. class ResponseHeader include Google::Apis::Core::Hashable - # + # For mutating operation requests that completed successfully. + # This is the client_operation_id if the client specified it, + # otherwise it is generated by the server (output only). # Corresponds to the JSON property `operationId` # @return [String] attr_accessor :operation_id diff --git a/generated/google/apis/dns_v1/service.rb b/generated/google/apis/dns_v1/service.rb index b8db05eea..e183cc23c 100644 --- a/generated/google/apis/dns_v1/service.rb +++ b/generated/google/apis/dns_v1/service.rb @@ -20,9 +20,9 @@ require 'google/apis/errors' module Google module Apis module DnsV1 - # Google Cloud DNS API + # Cloud DNS API # - # Configures and serves authoritative DNS records. + # # # @example # require 'google/apis/dns_v1' @@ -30,7 +30,7 @@ module Google # Dns = Google::Apis::DnsV1 # Alias the module # service = Dns::DnsService.new # - # @see https://developers.google.com/cloud-dns + # @see http://developers.google.com/cloud-dns class DnsService < Google::Apis::Core::BaseService # @return [String] # API key. Your API key identifies your project and provides you with API access, @@ -38,31 +38,31 @@ module Google attr_accessor :key # @return [String] - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. attr_accessor :quota_user - # @return [String] - # Deprecated. Please use quotaUser instead. - attr_accessor :user_ip - def initialize - super('https://dns.googleapis.com/', 'dns/v1/projects/') - @batch_path = 'batch/dns/v1' + super('https://dns.googleapis.com/', '') + @batch_path = 'batch' end - # + # Atomically update the ResourceRecordSet collection. # @param [String] project + # Identifies the project addressed by this request. # @param [String] managed_zone + # Identifies the managed zone addressed by this request. Can be the managed + # zone name or id. # @param [Google::Apis::DnsV1::Change] change_object # @param [String] client_operation_id + # For mutating operation requests only. An optional identifier + # specified by the client. Must be unique for operation resources in the + # Operations collection. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -75,8 +75,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def create_change(project, managed_zone, change_object = nil, client_operation_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, '{project}/managedZones/{managedZone}/changes', options) + def create_change(project, managed_zone, change_object = nil, client_operation_id: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'dns/v1/projects/{project}/managedZones/{managedZone}/changes', options) command.request_representation = Google::Apis::DnsV1::Change::Representation command.request_object = change_object command.response_representation = Google::Apis::DnsV1::Change::Representation @@ -86,22 +86,27 @@ module Google command.query['clientOperationId'] = client_operation_id unless client_operation_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 - # + # Fetch the representation of an existing Change. # @param [String] project + # Identifies the project addressed by this request. # @param [String] managed_zone + # Identifies the managed zone addressed by this request. Can be the managed + # zone name or id. # @param [String] change_id + # The identifier of the requested change, from a previous + # ResourceRecordSetsChangeResponse. # @param [String] client_operation_id + # For mutating operation requests only. An optional identifier + # specified by the client. Must be unique for operation resources in the + # Operations collection. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -114,8 +119,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_change(project, managed_zone, change_id, client_operation_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, '{project}/managedZones/{managedZone}/changes/{changeId}', options) + def get_change(project, managed_zone, change_id, client_operation_id: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'dns/v1/projects/{project}/managedZones/{managedZone}/changes/{changeId}', options) command.response_representation = Google::Apis::DnsV1::Change::Representation command.response_class = Google::Apis::DnsV1::Change command.params['project'] = project unless project.nil? @@ -124,24 +129,30 @@ module Google command.query['clientOperationId'] = client_operation_id unless client_operation_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 - # + # Enumerate Changes to a ResourceRecordSet collection. # @param [String] project + # Identifies the project addressed by this request. # @param [String] managed_zone + # Identifies the managed zone addressed by this request. Can be the managed + # zone name or id. # @param [Fixnum] max_results + # Optional. Maximum number of results to be returned. If unspecified, the + # server will decide how many results to return. # @param [String] page_token + # Optional. A tag returned by a previous list request that was truncated. + # Use this parameter to continue a previous list request. # @param [String] sort_by + # Sorting criterion. The only supported value is change sequence. # @param [String] sort_order + # Sorting order direction: 'ascending' or 'descending'. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -154,8 +165,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_changes(project, managed_zone, max_results: nil, page_token: nil, sort_by: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, '{project}/managedZones/{managedZone}/changes', options) + def list_changes(project, managed_zone, max_results: nil, page_token: nil, sort_by: nil, sort_order: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'dns/v1/projects/{project}/managedZones/{managedZone}/changes', options) command.response_representation = Google::Apis::DnsV1::ListChangesResponse::Representation command.response_class = Google::Apis::DnsV1::ListChangesResponse command.params['project'] = project unless project.nil? @@ -166,23 +177,30 @@ module Google command.query['sortOrder'] = sort_order unless sort_order.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # + # Fetch the representation of an existing DnsKey. # @param [String] project + # Identifies the project addressed by this request. # @param [String] managed_zone + # Identifies the managed zone addressed by this request. Can be the managed + # zone name or id. # @param [String] dns_key_id + # The identifier of the requested DnsKey. # @param [String] client_operation_id + # For mutating operation requests only. An optional identifier + # specified by the client. Must be unique for operation resources in the + # Operations collection. # @param [String] digest_type + # An optional comma-separated list of digest types to compute and display + # for key signing keys. If omitted, the recommended digest type will be + # computed and displayed. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -195,8 +213,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_dns_key(project, managed_zone, dns_key_id, client_operation_id: nil, digest_type: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, '{project}/managedZones/{managedZone}/dnsKeys/{dnsKeyId}', options) + def get_dns_key(project, managed_zone, dns_key_id, client_operation_id: nil, digest_type: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'dns/v1/projects/{project}/managedZones/{managedZone}/dnsKeys/{dnsKeyId}', options) command.response_representation = Google::Apis::DnsV1::DnsKey::Representation command.response_class = Google::Apis::DnsV1::DnsKey command.params['project'] = project unless project.nil? @@ -206,23 +224,30 @@ module Google command.query['digestType'] = digest_type unless digest_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 - # + # Enumerate DnsKeys to a ResourceRecordSet collection. # @param [String] project + # Identifies the project addressed by this request. # @param [String] managed_zone + # Identifies the managed zone addressed by this request. Can be the managed + # zone name or id. # @param [String] digest_type + # An optional comma-separated list of digest types to compute and display + # for key signing keys. If omitted, the recommended digest type will be + # computed and displayed. # @param [Fixnum] max_results + # Optional. Maximum number of results to be returned. If unspecified, the + # server will decide how many results to return. # @param [String] page_token + # Optional. A tag returned by a previous list request that was truncated. + # Use this parameter to continue a previous list request. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -235,8 +260,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_dns_keys(project, managed_zone, digest_type: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, '{project}/managedZones/{managedZone}/dnsKeys', options) + def list_dns_keys(project, managed_zone, digest_type: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'dns/v1/projects/{project}/managedZones/{managedZone}/dnsKeys', options) command.response_representation = Google::Apis::DnsV1::DnsKeysListResponse::Representation command.response_class = Google::Apis::DnsV1::DnsKeysListResponse command.params['project'] = project unless project.nil? @@ -246,22 +271,25 @@ module Google command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # + # Fetch the representation of an existing Operation. # @param [String] project + # Identifies the project addressed by this request. # @param [String] managed_zone + # Identifies the managed zone addressed by this request. # @param [String] operation + # Identifies the operation addressed by this request. # @param [String] client_operation_id + # For mutating operation requests only. An optional identifier + # specified by the client. Must be unique for operation resources in the + # Operations collection. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -274,8 +302,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_managed_zone_operation(project, managed_zone, operation, client_operation_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, '{project}/managedZones/{managedZone}/operations/{operation}', options) + def get_managed_zone_operation(project, managed_zone, operation, client_operation_id: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'dns/v1/projects/{project}/managedZones/{managedZone}/operations/{operation}', options) command.response_representation = Google::Apis::DnsV1::Operation::Representation command.response_class = Google::Apis::DnsV1::Operation command.params['project'] = project unless project.nil? @@ -284,23 +312,27 @@ module Google command.query['clientOperationId'] = client_operation_id unless client_operation_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 - # + # Enumerate Operations for the given ManagedZone. # @param [String] project + # Identifies the project addressed by this request. # @param [String] managed_zone + # Identifies the managed zone addressed by this request. # @param [Fixnum] max_results + # Optional. Maximum number of results to be returned. If unspecified, the + # server will decide how many results to return. # @param [String] page_token + # Optional. A tag returned by a previous list request that was truncated. + # Use this parameter to continue a previous list request. # @param [String] sort_by + # Sorting criterion. The only supported values are START_TIME and ID. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -313,8 +345,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_managed_zone_operations(project, managed_zone, max_results: nil, page_token: nil, sort_by: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, '{project}/managedZones/{managedZone}/operations', options) + def list_managed_zone_operations(project, managed_zone, max_results: nil, page_token: nil, sort_by: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'dns/v1/projects/{project}/managedZones/{managedZone}/operations', options) command.response_representation = Google::Apis::DnsV1::ManagedZoneOperationsListResponse::Representation command.response_class = Google::Apis::DnsV1::ManagedZoneOperationsListResponse command.params['project'] = project unless project.nil? @@ -324,21 +356,22 @@ module Google command.query['sortBy'] = sort_by unless sort_by.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 - # + # Create a new ManagedZone. # @param [String] project + # Identifies the project addressed by this request. # @param [Google::Apis::DnsV1::ManagedZone] managed_zone_object # @param [String] client_operation_id + # For mutating operation requests only. An optional identifier + # specified by the client. Must be unique for operation resources in the + # Operations collection. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -351,8 +384,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def create_managed_zone(project, managed_zone_object = nil, client_operation_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, '{project}/managedZones', options) + def create_managed_zone(project, managed_zone_object = nil, client_operation_id: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'dns/v1/projects/{project}/managedZones', options) command.request_representation = Google::Apis::DnsV1::ManagedZone::Representation command.request_object = managed_zone_object command.response_representation = Google::Apis::DnsV1::ManagedZone::Representation @@ -361,21 +394,24 @@ module Google command.query['clientOperationId'] = client_operation_id unless client_operation_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 - # + # Delete a previously created ManagedZone. # @param [String] project + # Identifies the project addressed by this request. # @param [String] managed_zone + # Identifies the managed zone addressed by this request. Can be the managed + # zone name or id. # @param [String] client_operation_id + # For mutating operation requests only. An optional identifier + # specified by the client. Must be unique for operation resources in the + # Operations collection. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -388,28 +424,31 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def delete_managed_zone(project, managed_zone, client_operation_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:delete, '{project}/managedZones/{managedZone}', options) + def delete_managed_zone(project, managed_zone, client_operation_id: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'dns/v1/projects/{project}/managedZones/{managedZone}', options) command.params['project'] = project unless project.nil? command.params['managedZone'] = managed_zone unless managed_zone.nil? command.query['clientOperationId'] = client_operation_id unless client_operation_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 - # + # Fetch the representation of an existing ManagedZone. # @param [String] project + # Identifies the project addressed by this request. # @param [String] managed_zone + # Identifies the managed zone addressed by this request. Can be the managed + # zone name or id. # @param [String] client_operation_id + # For mutating operation requests only. An optional identifier + # specified by the client. Must be unique for operation resources in the + # Operations collection. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -422,8 +461,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_managed_zone(project, managed_zone, client_operation_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, '{project}/managedZones/{managedZone}', options) + def get_managed_zone(project, managed_zone, client_operation_id: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'dns/v1/projects/{project}/managedZones/{managedZone}', options) command.response_representation = Google::Apis::DnsV1::ManagedZone::Representation command.response_class = Google::Apis::DnsV1::ManagedZone command.params['project'] = project unless project.nil? @@ -431,22 +470,25 @@ module Google command.query['clientOperationId'] = client_operation_id unless client_operation_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 - # + # Enumerate ManagedZones that have been created but not yet deleted. # @param [String] project + # Identifies the project addressed by this request. # @param [String] dns_name + # Restricts the list to return only zones with this domain name. # @param [Fixnum] max_results + # Optional. Maximum number of results to be returned. If unspecified, the + # server will decide how many results to return. # @param [String] page_token + # Optional. A tag returned by a previous list request that was truncated. + # Use this parameter to continue a previous list request. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -459,8 +501,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_managed_zones(project, dns_name: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, '{project}/managedZones', options) + def list_managed_zones(project, dns_name: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'dns/v1/projects/{project}/managedZones', options) command.response_representation = Google::Apis::DnsV1::ListManagedZonesResponse::Representation command.response_class = Google::Apis::DnsV1::ListManagedZonesResponse command.params['project'] = project unless project.nil? @@ -469,22 +511,25 @@ module Google command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # + # Apply a partial update to an existing ManagedZone. # @param [String] project + # Identifies the project addressed by this request. # @param [String] managed_zone + # Identifies the managed zone addressed by this request. Can be the managed + # zone name or id. # @param [Google::Apis::DnsV1::ManagedZone] managed_zone_object # @param [String] client_operation_id + # For mutating operation requests only. An optional identifier + # specified by the client. Must be unique for operation resources in the + # Operations collection. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -497,8 +542,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def patch_managed_zone(project, managed_zone, managed_zone_object = nil, client_operation_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:patch, '{project}/managedZones/{managedZone}', options) + def patch_managed_zone(project, managed_zone, managed_zone_object = nil, client_operation_id: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:patch, 'dns/v1/projects/{project}/managedZones/{managedZone}', options) command.request_representation = Google::Apis::DnsV1::ManagedZone::Representation command.request_object = managed_zone_object command.response_representation = Google::Apis::DnsV1::Operation::Representation @@ -508,22 +553,25 @@ module Google command.query['clientOperationId'] = client_operation_id unless client_operation_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # + # Update an existing ManagedZone. # @param [String] project + # Identifies the project addressed by this request. # @param [String] managed_zone + # Identifies the managed zone addressed by this request. Can be the managed + # zone name or id. # @param [Google::Apis::DnsV1::ManagedZone] managed_zone_object # @param [String] client_operation_id + # For mutating operation requests only. An optional identifier + # specified by the client. Must be unique for operation resources in the + # Operations collection. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -536,8 +584,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def update_managed_zone(project, managed_zone, managed_zone_object = nil, client_operation_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:put, '{project}/managedZones/{managedZone}', options) + def update_managed_zone(project, managed_zone, managed_zone_object = nil, client_operation_id: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:put, 'dns/v1/projects/{project}/managedZones/{managedZone}', options) command.request_representation = Google::Apis::DnsV1::ManagedZone::Representation command.request_object = managed_zone_object command.response_representation = Google::Apis::DnsV1::Operation::Representation @@ -547,21 +595,22 @@ module Google command.query['clientOperationId'] = client_operation_id unless client_operation_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 - # + # Create a new Policy # @param [String] project + # Identifies the project addressed by this request. # @param [Google::Apis::DnsV1::Policy] policy_object # @param [String] client_operation_id + # For mutating operation requests only. An optional identifier + # specified by the client. Must be unique for operation resources in the + # Operations collection. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -574,8 +623,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def create_policy(project, policy_object = nil, client_operation_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, '{project}/policies', options) + def create_policy(project, policy_object = nil, client_operation_id: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'dns/v1/projects/{project}/policies', options) command.request_representation = Google::Apis::DnsV1::Policy::Representation command.request_object = policy_object command.response_representation = Google::Apis::DnsV1::Policy::Representation @@ -584,21 +633,24 @@ module Google command.query['clientOperationId'] = client_operation_id unless client_operation_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 - # + # Delete a previously created Policy. Will fail if the policy is still being + # referenced by a network. # @param [String] project + # Identifies the project addressed by this request. # @param [String] policy + # User given friendly name of the policy addressed by this request. # @param [String] client_operation_id + # For mutating operation requests only. An optional identifier + # specified by the client. Must be unique for operation resources in the + # Operations collection. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -611,28 +663,30 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def delete_policy(project, policy, client_operation_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:delete, '{project}/policies/{policy}', options) + def delete_policy(project, policy, client_operation_id: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'dns/v1/projects/{project}/policies/{policy}', options) command.params['project'] = project unless project.nil? command.params['policy'] = policy unless policy.nil? command.query['clientOperationId'] = client_operation_id unless client_operation_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 - # + # Fetch the representation of an existing Policy. # @param [String] project + # Identifies the project addressed by this request. # @param [String] policy + # User given friendly name of the policy addressed by this request. # @param [String] client_operation_id + # For mutating operation requests only. An optional identifier + # specified by the client. Must be unique for operation resources in the + # Operations collection. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -645,8 +699,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_policy(project, policy, client_operation_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, '{project}/policies/{policy}', options) + def get_policy(project, policy, client_operation_id: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'dns/v1/projects/{project}/policies/{policy}', options) command.response_representation = Google::Apis::DnsV1::Policy::Representation command.response_class = Google::Apis::DnsV1::Policy command.params['project'] = project unless project.nil? @@ -654,21 +708,23 @@ module Google command.query['clientOperationId'] = client_operation_id unless client_operation_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 - # + # Enumerate all Policies associated with a project. # @param [String] project + # Identifies the project addressed by this request. # @param [Fixnum] max_results + # Optional. Maximum number of results to be returned. If unspecified, the + # server will decide how many results to return. # @param [String] page_token + # Optional. A tag returned by a previous list request that was truncated. + # Use this parameter to continue a previous list request. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -681,8 +737,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_policies(project, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, '{project}/policies', options) + def list_policies(project, max_results: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'dns/v1/projects/{project}/policies', options) command.response_representation = Google::Apis::DnsV1::PoliciesListResponse::Representation command.response_class = Google::Apis::DnsV1::PoliciesListResponse command.params['project'] = project unless project.nil? @@ -690,22 +746,24 @@ module Google command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # + # Apply a partial update to an existing Policy. # @param [String] project + # Identifies the project addressed by this request. # @param [String] policy + # User given friendly name of the policy addressed by this request. # @param [Google::Apis::DnsV1::Policy] policy_object # @param [String] client_operation_id + # For mutating operation requests only. An optional identifier + # specified by the client. Must be unique for operation resources in the + # Operations collection. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -718,8 +776,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def patch_policy(project, policy, policy_object = nil, client_operation_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:patch, '{project}/policies/{policy}', options) + def patch_policy(project, policy, policy_object = nil, client_operation_id: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:patch, 'dns/v1/projects/{project}/policies/{policy}', options) command.request_representation = Google::Apis::DnsV1::Policy::Representation command.request_object = policy_object command.response_representation = Google::Apis::DnsV1::PoliciesPatchResponse::Representation @@ -729,22 +787,24 @@ module Google command.query['clientOperationId'] = client_operation_id unless client_operation_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # + # Update an existing Policy. # @param [String] project + # Identifies the project addressed by this request. # @param [String] policy + # User given friendly name of the policy addressed by this request. # @param [Google::Apis::DnsV1::Policy] policy_object # @param [String] client_operation_id + # For mutating operation requests only. An optional identifier + # specified by the client. Must be unique for operation resources in the + # Operations collection. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -757,8 +817,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def update_policy(project, policy, policy_object = nil, client_operation_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:put, '{project}/policies/{policy}', options) + def update_policy(project, policy, policy_object = nil, client_operation_id: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:put, 'dns/v1/projects/{project}/policies/{policy}', options) command.request_representation = Google::Apis::DnsV1::Policy::Representation command.request_object = policy_object command.response_representation = Google::Apis::DnsV1::PoliciesUpdateResponse::Representation @@ -768,20 +828,21 @@ module Google command.query['clientOperationId'] = client_operation_id unless client_operation_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 - # + # Fetch the representation of an existing Project. # @param [String] project + # Identifies the project addressed by this request. # @param [String] client_operation_id + # For mutating operation requests only. An optional identifier + # specified by the client. Must be unique for operation resources in the + # Operations collection. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -794,32 +855,40 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_project(project, client_operation_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, '{project}', options) + def get_project(project, client_operation_id: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'dns/v1/projects/{project}', options) command.response_representation = Google::Apis::DnsV1::Project::Representation command.response_class = Google::Apis::DnsV1::Project command.params['project'] = project unless project.nil? command.query['clientOperationId'] = client_operation_id unless client_operation_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 - # + # Enumerate ResourceRecordSets that have been created but not yet deleted. # @param [String] project + # Identifies the project addressed by this request. # @param [String] managed_zone + # Identifies the managed zone addressed by this request. Can be the managed + # zone name or id. # @param [Fixnum] max_results + # Optional. Maximum number of results to be returned. If unspecified, the + # server will decide how many results to return. # @param [String] name + # Restricts the list to return only records with this fully qualified domain + # name. # @param [String] page_token + # Optional. A tag returned by a previous list request that was truncated. + # Use this parameter to continue a previous list request. # @param [String] type + # Restricts the list to return only records of this type. If present, the + # "name" parameter must also be present. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -832,8 +901,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_resource_record_sets(project, managed_zone, max_results: nil, name: nil, page_token: nil, type: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, '{project}/managedZones/{managedZone}/rrsets', options) + def list_resource_record_sets(project, managed_zone, max_results: nil, name: nil, page_token: nil, type: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'dns/v1/projects/{project}/managedZones/{managedZone}/rrsets', options) command.response_representation = Google::Apis::DnsV1::ListResourceRecordSetsResponse::Representation command.response_class = Google::Apis::DnsV1::ListResourceRecordSetsResponse command.params['project'] = project unless project.nil? @@ -844,7 +913,6 @@ module Google command.query['type'] = type unless type.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -853,7 +921,6 @@ module Google def apply_command_defaults(command) command.query['key'] = key unless key.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? end end end diff --git a/generated/google/apis/groupsmigration_v1.rb b/generated/google/apis/firebasehosting_v1.rb similarity index 53% rename from generated/google/apis/groupsmigration_v1.rb rename to generated/google/apis/firebasehosting_v1.rb index 97fb8df34..b1e6c4227 100644 --- a/generated/google/apis/groupsmigration_v1.rb +++ b/generated/google/apis/firebasehosting_v1.rb @@ -12,24 +12,22 @@ # See the License for the specific language governing permissions and # limitations under the License. -require 'google/apis/groupsmigration_v1/service.rb' -require 'google/apis/groupsmigration_v1/classes.rb' -require 'google/apis/groupsmigration_v1/representations.rb' +require 'google/apis/firebasehosting_v1/service.rb' +require 'google/apis/firebasehosting_v1/classes.rb' +require 'google/apis/firebasehosting_v1/representations.rb' module Google module Apis - # Groups Migration API + # Firebase Hosting API # - # The Groups Migration API allows domain administrators to archive - # emails into Google groups. + # The Firebase Hosting REST API enables programmatic and customizable + # deployments to your Firebase-hosted sites. Use this REST API to deploy new or + # updated hosting configurations and content files. # - # @see https://developers.google.com/google-apps/groups-migration/ - module GroupsmigrationV1 + # @see https://firebase.google.com/docs/hosting/ + module FirebasehostingV1 VERSION = 'V1' - REVISION = '20200608' - - # Manage messages in groups on your domain - AUTH_APPS_GROUPS_MIGRATION = 'https://www.googleapis.com/auth/apps.groups.migration' + REVISION = '20200629' end end end diff --git a/generated/google/apis/firebasehosting_v1/classes.rb b/generated/google/apis/firebasehosting_v1/classes.rb new file mode 100644 index 000000000..006c9b0c2 --- /dev/null +++ b/generated/google/apis/firebasehosting_v1/classes.rb @@ -0,0 +1,186 @@ +# 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 FirebasehostingV1 + + # The request message for Operations.CancelOperation. + class CancelOperationRequest + include Google::Apis::Core::Hashable + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + end + end + + # A generic empty message that you can re-use to avoid defining duplicated + # empty messages in your APIs. A typical example is to use it as the request + # or the response type of an API method. For instance: + # service Foo ` + # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); + # ` + # The JSON representation for `Empty` is empty JSON object ````. + class Empty + include Google::Apis::Core::Hashable + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + end + end + + # The response message for Operations.ListOperations. + class ListOperationsResponse + include Google::Apis::Core::Hashable + + # The standard List next-page token. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + # A list of operations that matches the specified filter in the request. + # Corresponds to the JSON property `operations` + # @return [Array] + attr_accessor :operations + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + @operations = args[:operations] if args.key?(:operations) + end + end + + # This resource represents a long-running operation that is the result of a + # network API call. + class Operation + include Google::Apis::Core::Hashable + + # If the value is `false`, it means the operation is still in progress. + # If `true`, the operation is completed, and either `error` or `response` is + # available. + # Corresponds to the JSON property `done` + # @return [Boolean] + attr_accessor :done + alias_method :done?, :done + + # The `Status` type defines a logical error model that is suitable for + # different programming environments, including REST APIs and RPC APIs. It is + # used by [gRPC](https://github.com/grpc). Each `Status` message contains + # three pieces of data: error code, error message, and error details. + # You can find out more about this error model and how to work with it in the + # [API Design Guide](https://cloud.google.com/apis/design/errors). + # Corresponds to the JSON property `error` + # @return [Google::Apis::FirebasehostingV1::Status] + attr_accessor :error + + # Service-specific metadata associated with the operation. It typically + # contains progress information and common metadata such as create time. + # Some services might not provide such metadata. Any method that returns a + # long-running operation should document the metadata type, if any. + # Corresponds to the JSON property `metadata` + # @return [Hash] + attr_accessor :metadata + + # The server-assigned name, which is only unique within the same service that + # originally returns it. If you use the default HTTP mapping, the + # `name` should be a resource name ending with `operations/`unique_id``. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # The normal response of the operation in case of success. If the original + # method returns no data on success, such as `Delete`, the response is + # `google.protobuf.Empty`. If the original method is standard + # `Get`/`Create`/`Update`, the response should be the resource. For other + # methods, the response should have the type `XxxResponse`, where `Xxx` + # is the original method name. For example, if the original method name + # is `TakeSnapshot()`, the inferred response type is + # `TakeSnapshotResponse`. + # Corresponds to the JSON property `response` + # @return [Hash] + attr_accessor :response + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @done = args[:done] if args.key?(:done) + @error = args[:error] if args.key?(:error) + @metadata = args[:metadata] if args.key?(:metadata) + @name = args[:name] if args.key?(:name) + @response = args[:response] if args.key?(:response) + end + end + + # The `Status` type defines a logical error model that is suitable for + # different programming environments, including REST APIs and RPC APIs. It is + # used by [gRPC](https://github.com/grpc). Each `Status` message contains + # three pieces of data: error code, error message, and error details. + # You can find out more about this error model and how to work with it in the + # [API Design Guide](https://cloud.google.com/apis/design/errors). + class Status + include Google::Apis::Core::Hashable + + # The status code, which should be an enum value of google.rpc.Code. + # Corresponds to the JSON property `code` + # @return [Fixnum] + attr_accessor :code + + # A list of messages that carry the error details. There is a common set of + # message types for APIs to use. + # Corresponds to the JSON property `details` + # @return [Array>] + attr_accessor :details + + # A developer-facing error message, which should be in English. Any + # user-facing error message should be localized and sent in the + # google.rpc.Status.details field, or localized by the client. + # Corresponds to the JSON property `message` + # @return [String] + attr_accessor :message + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @code = args[:code] if args.key?(:code) + @details = args[:details] if args.key?(:details) + @message = args[:message] if args.key?(:message) + end + end + end + end +end diff --git a/generated/google/apis/androidpublisher_v2/representations.rb b/generated/google/apis/firebasehosting_v1/representations.rb similarity index 55% rename from generated/google/apis/androidpublisher_v2/representations.rb rename to generated/google/apis/firebasehosting_v1/representations.rb index 5e609df90..d84e728c1 100644 --- a/generated/google/apis/androidpublisher_v2/representations.rb +++ b/generated/google/apis/firebasehosting_v1/representations.rb @@ -20,87 +20,77 @@ require 'google/apis/errors' module Google module Apis - module AndroidpublisherV2 + module FirebasehostingV1 - class PageInfo + class CancelOperationRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end - class ProductPurchase + class Empty class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end - class TokenPagination + class ListOperationsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end - class VoidedPurchase + class Operation class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end - class VoidedPurchasesListResponse + class Status class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end - class PageInfo + class CancelOperationRequest # @private class Representation < Google::Apis::Core::JsonRepresentation - property :result_per_page, as: 'resultPerPage' - property :start_index, as: 'startIndex' - property :total_results, as: 'totalResults' end end - class ProductPurchase + class Empty # @private class Representation < Google::Apis::Core::JsonRepresentation - property :consumption_state, as: 'consumptionState' - property :developer_payload, as: 'developerPayload' - property :kind, as: 'kind' - property :order_id, as: 'orderId' - property :purchase_state, as: 'purchaseState' - property :purchase_time_millis, :numeric_string => true, as: 'purchaseTimeMillis' - property :purchase_type, as: 'purchaseType' end end - class TokenPagination + class ListOperationsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :next_page_token, as: 'nextPageToken' - property :previous_page_token, as: 'previousPageToken' + collection :operations, as: 'operations', class: Google::Apis::FirebasehostingV1::Operation, decorator: Google::Apis::FirebasehostingV1::Operation::Representation + end end - class VoidedPurchase + class Operation # @private class Representation < Google::Apis::Core::JsonRepresentation - property :kind, as: 'kind' - property :purchase_time_millis, :numeric_string => true, as: 'purchaseTimeMillis' - property :purchase_token, as: 'purchaseToken' - property :voided_time_millis, :numeric_string => true, as: 'voidedTimeMillis' + property :done, as: 'done' + property :error, as: 'error', class: Google::Apis::FirebasehostingV1::Status, decorator: Google::Apis::FirebasehostingV1::Status::Representation + + hash :metadata, as: 'metadata' + property :name, as: 'name' + hash :response, as: 'response' end end - class VoidedPurchasesListResponse + class Status # @private class Representation < Google::Apis::Core::JsonRepresentation - property :page_info, as: 'pageInfo', class: Google::Apis::AndroidpublisherV2::PageInfo, decorator: Google::Apis::AndroidpublisherV2::PageInfo::Representation - - property :token_pagination, as: 'tokenPagination', class: Google::Apis::AndroidpublisherV2::TokenPagination, decorator: Google::Apis::AndroidpublisherV2::TokenPagination::Representation - - collection :voided_purchases, as: 'voidedPurchases', class: Google::Apis::AndroidpublisherV2::VoidedPurchase, decorator: Google::Apis::AndroidpublisherV2::VoidedPurchase::Representation - + property :code, as: 'code' + collection :details, as: 'details' + property :message, as: 'message' end end end diff --git a/generated/google/apis/firebasehosting_v1/service.rb b/generated/google/apis/firebasehosting_v1/service.rb new file mode 100644 index 000000000..7325193a3 --- /dev/null +++ b/generated/google/apis/firebasehosting_v1/service.rb @@ -0,0 +1,183 @@ +# 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 FirebasehostingV1 + # Firebase Hosting API + # + # The Firebase Hosting REST API enables programmatic and customizable + # deployments to your Firebase-hosted sites. Use this REST API to deploy new or + # updated hosting configurations and content files. + # + # @example + # require 'google/apis/firebasehosting_v1' + # + # Firebasehosting = Google::Apis::FirebasehostingV1 # Alias the module + # service = Firebasehosting::FirebaseHostingService.new + # + # @see https://firebase.google.com/docs/hosting/ + class FirebaseHostingService < Google::Apis::Core::BaseService + # @return [String] + # API key. Your API key identifies your project and provides you with API access, + # quota, and reports. Required unless you provide an OAuth 2.0 token. + attr_accessor :key + + # @return [String] + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + attr_accessor :quota_user + + def initialize + super('https://firebasehosting.googleapis.com/', '') + @batch_path = 'batch' + end + + # Starts asynchronous cancellation on a long-running operation. The server + # makes a best effort to cancel the operation, but success is not + # guaranteed. If the server doesn't support this method, it returns + # `google.rpc.Code.UNIMPLEMENTED`. Clients can use + # Operations.GetOperation or + # other methods to check whether the cancellation succeeded or whether the + # operation completed despite cancellation. On successful cancellation, + # the operation is not deleted; instead, it becomes an operation with + # an Operation.error value with a google.rpc.Status.code of 1, + # corresponding to `Code.CANCELLED`. + # @param [String] name + # The name of the operation resource to be cancelled. + # @param [Google::Apis::FirebasehostingV1::CancelOperationRequest] cancel_operation_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::FirebasehostingV1::Empty] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::FirebasehostingV1::Empty] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def cancel_operation(name, cancel_operation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/{+name}:cancel', options) + command.request_representation = Google::Apis::FirebasehostingV1::CancelOperationRequest::Representation + command.request_object = cancel_operation_request_object + command.response_representation = Google::Apis::FirebasehostingV1::Empty::Representation + command.response_class = Google::Apis::FirebasehostingV1::Empty + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Deletes a long-running operation. This method indicates that the client is + # no longer interested in the operation result. It does not cancel the + # operation. If the server doesn't support this method, it returns + # `google.rpc.Code.UNIMPLEMENTED`. + # @param [String] name + # The name of the operation resource to be deleted. + # @param [String] fields + # 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::FirebasehostingV1::Empty] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::FirebasehostingV1::Empty] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_operation(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v1/{+name}', options) + command.response_representation = Google::Apis::FirebasehostingV1::Empty::Representation + command.response_class = Google::Apis::FirebasehostingV1::Empty + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Lists operations that match the specified filter in the request. If the + # server doesn't support this method, it returns `UNIMPLEMENTED`. + # NOTE: the `name` binding allows API services to override the binding + # to use different resource name schemes, such as `users/*/operations`. To + # override the binding, API services can add a binding such as + # `"/v1/`name=users/*`/operations"` to their service configuration. + # For backwards compatibility, the default name includes the operations + # collection id, however overriding users must ensure the name binding + # is the parent resource, without the operations collection id. + # @param [String] name + # The name of the operation's parent resource. + # @param [String] filter + # The standard list filter. + # @param [Fixnum] page_size + # The standard list page size. + # @param [String] page_token + # The standard list page token. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::FirebasehostingV1::ListOperationsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::FirebasehostingV1::ListOperationsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+name}', options) + command.response_representation = Google::Apis::FirebasehostingV1::ListOperationsResponse::Representation + command.response_class = Google::Apis::FirebasehostingV1::ListOperationsResponse + command.params['name'] = name unless name.nil? + command.query['filter'] = filter unless filter.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + protected + + def apply_command_defaults(command) + command.query['key'] = key unless key.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + end + end + end + end +end diff --git a/generated/google/apis/groupsmigration_v1/classes.rb b/generated/google/apis/groupsmigration_v1/classes.rb deleted file mode 100644 index 2841ab3cf..000000000 --- a/generated/google/apis/groupsmigration_v1/classes.rb +++ /dev/null @@ -1,51 +0,0 @@ -# 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 GroupsmigrationV1 - - # JSON response template for groups migration API. - class Groups - include Google::Apis::Core::Hashable - - # The kind of insert resource this is. - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - # The status of the insert request. - # Corresponds to the JSON property `responseCode` - # @return [String] - attr_accessor :response_code - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @kind = args[:kind] if args.key?(:kind) - @response_code = args[:response_code] if args.key?(:response_code) - end - end - end - end -end diff --git a/generated/google/apis/groupsmigration_v1/representations.rb b/generated/google/apis/groupsmigration_v1/representations.rb deleted file mode 100644 index c05350d6d..000000000 --- a/generated/google/apis/groupsmigration_v1/representations.rb +++ /dev/null @@ -1,40 +0,0 @@ -# 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 GroupsmigrationV1 - - class Groups - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class Groups - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :kind, as: 'kind' - property :response_code, as: 'responseCode' - end - end - end - end -end diff --git a/generated/google/apis/groupsmigration_v1/service.rb b/generated/google/apis/groupsmigration_v1/service.rb deleted file mode 100644 index 889d5514a..000000000 --- a/generated/google/apis/groupsmigration_v1/service.rb +++ /dev/null @@ -1,100 +0,0 @@ -# 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 GroupsmigrationV1 - # Groups Migration API - # - # The Groups Migration API allows domain administrators to archive - # emails into Google groups. - # - # @example - # require 'google/apis/groupsmigration_v1' - # - # Groupsmigration = Google::Apis::GroupsmigrationV1 # Alias the module - # service = Groupsmigration::GroupsMigrationService.new - # - # @see https://developers.google.com/google-apps/groups-migration/ - class GroupsMigrationService < Google::Apis::Core::BaseService - # @return [String] - # API key. Your API key identifies your project and provides you with API access, - # quota, and reports. Required unless you provide an OAuth 2.0 token. - attr_accessor :key - - # @return [String] - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - attr_accessor :quota_user - - def initialize - super('https://www.googleapis.com/', '') - @batch_path = 'batch/groupsmigration/v1' - end - - # Inserts a new mail into the archive of the Google group. - # @param [String] group_id - # The group ID - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [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::GroupsmigrationV1::Groups] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::GroupsmigrationV1::Groups] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_archive(group_id, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil, &block) - if upload_source.nil? - command = make_simple_command(:post, 'groups/v1/groups/{groupId}/archive', options) - else - command = make_upload_command(:post, 'groups/v1/groups/{groupId}/archive', options) - command.upload_source = upload_source - command.upload_content_type = content_type - end - command.response_representation = Google::Apis::GroupsmigrationV1::Groups::Representation - command.response_class = Google::Apis::GroupsmigrationV1::Groups - command.params['groupId'] = group_id unless group_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - protected - - def apply_command_defaults(command) - command.query['key'] = key unless key.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - end - end - end - end -end diff --git a/generated/google/apis/groupssettings_v1.rb b/generated/google/apis/groupssettings_v1.rb index 6c54814c4..748568a6f 100644 --- a/generated/google/apis/groupssettings_v1.rb +++ b/generated/google/apis/groupssettings_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/google-apps/groups-settings/get_started module GroupssettingsV1 VERSION = 'V1' - REVISION = '20190725' + REVISION = '20200617' # View and manage the settings of a G Suite group AUTH_APPS_GROUPS_SETTINGS = 'https://www.googleapis.com/auth/apps.groups.settings' diff --git a/generated/google/apis/groupssettings_v1/classes.rb b/generated/google/apis/groupssettings_v1/classes.rb index 0fa265c9d..0ffd83a60 100644 --- a/generated/google/apis/groupssettings_v1/classes.rb +++ b/generated/google/apis/groupssettings_v1/classes.rb @@ -213,7 +213,7 @@ module Google # @return [String] attr_accessor :primary_language - # Specifies who should the default reply go to. Possible values are: + # Specifies who receives the default reply. Possible values are: # - REPLY_TO_CUSTOM: For replies to messages, use the group's custom email # address. # When the group's ReplyTo property is set to REPLY_TO_CUSTOM, the customReplyTo diff --git a/generated/google/apis/ml_v1.rb b/generated/google/apis/ml_v1.rb index 92627e8c8..bca2e2918 100644 --- a/generated/google/apis/ml_v1.rb +++ b/generated/google/apis/ml_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/ml/ module MlV1 VERSION = 'V1' - REVISION = '20200630' + REVISION = '20200703' # 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/ml_v1/classes.rb b/generated/google/apis/ml_v1/classes.rb index 33d34c409..e2f231850 100644 --- a/generated/google/apis/ml_v1/classes.rb +++ b/generated/google/apis/ml_v1/classes.rb @@ -3101,7 +3101,7 @@ module Google # ` # "audit_configs": [ # ` - # "service": "allServices" + # "service": "allServices", # "audit_log_configs": [ # ` # "log_type": "DATA_READ", @@ -3110,18 +3110,18 @@ module Google # ] # `, # ` - # "log_type": "DATA_WRITE", + # "log_type": "DATA_WRITE" # `, # ` - # "log_type": "ADMIN_READ", + # "log_type": "ADMIN_READ" # ` # ] # `, # ` - # "service": "sampleservice.googleapis.com" + # "service": "sampleservice.googleapis.com", # "audit_log_configs": [ # ` - # "log_type": "DATA_READ", + # "log_type": "DATA_READ" # `, # ` # "log_type": "DATA_WRITE", @@ -3173,7 +3173,7 @@ module Google # ] # `, # ` - # "log_type": "DATA_WRITE", + # "log_type": "DATA_WRITE" # ` # ] # ` diff --git a/generated/google/apis/youtube_v3.rb b/generated/google/apis/youtube_v3.rb index 02abc7cf6..fa5608094 100644 --- a/generated/google/apis/youtube_v3.rb +++ b/generated/google/apis/youtube_v3.rb @@ -26,7 +26,7 @@ module Google # @see https://developers.google.com/youtube/ module YoutubeV3 VERSION = 'V3' - REVISION = '20200706' + REVISION = '20200707' # Manage your YouTube account AUTH_YOUTUBE = 'https://www.googleapis.com/auth/youtube' diff --git a/generated/google/apis/youtube_v3/service.rb b/generated/google/apis/youtube_v3/service.rb index d459bafda..a6334f59b 100644 --- a/generated/google/apis/youtube_v3/service.rb +++ b/generated/google/apis/youtube_v3/service.rb @@ -3456,7 +3456,6 @@ module Google # Type of the link to be deleted. # @param [Array, String] part # Do not use. Required for compatibility. - # @param [String] resource_id # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -3474,11 +3473,10 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def delete_third_party_link(linking_token, type, part: nil, resource_id: nil, fields: nil, quota_user: nil, options: nil, &block) + def delete_third_party_link(linking_token, type, part: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'youtube/v3/thirdPartyLinks', options) command.query['linkingToken'] = linking_token unless linking_token.nil? command.query['part'] = part unless part.nil? - command.query['resourceId'] = resource_id unless resource_id.nil? command.query['type'] = type unless type.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil?