google-api-client 0.39.4 → 0.41.0

data/generated/google/apis/recommender_v1/representations.rb

@@ -0,0 +1,232 @@
+# 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 RecommenderV1
+      
+      class GoogleCloudRecommenderV1CostProjection
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleCloudRecommenderV1Impact
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleCloudRecommenderV1ListRecommendationsResponse
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleCloudRecommenderV1MarkRecommendationClaimedRequest
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleCloudRecommenderV1MarkRecommendationFailedRequest
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleCloudRecommenderV1MarkRecommendationSucceededRequest
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleCloudRecommenderV1Operation
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleCloudRecommenderV1OperationGroup
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleCloudRecommenderV1Recommendation
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleCloudRecommenderV1RecommendationContent
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleCloudRecommenderV1RecommendationStateInfo
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleCloudRecommenderV1ValueMatcher
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleTypeMoney
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleCloudRecommenderV1CostProjection
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :cost, as: 'cost', class: Google::Apis::RecommenderV1::GoogleTypeMoney, decorator: Google::Apis::RecommenderV1::GoogleTypeMoney::Representation
+      
+          property :duration, as: 'duration'
+        end
+      end
+      
+      class GoogleCloudRecommenderV1Impact
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :category, as: 'category'
+          property :cost_projection, as: 'costProjection', class: Google::Apis::RecommenderV1::GoogleCloudRecommenderV1CostProjection, decorator: Google::Apis::RecommenderV1::GoogleCloudRecommenderV1CostProjection::Representation
+      
+        end
+      end
+      
+      class GoogleCloudRecommenderV1ListRecommendationsResponse
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :next_page_token, as: 'nextPageToken'
+          collection :recommendations, as: 'recommendations', class: Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation, decorator: Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation::Representation
+      
+        end
+      end
+      
+      class GoogleCloudRecommenderV1MarkRecommendationClaimedRequest
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :etag, as: 'etag'
+          hash :state_metadata, as: 'stateMetadata'
+        end
+      end
+      
+      class GoogleCloudRecommenderV1MarkRecommendationFailedRequest
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :etag, as: 'etag'
+          hash :state_metadata, as: 'stateMetadata'
+        end
+      end
+      
+      class GoogleCloudRecommenderV1MarkRecommendationSucceededRequest
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :etag, as: 'etag'
+          hash :state_metadata, as: 'stateMetadata'
+        end
+      end
+      
+      class GoogleCloudRecommenderV1Operation
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :action, as: 'action'
+          property :path, as: 'path'
+          hash :path_filters, as: 'pathFilters'
+          hash :path_value_matchers, as: 'pathValueMatchers', class: Google::Apis::RecommenderV1::GoogleCloudRecommenderV1ValueMatcher, decorator: Google::Apis::RecommenderV1::GoogleCloudRecommenderV1ValueMatcher::Representation
+      
+          property :resource, as: 'resource'
+          property :resource_type, as: 'resourceType'
+          property :source_path, as: 'sourcePath'
+          property :source_resource, as: 'sourceResource'
+          property :value, as: 'value'
+          property :value_matcher, as: 'valueMatcher', class: Google::Apis::RecommenderV1::GoogleCloudRecommenderV1ValueMatcher, decorator: Google::Apis::RecommenderV1::GoogleCloudRecommenderV1ValueMatcher::Representation
+      
+        end
+      end
+      
+      class GoogleCloudRecommenderV1OperationGroup
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          collection :operations, as: 'operations', class: Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Operation, decorator: Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Operation::Representation
+      
+        end
+      end
+      
+      class GoogleCloudRecommenderV1Recommendation
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          collection :additional_impact, as: 'additionalImpact', class: Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Impact, decorator: Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Impact::Representation
+      
+          property :content, as: 'content', class: Google::Apis::RecommenderV1::GoogleCloudRecommenderV1RecommendationContent, decorator: Google::Apis::RecommenderV1::GoogleCloudRecommenderV1RecommendationContent::Representation
+      
+          property :description, as: 'description'
+          property :etag, as: 'etag'
+          property :last_refresh_time, as: 'lastRefreshTime'
+          property :name, as: 'name'
+          property :primary_impact, as: 'primaryImpact', class: Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Impact, decorator: Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Impact::Representation
+      
+          property :recommender_subtype, as: 'recommenderSubtype'
+          property :state_info, as: 'stateInfo', class: Google::Apis::RecommenderV1::GoogleCloudRecommenderV1RecommendationStateInfo, decorator: Google::Apis::RecommenderV1::GoogleCloudRecommenderV1RecommendationStateInfo::Representation
+      
+        end
+      end
+      
+      class GoogleCloudRecommenderV1RecommendationContent
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          collection :operation_groups, as: 'operationGroups', class: Google::Apis::RecommenderV1::GoogleCloudRecommenderV1OperationGroup, decorator: Google::Apis::RecommenderV1::GoogleCloudRecommenderV1OperationGroup::Representation
+      
+        end
+      end
+      
+      class GoogleCloudRecommenderV1RecommendationStateInfo
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :state, as: 'state'
+          hash :state_metadata, as: 'stateMetadata'
+        end
+      end
+      
+      class GoogleCloudRecommenderV1ValueMatcher
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :matches_pattern, as: 'matchesPattern'
+        end
+      end
+      
+      class GoogleTypeMoney
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :currency_code, as: 'currencyCode'
+          property :nanos, as: 'nanos'
+          property :units, :numeric_string => true, as: 'units'
+        end
+      end
+    end
+  end
+end

