service.rb in google-api-client-0.9.1

- old
+ new

@@ -50,11 +50,11 @@
 
         def initialize
           super('https://www.googleapis.com/', 'compute/beta/projects/')
         end
         
-        # Retrieves the list of addresses grouped by scope.
+        # Retrieves an aggregated list of addresses.
         # @param [String] project
         #   Project ID for this request.
         # @param [String] filter
         #   Sets a filter expression for filtering listed resources, in the form filter=`
         #   expression`. Your `expression` must be in the format: field_name
@@ -252,11 +252,11 @@
           command.query['quotaUser'] = quota_user unless quota_user.nil?
           command.query['userIp'] = user_ip unless user_ip.nil?
           execute_or_queue_command(command, &block)
         end
         
-        # Retrieves the list of address resources contained within the specified region.
+        # Retrieves a list of address resources contained within the specified region.
         # @param [String] project
         #   Project ID for this request.
         # @param [String] region
         #   The name of the region for this request.
         # @param [String] filter
@@ -333,11 +333,11 @@
           command.query['quotaUser'] = quota_user unless quota_user.nil?
           command.query['userIp'] = user_ip unless user_ip.nil?
           execute_or_queue_command(command, &block)
         end
         
-        # Retrieves the list of autoscalers grouped by scope.
+        # Retrieves an aggregated list of autoscalers.
         # @param [String] project
         #   Project ID for this request.
         # @param [String] filter
         #   Sets a filter expression for filtering listed resources, in the form filter=`
         #   expression`. Your `expression` must be in the format: field_name
@@ -535,11 +535,11 @@
           command.query['quotaUser'] = quota_user unless quota_user.nil?
           command.query['userIp'] = user_ip unless user_ip.nil?
           execute_or_queue_command(command, &block)
         end
         
-        # Retrieves the list of autoscaler resources contained within the specified zone.
+        # Retrieves a list of autoscaler resources contained within the specified zone.
         # @param [String] project
         #   Project ID for this request.
         # @param [String] zone
         #   Name of the zone scoping this request.
         # @param [String] filter
@@ -823,11 +823,13 @@
           command.query['userIp'] = user_ip unless user_ip.nil?
           execute_or_queue_command(command, &block)
         end
         
         # Creates a BackendService resource in the specified project using the data
-        # included in the request.
+        # included in the request. There are several restrictions and guidelines to keep
+        # in mind when creating a backend service. Read  Restrictions and Guidelines for
+        # more information.
         # @param [String] project
         #   Project ID for this request.
         # @param [Google::Apis::ComputeBeta::BackendService] backend_service_object
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
@@ -940,11 +942,13 @@
           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 the entire content of the BackendService resource. This method supports
+        # Updates the entire content of the BackendService resource. There are several
+        # restrictions and guidelines to keep in mind when updating a backend service.
+        # Read  Restrictions and Guidelines for more information. This method supports
         # patch semantics.
         # @param [String] project
         #   Project ID for this request.
         # @param [String] backend_service
         #   Name of the BackendService resource to update.
@@ -982,11 +986,13 @@
           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 the entire content of the BackendService resource.
+        # Updates the entire content of the BackendService resource. There are several
+        # restrictions and guidelines to keep in mind when updating a backend service.
+        # Read  Restrictions and Guidelines for more information.
         # @param [String] project
         #   Project ID for this request.
         # @param [String] backend_service
         #   Name of the BackendService resource to update.
         # @param [Google::Apis::ComputeBeta::BackendService] backend_service_object
@@ -1023,11 +1029,11 @@
           command.query['quotaUser'] = quota_user unless quota_user.nil?
           command.query['userIp'] = user_ip unless user_ip.nil?
           execute_or_queue_command(command, &block)
         end
         
