Source Code for Module cm_api.endpoints.batch

 1  # Licensed to Cloudera, Inc. under one 
 2  # or more contributor license agreements.  See the NOTICE file 
 3  # distributed with this work for additional information 
 4  # regarding copyright ownership.  Cloudera, Inc. licenses this file 
 5  # to you under the Apache License, Version 2.0 (the 
 6  # "License"); you may not use this file except in compliance 
 7  # with the License.  You may obtain a copy of the License at 
 8  # 
 9  #     http://www.apache.org/licenses/LICENSE-2.0 
10  # 
11  # Unless required by applicable law or agreed to in writing, software 
12  # distributed under the License is distributed on an "AS IS" BASIS, 
13  # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 
14  # See the License for the specific language governing permissions and 
15  # limitations under the License. 
16   
17  from cm_api.endpoints.types import * 
18   
19  __docformat__ = "epytext" 
20   
21  BATCH_PATH = "/batch" 
22   
23 -def do_batch(resource_root, elements): 
24    """ 
25    Execute a batch request with one or more elements. If any element fails, 
26    the entire request is rolled back and subsequent elements are ignored. 
27   
28    @param elements: A list of ApiBatchRequestElements 
29    @return: an ApiBatchResponseList 
30    @since: API v6 
31    """ 
32    return call(resource_root.post, BATCH_PATH, ApiBatchResponseList, 
33        data=elements, api_version=6) 
34