data/generated/google/apis/recommender_v1/service.rb

@@ -0,0 +1,266 @@
+# 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 RecommenderV1
+      # Recommender API
+      #
+      # 
+      #
+      # @example
+      #    require 'google/apis/recommender_v1'
+      #
+      #    Recommender = Google::Apis::RecommenderV1 # Alias the module
+      #    service = Recommender::RecommenderService.new
+      #
+      # @see https://cloud.google.com/recommender/docs/
+      class RecommenderService < 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://recommender.googleapis.com/', '')
+          @batch_path = 'batch'
+        end
+        
+        # Gets the requested recommendation. Requires the recommender.*.get
+        # IAM permission for the specified recommender.
+        # @param [String] name
+        #   Required. Name of the recommendation.
+        # @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::RecommenderV1::GoogleCloudRecommenderV1Recommendation] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def get_project_location_recommender_recommendation(name, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:get, 'v1/{+name}', options)
+          command.response_representation = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation::Representation
+          command.response_class = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation
+          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 recommendations for a Cloud project. Requires the recommender.*.list
+        # IAM permission for the specified recommender.
+        # @param [String] parent
+        #   Required. The container resource on which to execute the request.
+        #   Acceptable formats:
+        #   1.
+        #   "projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]",
+        #   LOCATION here refers to GCP Locations:
+        #   https://cloud.google.com/about/locations/
+        # @param [String] filter
+        #   Filter expression to restrict the recommendations returned. Supported
+        #   filter fields: state_info.state
+        #   Eg: `state_info.state:"DISMISSED" or state_info.state:"FAILED"
+        # @param [Fixnum] page_size
+        #   Optional. The maximum number of results to return from this request.  Non-
+        #   positive
+        #   values are ignored. If not specified, the server will determine the number
+        #   of results to return.
+        # @param [String] page_token
+        #   Optional. If present, retrieves the next batch of results from the preceding
+        #   call to
+        #   this method. `page_token` must be the value of `next_page_token` from the
+        #   previous response. The values of other method parameters must be identical
+        #   to those in the previous call.
+        # @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::RecommenderV1::GoogleCloudRecommenderV1ListRecommendationsResponse] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::RecommenderV1::GoogleCloudRecommenderV1ListRecommendationsResponse]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def list_project_location_recommender_recommendations(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:get, 'v1/{+parent}/recommendations', options)
+          command.response_representation = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1ListRecommendationsResponse::Representation
+          command.response_class = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1ListRecommendationsResponse
+          command.params['parent'] = parent unless parent.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
+        
+        # Marks the Recommendation State as Claimed. Users can use this method to
+        # indicate to the Recommender API that they are starting to apply the
+        # recommendation themselves. This stops the recommendation content from being
+        # updated. Associated insights are frozen and placed in the ACCEPTED state.
+        # MarkRecommendationClaimed can be applied to recommendations in CLAIMED,
+        # SUCCEEDED, FAILED, or ACTIVE state.
+        # Requires the recommender.*.update IAM permission for the specified
+        # recommender.
+        # @param [String] name
+        #   Required. Name of the recommendation.
+        # @param [Google::Apis::RecommenderV1::GoogleCloudRecommenderV1MarkRecommendationClaimedRequest] google_cloud_recommender_v1_mark_recommendation_claimed_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::RecommenderV1::GoogleCloudRecommenderV1Recommendation] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def mark_project_location_recommender_recommendation_claimed(name, google_cloud_recommender_v1_mark_recommendation_claimed_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:post, 'v1/{+name}:markClaimed', options)
+          command.request_representation = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1MarkRecommendationClaimedRequest::Representation
+          command.request_object = google_cloud_recommender_v1_mark_recommendation_claimed_request_object
+          command.response_representation = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation::Representation
+          command.response_class = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation
+          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
+        
+        # Marks the Recommendation State as Failed. Users can use this method to
+        # indicate to the Recommender API that they have applied the recommendation
+        # themselves, and the operation failed. This stops the recommendation content
+        # from being updated. Associated insights are frozen and placed in the
+        # ACCEPTED state.
+        # MarkRecommendationFailed can be applied to recommendations in ACTIVE,
+        # CLAIMED, SUCCEEDED, or FAILED state.
+        # Requires the recommender.*.update IAM permission for the specified
+        # recommender.
+        # @param [String] name
+        #   Required. Name of the recommendation.
+        # @param [Google::Apis::RecommenderV1::GoogleCloudRecommenderV1MarkRecommendationFailedRequest] google_cloud_recommender_v1_mark_recommendation_failed_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::RecommenderV1::GoogleCloudRecommenderV1Recommendation] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def mark_project_location_recommender_recommendation_failed(name, google_cloud_recommender_v1_mark_recommendation_failed_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:post, 'v1/{+name}:markFailed', options)
+          command.request_representation = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1MarkRecommendationFailedRequest::Representation
+          command.request_object = google_cloud_recommender_v1_mark_recommendation_failed_request_object
+          command.response_representation = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation::Representation
+          command.response_class = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation
+          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
+        
+        # Marks the Recommendation State as Succeeded. Users can use this method to
+        # indicate to the Recommender API that they have applied the recommendation
+        # themselves, and the operation was successful. This stops the recommendation
+        # content from being updated. Associated insights are frozen and placed in
+        # the ACCEPTED state.
+        # MarkRecommendationSucceeded can be applied to recommendations in ACTIVE,
+        # CLAIMED, SUCCEEDED, or FAILED state.
+        # Requires the recommender.*.update IAM permission for the specified
+        # recommender.
+        # @param [String] name
+        #   Required. Name of the recommendation.
+        # @param [Google::Apis::RecommenderV1::GoogleCloudRecommenderV1MarkRecommendationSucceededRequest] google_cloud_recommender_v1_mark_recommendation_succeeded_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::RecommenderV1::GoogleCloudRecommenderV1Recommendation] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def mark_project_location_recommender_recommendation_succeeded(name, google_cloud_recommender_v1_mark_recommendation_succeeded_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:post, 'v1/{+name}:markSucceeded', options)
+          command.request_representation = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1MarkRecommendationSucceededRequest::Representation
+          command.request_object = google_cloud_recommender_v1_mark_recommendation_succeeded_request_object
+          command.response_representation = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation::Representation
+          command.response_class = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation
+          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
+
+        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