-        # Retrieves the list of disk type resources grouped by scope.
+        # Retrieves an aggregated list of disk type resources.
         # @param [String] project
         #   Project ID for this request.
         # @param [String] filter
         #   Sets a filter expression for filtering listed resources, in the form filter=`
         #   expression`. Your `expression` must be in the format: field_name
@@ -1142,11 +1148,11 @@
           command.query['quotaUser'] = quota_user unless quota_user.nil?
           command.query['userIp'] = user_ip unless user_ip.nil?
           execute_or_queue_command(command, &block)
         end
         
-        # Retrieves the list of disk type resources available to the specified project.
+        # Retrieves a list of disk type resources available to the specified project.
         # @param [String] project
         #   Project ID for this request.
         # @param [String] zone
         #   The name of the zone for this request.
         # @param [String] filter
@@ -1223,11 +1229,11 @@
           command.query['quotaUser'] = quota_user unless quota_user.nil?
           command.query['userIp'] = user_ip unless user_ip.nil?
           execute_or_queue_command(command, &block)
         end
         
-        # Retrieves the list of persistent disks grouped by scope.
+        # Retrieves an aggregated list of persistent disks.
         # @param [String] project
         #   Project ID for this request.
         # @param [String] filter
         #   Sets a filter expression for filtering listed resources, in the form filter=`
         #   expression`. Your `expression` must be in the format: field_name
@@ -1474,11 +1480,11 @@
           command.query['quotaUser'] = quota_user unless quota_user.nil?
           command.query['userIp'] = user_ip unless user_ip.nil?
           execute_or_queue_command(command, &block)
         end
         
-        # Retrieves the list of persistent disks contained within the specified zone.
+        # Retrieves a list of persistent disks contained within the specified zone.
         # @param [String] project
         #   Project ID for this request.
         # @param [String] zone
         #   The name of the zone for this request.
         # @param [String] filter
@@ -1875,11 +1881,11 @@
           command.query['quotaUser'] = quota_user unless quota_user.nil?
           command.query['userIp'] = user_ip unless user_ip.nil?
           execute_or_queue_command(command, &block)
         end
         
-        # Retrieves the list of forwarding rules grouped by scope.
+        # Retrieves an aggregated list of forwarding rules.
         # @param [String] project
         #   Project ID for this request.
         # @param [String] filter
         #   Sets a filter expression for filtering listed resources, in the form filter=`
         #   expression`. Your `expression` must be in the format: field_name
@@ -2077,11 +2083,11 @@
           command.query['quotaUser'] = quota_user unless quota_user.nil?
           command.query['userIp'] = user_ip unless user_ip.nil?
           execute_or_queue_command(command, &block)
         end
         
-        # Retrieves the list of ForwardingRule resources available to the specified
+        # Retrieves a list of ForwardingRule resources available to the specified
         # project and region.
         # @param [String] project
         #   Project ID for this request.
         # @param [String] region
         #   Name of the region scoping this request.
@@ -2319,11 +2325,11 @@
           command.query['quotaUser'] = quota_user unless quota_user.nil?
           command.query['userIp'] = user_ip unless user_ip.nil?
           execute_or_queue_command(command, &block)
         end
         
-        # Retrieves the list of global address resources.
+        # Retrieves a list of global address resources.
         # @param [String] project
         #   Project ID for this request.
         # @param [String] filter
         #   Sets a filter expression for filtering listed resources, in the form filter=`
         #   expression`. Your `expression` must be in the format: field_name
@@ -2512,11 +2518,11 @@
           command.query['quotaUser'] = quota_user unless quota_user.nil?
           command.query['userIp'] = user_ip unless user_ip.nil?
           execute_or_queue_command(command, &block)
         end
         
-        # Retrieves the list of ForwardingRule resources available to the specified
+        # Retrieves a list of ForwardingRule resources available to the specified
         # project.
         # @param [String] project
         #   Project ID for this request.
         # @param [String] filter
         #   Sets a filter expression for filtering listed resources, in the form filter=`
