service.rb in google-api-client-0.43.0

- old
+ new

@@ -46,19 +46,17 @@
         def initialize
           super('https://servicenetworking.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,
+        # 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::ServicenetworkingV1::CancelOperationRequest] cancel_operation_request_object
         # @param [String] fields
@@ -88,14 +86,14 @@
           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`.
+        # 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
@@ -121,13 +119,12 @@
           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.
+        # 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] name
         #   The name of the operation resource.
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
         # @param [String] quota_user
@@ -153,19 +150,18 @@
           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.
+        # 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
@@ -202,24 +198,22 @@
           execute_or_queue_command(command, &block)
         end
         
         # For service producers, provisions a new subnet in a peered service's shared
         # VPC network in the requested region and with the requested size that's
-        # expressed as a CIDR range (number of leading bits of ipV4 network mask).
-        # The method checks against the assigned allocated ranges to find a
-        # non-conflicting IP address range. The method will reuse a subnet if
-        # subsequent calls contain the same subnet name, region, and prefix length.
-        # This method will make producer's tenant project to be a shared VPC service
-        # project as needed.
+        # expressed as a CIDR range (number of leading bits of ipV4 network mask). The
+        # method checks against the assigned allocated ranges to find a non-conflicting
+        # IP address range. The method will reuse a subnet if subsequent calls contain
+        # the same subnet name, region, and prefix length. This method will make
+        # producer's tenant project to be a shared VPC service project as needed.
         # @param [String] parent
         #   Required. A tenant project in the service producer organization, in the
-        #   following format: services/`service`/`collection-id`/`resource-id`.
-        #   `collection-id` is the cloud resource collection type that represents the
-        #   tenant project. Only `projects` are supported.
-        #   `resource-id` is the tenant project numeric id, such as
-        #   `123456`. `service` the name of the peering service, such as
-        #   `service-peering.example.com`. This service must already be
+        #   following format: services/`service`/`collection-id`/`resource-id`. `
+        #   collection-id` is the cloud resource collection type that represents the
+        #   tenant project. Only `projects` are supported. `resource-id` is the tenant
+        #   project numeric id, such as `123456`. `service` the name of the peering
+        #   service, such as `service-peering.example.com`. This service must already be
         #   enabled in the service consumer's project.
         # @param [Google::Apis::ServicenetworkingV1::AddSubnetworkRequest] add_subnetwork_request_object
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
         # @param [String] quota_user
@@ -250,12 +244,12 @@
         end
         
         # Disables VPC service controls for a connection.
         # @param [String] parent
         #   The service that is managing peering connectivity for a service producer's
-        #   organization. For Google services that support this functionality, this
-        #   value is `services/servicenetworking.googleapis.com`.
+        #   organization. For Google services that support this functionality, this value
+        #   is `services/servicenetworking.googleapis.com`.
         # @param [Google::Apis::ServicenetworkingV1::DisableVpcServiceControlsRequest] disable_vpc_service_controls_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
@@ -285,12 +279,12 @@
         end
         
         # Enables VPC service controls for a connection.
         # @param [String] parent
         #   The service that is managing peering connectivity for a service producer's
-        #   organization. For Google services that support this functionality, this
-        #   value is `services/servicenetworking.googleapis.com`.
+        #   organization. For Google services that support this functionality, this value
+        #   is `services/servicenetworking.googleapis.com`.
         # @param [Google::Apis::ServicenetworkingV1::EnableVpcServiceControlsRequest] enable_vpc_service_controls_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
@@ -317,20 +311,18 @@
           command.query['fields'] = fields unless fields.nil?
           command.query['quotaUser'] = quota_user unless quota_user.nil?
           execute_or_queue_command(command, &block)
         end
         
-        # Service producers can use this method to find a currently unused range
-        # within consumer allocated ranges. This returned range is not reserved,
-        # and not guaranteed to remain unused. It will validate previously provided
-        # allocated ranges, find non-conflicting sub-range of requested size
-        # (expressed in number of leading bits of ipv4 network mask, as in CIDR range
-        # notation).
+        # Service producers can use this method to find a currently unused range within
+        # consumer allocated ranges. This returned range is not reserved, and not
+        # guaranteed to remain unused. It will validate previously provided allocated
+        # ranges, find non-conflicting sub-range of requested size (expressed in number
+        # of leading bits of ipv4 network mask, as in CIDR range notation).
         # @param [String] parent
         #   Required. This is in a form services/`service`. `service` the name of the
-        #   private
-        #   access management service, for example 'service-peering.example.com'.
+        #   private access management service, for example 'service-peering.example.com'.
         # @param [Google::Apis::ServicenetworkingV1::SearchRangeRequest] search_range_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
@@ -357,19 +349,18 @@
           command.query['fields'] = fields unless fields.nil?
           command.query['quotaUser'] = quota_user unless quota_user.nil?
           execute_or_queue_command(command, &block)
         end
         
-        # Service producers use this method to validate if the consumer provided
-        # network, project and requested range are valid. This allows them to use
-        # a fail-fast mechanism for consumer requests, and not have to wait for
-        # AddSubnetwork operation completion to determine if user request is invalid.
+        # Service producers use this method to validate if the consumer provided network,
+        # project and requested range are valid. This allows them to use a fail-fast
+        # mechanism for consumer requests, and not have to wait for AddSubnetwork
+        # operation completion to determine if user request is invalid.
         # @param [String] parent
         #   Required. This is in a form services/`service` where `service` is the name of
-        #   the
-        #   private access management service. For example
-        #   'service-peering.example.com'.
+        #   the private access management service. For example 'service-peering.example.
+        #   com'.
         # @param [Google::Apis::ServicenetworkingV1::ValidateConsumerConfigRequest] validate_consumer_config_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
@@ -396,21 +387,21 @@
           command.query['fields'] = fields unless fields.nil?
           command.query['quotaUser'] = quota_user unless quota_user.nil?
           execute_or_queue_command(command, &block)
         end
         
-        # Creates a private connection that establishes a VPC Network Peering
-        # connection to a VPC network in the service producer's organization.
-        # The administrator of the service consumer's VPC network invokes this
-        # method. The administrator must assign one or more allocated IP ranges for
-        # provisioning subnetworks in the service producer's VPC network. This
-        # connection is used for all supported services in the service producer's
-        # organization, so it only needs to be invoked once.
+        # Creates a private connection that establishes a VPC Network Peering connection
+        # to a VPC network in the service producer's organization. The administrator of
+        # the service consumer's VPC network invokes this method. The administrator must
+        # assign one or more allocated IP ranges for provisioning subnetworks in the
+        # service producer's VPC network. This connection is used for all supported
+        # services in the service producer's organization, so it only needs to be
+        # invoked once.
         # @param [String] parent
         #   The service that is managing peering connectivity for a service producer's
-        #   organization. For Google services that support this functionality, this
-        #   value is `services/servicenetworking.googleapis.com`.
+        #   organization. For Google services that support this functionality, this value
+        #   is `services/servicenetworking.googleapis.com`.
         # @param [Google::Apis::ServicenetworkingV1::Connection] connection_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
@@ -437,26 +428,23 @@
           command.query['fields'] = fields unless fields.nil?
           command.query['quotaUser'] = quota_user unless quota_user.nil?
           execute_or_queue_command(command, &block)
         end
         
-        # List the private connections that are configured in a service consumer's
-        # VPC network.
+        # List the private connections that are configured in a service consumer's VPC
+        # network.
         # @param [String] parent
         #   The service that is managing peering connectivity for a service producer's
-        #   organization. For Google services that support this functionality, this
-        #   value is `services/servicenetworking.googleapis.com`.
-        #   If you specify `services/-` as the parameter value, all configured peering
-        #   services are listed.
+        #   organization. For Google services that support this functionality, this value
+        #   is `services/servicenetworking.googleapis.com`. If you specify `services/-` as
+        #   the parameter value, all configured peering services are listed.
         # @param [String] network
         #   The name of service consumer's VPC network that's connected with service
-        #   producer network through a private connection. The network name must be in
-        #   the following format:
-        #   `projects/`project`/global/networks/`network``. `project` is a
-        #   project number, such as in `12345` that includes the VPC service
-        #   consumer's VPC network. `network` is the name of the service consumer's VPC
-        #   network.
+        #   producer network through a private connection. The network name must be in the
+        #   following format: `projects/`project`/global/networks/`network``. `project` is
+        #   a project number, such as in `12345` that includes the VPC service consumer's
+        #   VPC network. `network` is the name of the service consumer's VPC network.
         # @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.
@@ -485,22 +473,21 @@
         
         # Updates the allocated ranges that are assigned to a connection.
         # @param [String] name
         #   The private service connection that connects to a service producer
         #   organization. The name includes both the private service name and the VPC
-        #   network peering name in the format of
-        #   `services/`peering_service_name`/connections/`vpc_peering_name``. For
-        #   Google services that support this functionality, this is
-        #   `services/servicenetworking.googleapis.com/connections/servicenetworking-
-        #   googleapis-com`.
+        #   network peering name in the format of `services/`peering_service_name`/
+        #   connections/`vpc_peering_name``. For Google services that support this
+        #   functionality, this is `services/servicenetworking.googleapis.com/connections/
+        #   servicenetworking-googleapis-com`.
         # @param [Google::Apis::ServicenetworkingV1::Connection] connection_object
         # @param [Boolean] force
-        #   If a previously defined allocated range is removed, force flag must be
-        #   set to true.
+        #   If a previously defined allocated range is removed, force flag must be set to
+        #   true.
         # @param [String] update_mask
-        #   The update mask. If this is omitted, it defaults to "*". You can only
-        #   update the listed peering ranges.
+        #   The update mask. If this is omitted, it defaults to "*". You can only update
+        #   the listed peering ranges.
         # @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.
@@ -532,13 +519,12 @@
         
         # Service producers can use this method to add DNS record sets to private DNS
         # zones in the shared producer host project.
         # @param [String] parent
         #   Required. The service that is managing peering connectivity for a service
-        #   producer's
-        #   organization. For Google services that support this functionality, this
-        #   value is `services/servicenetworking.googleapis.com`.
+        #   producer's organization. For Google services that support this functionality,
+        #   this value is `services/servicenetworking.googleapis.com`.
         # @param [Google::Apis::ServicenetworkingV1::AddDnsRecordSetRequest] add_dns_record_set_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
@@ -565,17 +551,16 @@
           command.query['fields'] = fields unless fields.nil?
           command.query['quotaUser'] = quota_user unless quota_user.nil?
           execute_or_queue_command(command, &block)
         end
         
-        # Service producers can use this method to remove DNS record sets from
-        # private DNS zones in the shared producer host project.
+        # Service producers can use this method to remove DNS record sets from private
+        # DNS zones in the shared producer host project.
         # @param [String] parent
         #   Required. The service that is managing peering connectivity for a service
-        #   producer's
-        #   organization. For Google services that support this functionality, this
-        #   value is `services/servicenetworking.googleapis.com`.
+        #   producer's organization. For Google services that support this functionality,
+        #   this value is `services/servicenetworking.googleapis.com`.
         # @param [Google::Apis::ServicenetworkingV1::RemoveDnsRecordSetRequest] remove_dns_record_set_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
@@ -602,17 +587,16 @@
           command.query['fields'] = fields unless fields.nil?
           command.query['quotaUser'] = quota_user unless quota_user.nil?
           execute_or_queue_command(command, &block)
         end
         
-        # Service producers can use this method to update DNS record sets from
-        # private DNS zones in the shared producer host project.
+        # Service producers can use this method to update DNS record sets from private
+        # DNS zones in the shared producer host project.
         # @param [String] parent
         #   Required. The service that is managing peering connectivity for a service
-        #   producer's
-        #   organization. For Google services that support this functionality, this
-        #   value is `services/servicenetworking.googleapis.com`.
+        #   producer's organization. For Google services that support this functionality,
+        #   this value is `services/servicenetworking.googleapis.com`.
         # @param [Google::Apis::ServicenetworkingV1::UpdateDnsRecordSetRequest] update_dns_record_set_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
@@ -639,18 +623,16 @@
           command.query['fields'] = fields unless fields.nil?
           command.query['quotaUser'] = quota_user unless quota_user.nil?
           execute_or_queue_command(command, &block)
         end
         
-        # Service producers can use this method to add private DNS zones in the
-        # shared producer host project and matching peering zones in the consumer
-        # project.
+        # Service producers can use this method to add private DNS zones in the shared
+        # producer host project and matching peering zones in the consumer project.
         # @param [String] parent
         #   Required. The service that is managing peering connectivity for a service
-        #   producer's
-        #   organization. For Google services that support this functionality, this
-        #   value is `services/servicenetworking.googleapis.com`.
+        #   producer's organization. For Google services that support this functionality,
+        #   this value is `services/servicenetworking.googleapis.com`.
         # @param [Google::Apis::ServicenetworkingV1::AddDnsZoneRequest] add_dns_zone_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
@@ -682,13 +664,12 @@
         # Service producers can use this method to remove private DNS zones in the
         # shared producer host project and matching peering zones in the consumer
         # project.
         # @param [String] parent
         #   Required. The service that is managing peering connectivity for a service
-        #   producer's
-        #   organization. For Google services that support this functionality, this
-        #   value is `services/servicenetworking.googleapis.com`.
+        #   producer's organization. For Google services that support this functionality,
+        #   this value is `services/servicenetworking.googleapis.com`.
         # @param [Google::Apis::ServicenetworkingV1::RemoveDnsZoneRequest] remove_dns_zone_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
@@ -716,17 +697,16 @@
           command.query['quotaUser'] = quota_user unless quota_user.nil?
           execute_or_queue_command(command, &block)
         end
         
         # Service producers can use this method to add roles in the shared VPC host
-        # project. Each role is bound to the provided member. Each role must be
-        # selected from within a whitelisted set of roles. Each role is applied at
-        # only the granularity specified in the whitelist.
+        # project. Each role is bound to the provided member. Each role must be selected
+        # from within a whitelisted set of roles. Each role is applied at only the
+        # granularity specified in the whitelist.
         # @param [String] parent
         #   Required. This is in a form services/`service` where `service` is the name of
-        #   the
-        #   private access management service. For example
-        #   'service-peering.example.com'.
+        #   the private access management service. For example 'service-peering.example.
+        #   com'.
         # @param [Google::Apis::ServicenetworkingV1::AddRolesRequest] add_roles_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