1<html><body> 2<style> 3 4body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13} 14 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51} 52 53.toc_element { 54 margin-top: 0.5em; 55} 56 57.firstline { 58 margin-left: 2 em; 59} 60 61.method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66} 67 68.details { 69 font-weight: bold; 70 font-size: 14px; 71} 72 73</style> 74 75<h1><a href="apigee_v1.html">Apigee API</a> . <a href="apigee_v1.organizations.html">organizations</a> . <a href="apigee_v1.organizations.datacollectors.html">datacollectors</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#close">close()</a></code></p> 79<p class="firstline">Close httplib2 connections.</p> 80<p class="toc_element"> 81 <code><a href="#create">create(parent, body=None, dataCollectorId=None, x__xgafv=None)</a></code></p> 82<p class="firstline">Creates a new data collector.</p> 83<p class="toc_element"> 84 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> 85<p class="firstline">Deletes a data collector.</p> 86<p class="toc_element"> 87 <code><a href="#get">get(name, x__xgafv=None)</a></code></p> 88<p class="firstline">Gets a data collector.</p> 89<p class="toc_element"> 90 <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> 91<p class="firstline">Lists all data collectors.</p> 92<p class="toc_element"> 93 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 94<p class="firstline">Retrieves the next page of results.</p> 95<p class="toc_element"> 96 <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p> 97<p class="firstline">Updates a data collector.</p> 98<h3>Method Details</h3> 99<div class="method"> 100 <code class="details" id="close">close()</code> 101 <pre>Close httplib2 connections.</pre> 102</div> 103 104<div class="method"> 105 <code class="details" id="create">create(parent, body=None, dataCollectorId=None, x__xgafv=None)</code> 106 <pre>Creates a new data collector. 107 108Args: 109 parent: string, Required. Name of the organization in which to create the data collector in the following format: `organizations/{org}`. (required) 110 body: object, The request body. 111 The object takes the form of: 112 113{ # Data collector configuration. 114 "createdAt": "A String", # Output only. The time at which the data collector was created in milliseconds since the epoch. 115 "description": "A String", # A description of the data collector. 116 "lastModifiedAt": "A String", # Output only. The time at which the Data Collector was last updated in milliseconds since the epoch. 117 "name": "A String", # ID of the data collector. Must begin with `dc_`. 118 "type": "A String", # Immutable. The type of data this data collector will collect. 119} 120 121 dataCollectorId: string, ID of the data collector. Overrides any ID in the data collector resource. Must be a string beginning with `dc_` that contains only letters, numbers, and underscores. 122 x__xgafv: string, V1 error format. 123 Allowed values 124 1 - v1 error format 125 2 - v2 error format 126 127Returns: 128 An object of the form: 129 130 { # Data collector configuration. 131 "createdAt": "A String", # Output only. The time at which the data collector was created in milliseconds since the epoch. 132 "description": "A String", # A description of the data collector. 133 "lastModifiedAt": "A String", # Output only. The time at which the Data Collector was last updated in milliseconds since the epoch. 134 "name": "A String", # ID of the data collector. Must begin with `dc_`. 135 "type": "A String", # Immutable. The type of data this data collector will collect. 136}</pre> 137</div> 138 139<div class="method"> 140 <code class="details" id="delete">delete(name, x__xgafv=None)</code> 141 <pre>Deletes a data collector. 142 143Args: 144 name: string, Required. Name of the data collector in the following format: `organizations/{org}/datacollectors/{data_collector_id}`. (required) 145 x__xgafv: string, V1 error format. 146 Allowed values 147 1 - v1 error format 148 2 - v2 error format 149 150Returns: 151 An object of the form: 152 153 { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. 154}</pre> 155</div> 156 157<div class="method"> 158 <code class="details" id="get">get(name, x__xgafv=None)</code> 159 <pre>Gets a data collector. 160 161Args: 162 name: string, Required. Name of the data collector in the following format: `organizations/{org}/datacollectors/{data_collector_id}`. (required) 163 x__xgafv: string, V1 error format. 164 Allowed values 165 1 - v1 error format 166 2 - v2 error format 167 168Returns: 169 An object of the form: 170 171 { # Data collector configuration. 172 "createdAt": "A String", # Output only. The time at which the data collector was created in milliseconds since the epoch. 173 "description": "A String", # A description of the data collector. 174 "lastModifiedAt": "A String", # Output only. The time at which the Data Collector was last updated in milliseconds since the epoch. 175 "name": "A String", # ID of the data collector. Must begin with `dc_`. 176 "type": "A String", # Immutable. The type of data this data collector will collect. 177}</pre> 178</div> 179 180<div class="method"> 181 <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code> 182 <pre>Lists all data collectors. 183 184Args: 185 parent: string, Required. Name of the organization for which to list data collectors in the following format: `organizations/{org}`. (required) 186 pageSize: integer, Maximum number of data collectors to return. The page size defaults to 25. 187 pageToken: string, Page token, returned from a previous ListDataCollectors call, that you can use to retrieve the next page. 188 x__xgafv: string, V1 error format. 189 Allowed values 190 1 - v1 error format 191 2 - v2 error format 192 193Returns: 194 An object of the form: 195 196 { # Response for ListDataCollectors. 197 "dataCollectors": [ # Data collectors in the specified organization. 198 { # Data collector configuration. 199 "createdAt": "A String", # Output only. The time at which the data collector was created in milliseconds since the epoch. 200 "description": "A String", # A description of the data collector. 201 "lastModifiedAt": "A String", # Output only. The time at which the Data Collector was last updated in milliseconds since the epoch. 202 "name": "A String", # ID of the data collector. Must begin with `dc_`. 203 "type": "A String", # Immutable. The type of data this data collector will collect. 204 }, 205 ], 206 "nextPageToken": "A String", # Page token that you can include in a ListDataCollectors request to retrieve the next page. If omitted, no subsequent pages exist. 207}</pre> 208</div> 209 210<div class="method"> 211 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 212 <pre>Retrieves the next page of results. 213 214Args: 215 previous_request: The request for the previous page. (required) 216 previous_response: The response from the request for the previous page. (required) 217 218Returns: 219 A request object that you can call 'execute()' on to request the next 220 page. Returns None if there are no more items in the collection. 221 </pre> 222</div> 223 224<div class="method"> 225 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code> 226 <pre>Updates a data collector. 227 228Args: 229 name: string, Required. Name of the data collector in the following format: `organizations/{org}/datacollectors/{data_collector_id}`. (required) 230 body: object, The request body. 231 The object takes the form of: 232 233{ # Data collector configuration. 234 "createdAt": "A String", # Output only. The time at which the data collector was created in milliseconds since the epoch. 235 "description": "A String", # A description of the data collector. 236 "lastModifiedAt": "A String", # Output only. The time at which the Data Collector was last updated in milliseconds since the epoch. 237 "name": "A String", # ID of the data collector. Must begin with `dc_`. 238 "type": "A String", # Immutable. The type of data this data collector will collect. 239} 240 241 updateMask: string, List of fields to be updated. 242 x__xgafv: string, V1 error format. 243 Allowed values 244 1 - v1 error format 245 2 - v2 error format 246 247Returns: 248 An object of the form: 249 250 { # Data collector configuration. 251 "createdAt": "A String", # Output only. The time at which the data collector was created in milliseconds since the epoch. 252 "description": "A String", # A description of the data collector. 253 "lastModifiedAt": "A String", # Output only. The time at which the Data Collector was last updated in milliseconds since the epoch. 254 "name": "A String", # ID of the data collector. Must begin with `dc_`. 255 "type": "A String", # Immutable. The type of data this data collector will collect. 256}</pre> 257</div> 258 259</body></html>