@@ -2633,11 +2639,11 @@
           command.query['quotaUser'] = quota_user unless quota_user.nil?
           command.query['userIp'] = user_ip unless user_ip.nil?
           execute_or_queue_command(command, &block)
         end
         
-        # Retrieves the list of all operations grouped by scope.
+        # Retrieves an aggregated list of all operations.
         # @param [String] project
         #   Project ID for this request.
         # @param [String] filter
         #   Sets a filter expression for filtering listed resources, in the form filter=`
         #   expression`. Your `expression` must be in the format: field_name
@@ -2785,12 +2791,11 @@
           command.query['quotaUser'] = quota_user unless quota_user.nil?
           command.query['userIp'] = user_ip unless user_ip.nil?
           execute_or_queue_command(command, &block)
         end
         
-        # Retrieves the list of Operation resources contained within the specified
-        # project.
+        # Retrieves a list of Operation resources contained within the specified project.
         # @param [String] project
         #   Project ID for this request.
         # @param [String] filter
         #   Sets a filter expression for filtering listed resources, in the form filter=`
         #   expression`. Your `expression` must be in the format: field_name
@@ -3791,11 +3796,12 @@
           command.query['userIp'] = user_ip unless user_ip.nil?
           execute_or_queue_command(command, &block)
         end
         
         # Deletes the specified managed instance group and all of the instances in that
-        # group.
+        # group. Note that the instance group must not belong to a backend service. Read
+        # Deleting an instance group for more information.
         # @param [String] project
         #   Project ID for this request.
         # @param [String] zone
         #   The name of the zone where the managed instance group is located.
         # @param [String] instance_group_manager
@@ -4335,12 +4341,12 @@
           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
         
-        # Adds a list of instances to the specified instance group. All of the instances
-        # in the instance group must be in the same network/subnetwork.
+        # Adds a list of instances to the specified instance group. Read  Adding
+        # instances for more information.
         # @param [String] project
         #   Project ID for this request.
         # @param [String] zone
         #   The name of the zone where the instance group is located.
         # @param [String] instance_group
@@ -4459,11 +4465,12 @@
           command.query['userIp'] = user_ip unless user_ip.nil?
           execute_or_queue_command(command, &block)
         end
         
         # Deletes the specified instance group. The instances in the group are not
-        # deleted.
+        # deleted. Note that instance group must not belong to a backend service. Read
+        # Deleting an instance group for more information.
         # @param [String] project
         #   Project ID for this request.
         # @param [String] zone
         #   The name of the zone where the instance group is located.
         # @param [String] instance_group
@@ -4919,11 +4926,13 @@
           command.query['userIp'] = user_ip unless user_ip.nil?
           execute_or_queue_command(command, &block)
         end
         
         # Creates an instance template in the specified project using the data that is
-        # included in the request.
+        # included in the request. If you are creating a new template to update an
+        # existing instance group, your new instance template must use the same network
+        # or, if applicable, the same subnetwork as the original template.
         # @param [String] project
         #   Project ID for this request.
         # @param [Google::Apis::ComputeBeta::InstanceTemplate] instance_template_object
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
@@ -5855,12 +5864,12 @@
           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
         
-        # This method starts an instance that was stopped using the using the instances()
-        # .stop method. For more information, see Restart an instance.
+        # Starts an instance that was stopped using the using the instances().stop
+        # method. For more information, see Restart an instance.
         # @param [String] project
         #   Project ID for this request.
         # @param [String] zone
         #   The name of the zone for this request.
         # @param [String] instance
@@ -5897,16 +5906,16 @@
           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
         
