google-api-client 0.9.1 → 0.9.2

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

@@ -0,0 +1,478 @@
+# 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 AppengineV1beta5
+      # Google App Engine Admin API
+      #
+      # The Google App Engine Admin API enables developers to provision and manage
+      #  their App Engine applications.
+      #
+      # @example
+      #    require 'google/apis/appengine_v1beta5'
+      #
+      #    Appengine = Google::Apis::AppengineV1beta5 # Alias the module
+      #    service = Appengine::AppengineService.new
+      #
+      # @see https://cloud.google.com/appengine/docs/admin-api/
+      class AppengineService < 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://appengine.googleapis.com/', '')
+        end
+        
+        # Gets information about an application.
+        # @param [String] apps_id
+        #   Part of `name`. Name of the application to get. For example: "apps/myapp".
+        # @param [Boolean] ensure_resources_exist
+        #   Certain resources associated with an application are created on-demand.
+        #   Controls whether these resources should be created when performing the `GET`
+        #   operation. If specified and any resources could not be created, the request
+        #   will fail with an error code. Additionally, this parameter can cause the
+        #   request to take longer to complete. Note: This parameter will be deprecated in
+        #   a future version of the API.
+        # @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::AppengineV1beta5::Application] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::AppengineV1beta5::Application]
+        #
+        # @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_app(apps_id, ensure_resources_exist: nil, fields: nil, quota_user: nil, options: nil, &block)
+          command =  make_simple_command(:get, 'v1beta5/apps/{appsId}', options)
+          command.response_representation = Google::Apis::AppengineV1beta5::Application::Representation
+          command.response_class = Google::Apis::AppengineV1beta5::Application
+          command.params['appsId'] = apps_id unless apps_id.nil?
+          command.query['ensureResourcesExist'] = ensure_resources_exist unless ensure_resources_exist.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
+        # Gets the latest state of a long-running operation. Clients can use this method
+        # to poll the operation result at intervals as recommended by the API service.
+        # @param [String] apps_id
+        #   Part of `name`. The name of the operation resource.
+        # @param [String] operations_id
+        #   Part of `name`. See documentation of `appsId`.
+        # @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::AppengineV1beta5::Operation] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::AppengineV1beta5::Operation]
+        #
+        # @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_app_operation(apps_id, operations_id, fields: nil, quota_user: nil, options: nil, &block)
+          command =  make_simple_command(:get, 'v1beta5/apps/{appsId}/operations/{operationsId}', options)
+          command.response_representation = Google::Apis::AppengineV1beta5::Operation::Representation
+          command.response_class = Google::Apis::AppengineV1beta5::Operation
+          command.params['appsId'] = apps_id unless apps_id.nil?
+          command.params['operationsId'] = operations_id unless operations_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
+        
+        # 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 below allows API services to override the binding to use different
+        # resource name schemes, such as `users/*/operations`.
+        # @param [String] apps_id
+        #   Part of `name`. The name of the operation collection.
+        # @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::AppengineV1beta5::ListOperationsResponse] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::AppengineV1beta5::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_app_operations(apps_id, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
+          command =  make_simple_command(:get, 'v1beta5/apps/{appsId}/operations', options)
+          command.response_representation = Google::Apis::AppengineV1beta5::ListOperationsResponse::Representation
+          command.response_class = Google::Apis::AppengineV1beta5::ListOperationsResponse
+          command.params['appsId'] = apps_id unless apps_id.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
+        
+        # Deletes a service and all enclosed versions.
+        # @param [String] apps_id
+        #   Part of `name`. Name of the resource requested. For example: "apps/myapp/
+        #   services/default".
+        # @param [String] services_id
+        #   Part of `name`. See documentation of `appsId`.
+        # @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::AppengineV1beta5::Operation] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::AppengineV1beta5::Operation]
+        #
+        # @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_app_service(apps_id, services_id, fields: nil, quota_user: nil, options: nil, &block)
+          command =  make_simple_command(:delete, 'v1beta5/apps/{appsId}/services/{servicesId}', options)
+          command.response_representation = Google::Apis::AppengineV1beta5::Operation::Representation
+          command.response_class = Google::Apis::AppengineV1beta5::Operation
+          command.params['appsId'] = apps_id unless apps_id.nil?
+          command.params['servicesId'] = services_id unless services_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
+        
+        # Gets the current configuration of the service.
+        # @param [String] apps_id
+        #   Part of `name`. Name of the resource requested. For example: "apps/myapp/
+        #   services/default".
+        # @param [String] services_id
+        #   Part of `name`. See documentation of `appsId`.
+        # @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::AppengineV1beta5::Service] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::AppengineV1beta5::Service]
+        #
+        # @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_app_service(apps_id, services_id, fields: nil, quota_user: nil, options: nil, &block)
+          command =  make_simple_command(:get, 'v1beta5/apps/{appsId}/services/{servicesId}', options)
+          command.response_representation = Google::Apis::AppengineV1beta5::Service::Representation
+          command.response_class = Google::Apis::AppengineV1beta5::Service
+          command.params['appsId'] = apps_id unless apps_id.nil?
+          command.params['servicesId'] = services_id unless services_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
+        
+        # Lists all the services in the application.
+        # @param [String] apps_id
+        #   Part of `name`. Name of the resource requested. For example: "apps/myapp".
+        # @param [Fixnum] page_size
+        #   Maximum results to return per page.
+        # @param [String] page_token
+        #   Continuation token for fetching the next page of results.
+        # @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::AppengineV1beta5::ListServicesResponse] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::AppengineV1beta5::ListServicesResponse]
+        #
+        # @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_app_services(apps_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
+          command =  make_simple_command(:get, 'v1beta5/apps/{appsId}/services', options)
+          command.response_representation = Google::Apis::AppengineV1beta5::ListServicesResponse::Representation
+          command.response_class = Google::Apis::AppengineV1beta5::ListServicesResponse
+          command.params['appsId'] = apps_id unless apps_id.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
+        
+        # Updates the configuration of the specified service.
+        # @param [String] apps_id
+        #   Part of `name`. Name of the resource to update. For example: "apps/myapp/
+        #   services/default".
+        # @param [String] services_id
+        #   Part of `name`. See documentation of `appsId`.
+        # @param [Google::Apis::AppengineV1beta5::Service] service_object
+        # @param [String] mask
+        #   Standard field mask for the set of fields to be updated.
+        # @param [Boolean] migrate_traffic
+        #   Whether to use Traffic Migration to shift traffic gradually. Traffic can only
+        #   be migrated from a single version to another single version.
+        # @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::AppengineV1beta5::Operation] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::AppengineV1beta5::Operation]
+        #
+        # @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_app_service(apps_id, services_id, service_object = nil, mask: nil, migrate_traffic: nil, fields: nil, quota_user: nil, options: nil, &block)
+          command =  make_simple_command(:patch, 'v1beta5/apps/{appsId}/services/{servicesId}', options)
+          command.request_representation = Google::Apis::AppengineV1beta5::Service::Representation
+          command.request_object = service_object
+          command.response_representation = Google::Apis::AppengineV1beta5::Operation::Representation
+          command.response_class = Google::Apis::AppengineV1beta5::Operation
+          command.params['appsId'] = apps_id unless apps_id.nil?
+          command.params['servicesId'] = services_id unless services_id.nil?
+          command.query['mask'] = mask unless mask.nil?
+          command.query['migrateTraffic'] = migrate_traffic unless migrate_traffic.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
+        # Deploys new code and resource files to a version.
+        # @param [String] apps_id
+        #   Part of `name`. Name of the resource to update. For example: "apps/myapp/
+        #   services/default".
+        # @param [String] services_id
+        #   Part of `name`. See documentation of `appsId`.
+        # @param [Google::Apis::AppengineV1beta5::Version] version_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::AppengineV1beta5::Operation] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::AppengineV1beta5::Operation]
+        #
+        # @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_app_service_version(apps_id, services_id, version_object = nil, fields: nil, quota_user: nil, options: nil, &block)
+          command =  make_simple_command(:post, 'v1beta5/apps/{appsId}/services/{servicesId}/versions', options)
+          command.request_representation = Google::Apis::AppengineV1beta5::Version::Representation
+          command.request_object = version_object
+          command.response_representation = Google::Apis::AppengineV1beta5::Operation::Representation
+          command.response_class = Google::Apis::AppengineV1beta5::Operation
+          command.params['appsId'] = apps_id unless apps_id.nil?
+          command.params['servicesId'] = services_id unless services_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
+        
+        # Deletes an existing version.
+        # @param [String] apps_id
+        #   Part of `name`. Name of the resource requested. For example: "apps/myapp/
+        #   services/default/versions/v1".
+        # @param [String] services_id
+        #   Part of `name`. See documentation of `appsId`.
+        # @param [String] versions_id
+        #   Part of `name`. See documentation of `appsId`.
+        # @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::AppengineV1beta5::Operation] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::AppengineV1beta5::Operation]
+        #
+        # @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_app_service_version(apps_id, services_id, versions_id, fields: nil, quota_user: nil, options: nil, &block)
+          command =  make_simple_command(:delete, 'v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}', options)
+          command.response_representation = Google::Apis::AppengineV1beta5::Operation::Representation
+          command.response_class = Google::Apis::AppengineV1beta5::Operation
+          command.params['appsId'] = apps_id unless apps_id.nil?
+          command.params['servicesId'] = services_id unless services_id.nil?
+          command.params['versionsId'] = versions_id unless versions_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
+        
+        # Gets application deployment information.
+        # @param [String] apps_id
+        #   Part of `name`. Name of the resource requested. For example: "apps/myapp/
+        #   services/default/versions/v1".
+        # @param [String] services_id
+        #   Part of `name`. See documentation of `appsId`.
+        # @param [String] versions_id
+        #   Part of `name`. See documentation of `appsId`.
+        # @param [String] view
+        #   Controls the set of fields returned in the `Get` response.
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   Available to use for quota purposes for server-side applications. Can be any
+        #   arbitrary string assigned to a user, but should not exceed 40 characters.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::AppengineV1beta5::Version] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::AppengineV1beta5::Version]
+        #
+        # @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_app_service_version(apps_id, services_id, versions_id, view: nil, fields: nil, quota_user: nil, options: nil, &block)
+          command =  make_simple_command(:get, 'v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}', options)
+          command.response_representation = Google::Apis::AppengineV1beta5::Version::Representation
+          command.response_class = Google::Apis::AppengineV1beta5::Version
+          command.params['appsId'] = apps_id unless apps_id.nil?
+          command.params['servicesId'] = services_id unless services_id.nil?
+          command.params['versionsId'] = versions_id unless versions_id.nil?
+          command.query['view'] = view unless view.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 the versions of a service.
+        # @param [String] apps_id
+        #   Part of `name`. Name of the resource requested. For example: "apps/myapp/
+        #   services/default".
+        # @param [String] services_id
+        #   Part of `name`. See documentation of `appsId`.
+        # @param [String] view
+        #   Controls the set of fields returned in the `List` response.
+        # @param [Fixnum] page_size
+        #   Maximum results to return per page.
+        # @param [String] page_token
+        #   Continuation token for fetching the next page of results.
+        # @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::AppengineV1beta5::ListVersionsResponse] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::AppengineV1beta5::ListVersionsResponse]
+        #
+        # @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_app_service_versions(apps_id, services_id, view: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
+          command =  make_simple_command(:get, 'v1beta5/apps/{appsId}/services/{servicesId}/versions', options)
+          command.response_representation = Google::Apis::AppengineV1beta5::ListVersionsResponse::Representation
+          command.response_class = Google::Apis::AppengineV1beta5::ListVersionsResponse
+          command.params['appsId'] = apps_id unless apps_id.nil?
+          command.params['servicesId'] = services_id unless services_id.nil?
+          command.query['view'] = view unless view.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