-        # This method stops a running instance, shutting it down cleanly, and allows you
-        # to restart the instance at a later time. Stopped instances do not incur per-
-        # minute, virtual machine usage charges while they are stopped, but any
-        # resources that the virtual machine is using, such as persistent disks and
-        # static IP addresses,will continue to be charged until they are deleted. For
-        # more information, see Stopping an instance.
+        # Stops a running instance, shutting it down cleanly, and allows you to restart
+        # the instance at a later time. Stopped instances do not incur per-minute,
+        # virtual machine usage charges while they are stopped, but any resources that
+        # the virtual machine is using, such as persistent disks and static IP addresses,
+        # will continue to be charged until they are deleted. For more information, see
+        # Stopping an instance.
         # @param [String] project
         #   Project ID for this request.
         # @param [String] zone
         #   The name of the zone for this request.
         # @param [String] instance
@@ -5981,11 +5990,11 @@
           command.query['quotaUser'] = quota_user unless quota_user.nil?
           command.query['userIp'] = user_ip unless user_ip.nil?
           execute_or_queue_command(command, &block)
         end
         
-        # Retrieves the list of machine type resources grouped by scope.
+        # Retrieves an aggregated list of machine type resources.
         # @param [String] project
         #   Project ID for this request.
         # @param [String] filter
         #   Sets a filter expression for filtering listed resources, in the form filter=`
         #   expression`. Your `expression` must be in the format: field_name
@@ -6100,12 +6109,11 @@
           command.query['quotaUser'] = quota_user unless quota_user.nil?
           command.query['userIp'] = user_ip unless user_ip.nil?
           execute_or_queue_command(command, &block)
         end
         
-        # Retrieves the list of machine type resources available to the specified
-        # project.
+        # Retrieves a list of machine type resources available to the specified project.
         # @param [String] project
         #   Project ID for this request.
         # @param [String] zone
         #   The name of the zone for this request.
         # @param [String] filter
@@ -6570,11 +6578,11 @@
         
         # Retrieves the specified region-specific Operations resource.
         # @param [String] project
         #   Project ID for this request.
         # @param [String] region
-        #   Name of the zone scoping this request.
+        #   Name of the region scoping this request.
         # @param [String] operation
         #   Name of the Operations resource to return.
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
         # @param [String] quota_user
@@ -6607,12 +6615,11 @@
           command.query['quotaUser'] = quota_user unless quota_user.nil?
           command.query['userIp'] = user_ip unless user_ip.nil?
           execute_or_queue_command(command, &block)
         end
         
-        # Retrieves the list of Operation resources contained within the specified
-        # region.
+        # Retrieves a list of Operation resources contained within the specified region.
         # @param [String] project
         #   Project ID for this request.
         # @param [String] region
         #   Name of the region scoping this request.
         # @param [String] filter
@@ -7351,11 +7358,11 @@
           command.query['quotaUser'] = quota_user unless quota_user.nil?
           command.query['userIp'] = user_ip unless user_ip.nil?
           execute_or_queue_command(command, &block)
         end
         
-        # Retrieves the list of Subnetworks grouped by scope.
+        # Retrieves an aggregated list of subnetworks.
         # @param [String] project
         #   Project ID for this request.
         # @param [String] filter
         #   Sets a filter expression for filtering listed resources, in the form filter=`
         #   expression`. Your `expression` must be in the format: field_name
@@ -7429,11 +7436,11 @@
           command.query['quotaUser'] = quota_user unless quota_user.nil?
           command.query['userIp'] = user_ip unless user_ip.nil?
           execute_or_queue_command(command, &block)
         end
         
-        # Deletes the specified Subnetwork resource.
+        # Deletes the specified subnetwork.
         # @param [String] project
         #   Project ID for this request.
         # @param [String] region
         #   Name of the region scoping this request.
         # @param [String] subnetwork
@@ -7470,11 +7477,11 @@
           command.query['quotaUser'] = quota_user unless quota_user.nil?
           command.query['userIp'] = user_ip unless user_ip.nil?
           execute_or_queue_command(command, &block)
         end
         
-        # Returns the specified Subnetwork resource.
+        # Returns the specified subnetwork.
         # @param [String] project
         #   Project ID for this request.
         # @param [String] region
         #   Name of the region scoping this request.
         # @param [String] subnetwork
@@ -7511,12 +7518,12 @@
           command.query['quotaUser'] = quota_user unless quota_user.nil?
           command.query['userIp'] = user_ip unless user_ip.nil?
           execute_or_queue_command(command, &block)
         end
         
-        # Creates a Subnetwork resource in the specified project using the data included
-        # in the request.
+        # Creates a subnetwork in the specified project using the data included in the
+        # request.
         # @param [String] project
         #   Project ID for this request.
         # @param [String] region
         #   Name of the region scoping this request.
         # @param [Google::Apis::ComputeBeta::Subnetwork] subnetwork_object
@@ -7553,11 +7560,11 @@
           command.query['quotaUser'] = quota_user unless quota_user.nil?
           command.query['userIp'] = user_ip unless user_ip.nil?
           execute_or_queue_command(command, &block)
         end
         
-        # Retrieves the list of Subnetwork resources available to the specified project.
+        # Retrieves a list of subnetworks available to the specified project.
         # @param [String] project
         #   Project ID for this request.
         # @param [String] region
         #   Name of the region scoping this request.
         # @param [String] filter
@@ -8145,11 +8152,11 @@
           command.query['quotaUser'] = quota_user unless quota_user.nil?
           command.query['userIp'] = user_ip unless user_ip.nil?
           execute_or_queue_command(command, &block)
         end
         
-        # Retrieves the list of target instances grouped by scope.
+        # Retrieves an aggregated list of target instances.
         # @param [String] project
         #   Project ID for this request.
         # @param [String] filter
         #   Sets a filter expression for filtering listed resources, in the form filter=`
         #   expression`. Your `expression` must be in the format: field_name
@@ -8347,11 +8354,11 @@
           command.query['quotaUser'] = quota_user unless quota_user.nil?
           command.query['userIp'] = user_ip unless user_ip.nil?
           execute_or_queue_command(command, &block)
         end
         
-        # Retrieves the list of TargetInstance resources available to the specified
+        # Retrieves a list of TargetInstance resources available to the specified
         # project and zone.
         # @param [String] project
         #   Project ID for this request.
         # @param [String] zone
         #   Name of the zone scoping this request.
@@ -8515,11 +8522,11 @@
           command.query['quotaUser'] = quota_user unless quota_user.nil?
           command.query['userIp'] = user_ip unless user_ip.nil?
           execute_or_queue_command(command, &block)
         end
         
-        # Retrieves the list of target pools grouped by scope.
+        # Retrieves an aggregated list of target pools.
         # @param [String] project
         #   Project ID for this request.
         # @param [String] filter
         #   Sets a filter expression for filtering listed resources, in the form filter=`
         #   expression`. Your `expression` must be in the format: field_name
@@ -8676,11 +8683,11 @@
           command.query['userIp'] = user_ip unless user_ip.nil?
           execute_or_queue_command(command, &block)
         end
         
         # Gets the most recent health check results for each IP for the given instance
-        # that is referenced by given TargetPool.
+        # that is referenced by the given TargetPool.
         # @param [String] project
         # @param [String] region
         #   Name of the region scoping this request.
         # @param [String] target_pool
         #   Name of the TargetPool resource to which the queried instance belongs.
@@ -8761,11 +8768,11 @@
           command.query['quotaUser'] = quota_user unless quota_user.nil?
           command.query['userIp'] = user_ip unless user_ip.nil?
           execute_or_queue_command(command, &block)
         end
         
-        # Retrieves the list of TargetPool resources available to the specified project
+        # Retrieves a list of TargetPool resources available to the specified project
         # and region.
         # @param [String] project
         #   Project ID for this request.
         # @param [String] region
         #   Name of the region scoping this request.
@@ -8976,11 +8983,11 @@
           command.query['quotaUser'] = quota_user unless quota_user.nil?
           command.query['userIp'] = user_ip unless user_ip.nil?
           execute_or_queue_command(command, &block)
         end
         
-        # Retrieves the list of target VPN gateways grouped by scope.
+        # Retrieves an aggregated list of target VPN gateways .
         # @param [String] project
         #   Project ID for this request.
         # @param [String] filter
         #   Sets a filter expression for filtering listed resources, in the form filter=`
         #   expression`. Your `expression` must be in the format: field_name
@@ -9178,11 +9185,11 @@
           command.query['quotaUser'] = quota_user unless quota_user.nil?
           command.query['userIp'] = user_ip unless user_ip.nil?
           execute_or_queue_command(command, &block)
         end
         
-        # Retrieves the list of TargetVpnGateway resources available to the specified
+        # Retrieves a list of TargetVpnGateway resources available to the specified
         # project and region.
         # @param [String] project
         #   Project ID for this request.
         # @param [String] region
         #   The name of the region for this request.
@@ -9453,11 +9460,11 @@
           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 the entire content of the UrlMap resource. This method supports patch
+        # Updates the entire content of the UrlMap resource. This method supports patch
         # semantics.
         # @param [String] project
         #   Project ID for this request.
         # @param [String] url_map
         #   Name of the UrlMap resource to update.
@@ -9495,11 +9502,11 @@
           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 the entire content of the UrlMap resource.
+        # Updates the entire content of the UrlMap resource.
         # @param [String] project
         #   Project ID for this request.
         # @param [String] url_map
         #   Name of the UrlMap resource to update.
         # @param [Google::Apis::ComputeBeta::UrlMap] url_map_object
@@ -9536,12 +9543,12 @@
           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
         
-        # Run static validation for the UrlMap. In particular, the tests of the provided
-        # UrlMap will be run. Calling this method does NOT create the UrlMap.
+        # Runs static validation for the UrlMap. In particular, the tests of the
+        # provided UrlMap will be run. Calling this method does NOT create the UrlMap.
         # @param [String] project
         #   Project ID for this request.
         # @param [String] url_map
         #   Name of the UrlMap resource to be validated as.
         # @param [Google::Apis::ComputeBeta::ValidateUrlMapsRequest] validate_url_maps_request_object
@@ -9578,11 +9585,11 @@
           command.query['quotaUser'] = quota_user unless quota_user.nil?
           command.query['userIp'] = user_ip unless user_ip.nil?
           execute_or_queue_command(command, &block)
         end
         
-        # Retrieves the list of VPN tunnels grouped by scope.
+        # Retrieves an aggregated list of VPN tunnels.
         # @param [String] project
         #   Project ID for this request.
         # @param [String] filter
         #   Sets a filter expression for filtering listed resources, in the form filter=`
         #   expression`. Your `expression` must be in the format: field_name
@@ -9780,12 +9787,12 @@
           command.query['quotaUser'] = quota_user unless quota_user.nil?
           command.query['userIp'] = user_ip unless user_ip.nil?
           execute_or_queue_command(command, &block)
         end
         
-        # Retrieves the list of VpnTunnel resources contained in the specified project
-        # and region.
+        # Retrieves a list of VpnTunnel resources contained in the specified project and
+        # region.
         # @param [String] project
         #   Project ID for this request.
         # @param [String] region
         #   The name of the region for this request.
         # @param [String] filter
@@ -9942,10 +9949,10 @@
           command.query['quotaUser'] = quota_user unless quota_user.nil?
           command.query['userIp'] = user_ip unless user_ip.nil?
           execute_or_queue_command(command, &block)
         end
         
-        # Retrieves the list of Operation resources contained within the specified zone.
+        # Retrieves a list of Operation resources contained within the specified zone.
         # @param [String] project
         #   Project ID for this request.
         # @param [String] zone
         #   Name of the zone scoping this request.
         # @param [String] filter