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.environments.html">environments</a> . <a href="apigee_v1.organizations.environments.traceConfig.html">traceConfig</a> . <a href="apigee_v1.organizations.environments.traceConfig.overrides.html">overrides</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, x__xgafv=None)</a></code></p> 82<p class="firstline">Creates a trace configuration override. The response contains a system-generated UUID, that can be used to view, update, or delete the configuration override. Use the List API to view the existing trace configuration overrides.</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 distributed trace configuration override.</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 trace configuration override.</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 of the distributed trace configuration overrides in an environment.</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 distributed trace configuration override. Note that the repeated fields have replace semantics when included in the field mask and that they will be overwritten by the value of the fields in the request body.</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, x__xgafv=None)</code> 106 <pre>Creates a trace configuration override. The response contains a system-generated UUID, that can be used to view, update, or delete the configuration override. Use the List API to view the existing trace configuration overrides. 107 108Args: 109 parent: string, Required. Parent resource of the trace configuration override. Use the following structure in your request. "organizations/*/environments/*/traceConfig". (required) 110 body: object, The request body. 111 The object takes the form of: 112 113{ # A representation of a configuration override. 114 "apiProxy": "A String", # ID of the API proxy that will have its trace configuration overridden. 115 "name": "A String", # ID of the trace configuration override specified as a system-generated UUID. 116 "samplingConfig": { # TraceSamplingConfig represents the detail settings of distributed tracing. Only the fields that are defined in the distributed trace configuration can be overridden using the distribute trace configuration override APIs. # Trace configuration to override. 117 "sampler": "A String", # Sampler of distributed tracing. OFF is the default value. 118 "samplingRate": 3.14, # Field sampling rate. This value is only applicable when using the PROBABILITY sampler. The supported values are > 0 and <= 0.5. 119 }, 120} 121 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 { # A representation of a configuration override. 131 "apiProxy": "A String", # ID of the API proxy that will have its trace configuration overridden. 132 "name": "A String", # ID of the trace configuration override specified as a system-generated UUID. 133 "samplingConfig": { # TraceSamplingConfig represents the detail settings of distributed tracing. Only the fields that are defined in the distributed trace configuration can be overridden using the distribute trace configuration override APIs. # Trace configuration to override. 134 "sampler": "A String", # Sampler of distributed tracing. OFF is the default value. 135 "samplingRate": 3.14, # Field sampling rate. This value is only applicable when using the PROBABILITY sampler. The supported values are > 0 and <= 0.5. 136 }, 137}</pre> 138</div> 139 140<div class="method"> 141 <code class="details" id="delete">delete(name, x__xgafv=None)</code> 142 <pre>Deletes a distributed trace configuration override. 143 144Args: 145 name: string, Required. Name of the trace configuration override. Use the following structure in your request: "organizations/*/environments/*/traceConfig/overrides/*". (required) 146 x__xgafv: string, V1 error format. 147 Allowed values 148 1 - v1 error format 149 2 - v2 error format 150 151Returns: 152 An object of the form: 153 154 { # 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 `{}`. 155}</pre> 156</div> 157 158<div class="method"> 159 <code class="details" id="get">get(name, x__xgafv=None)</code> 160 <pre>Gets a trace configuration override. 161 162Args: 163 name: string, Required. Name of the trace configuration override. Use the following structure in your request: "organizations/*/environments/*/traceConfig/overrides/*". (required) 164 x__xgafv: string, V1 error format. 165 Allowed values 166 1 - v1 error format 167 2 - v2 error format 168 169Returns: 170 An object of the form: 171 172 { # A representation of a configuration override. 173 "apiProxy": "A String", # ID of the API proxy that will have its trace configuration overridden. 174 "name": "A String", # ID of the trace configuration override specified as a system-generated UUID. 175 "samplingConfig": { # TraceSamplingConfig represents the detail settings of distributed tracing. Only the fields that are defined in the distributed trace configuration can be overridden using the distribute trace configuration override APIs. # Trace configuration to override. 176 "sampler": "A String", # Sampler of distributed tracing. OFF is the default value. 177 "samplingRate": 3.14, # Field sampling rate. This value is only applicable when using the PROBABILITY sampler. The supported values are > 0 and <= 0.5. 178 }, 179}</pre> 180</div> 181 182<div class="method"> 183 <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code> 184 <pre>Lists all of the distributed trace configuration overrides in an environment. 185 186Args: 187 parent: string, Required. Parent resource of the trace configuration override. Use the following structure in your request: "organizations/*/environments/*/traceConfig". (required) 188 pageSize: integer, Maximum number of trace configuration overrides to return. If not specified, the maximum number returned is 25. The maximum number cannot exceed 100. 189 pageToken: string, A page token, returned from a previous `ListTraceConfigOverrides` call. Token value that can be used to retrieve the subsequent page. When paginating, all other parameters provided to `ListTraceConfigOverrides` must match those specified in the call to obtain the page token. 190 x__xgafv: string, V1 error format. 191 Allowed values 192 1 - v1 error format 193 2 - v2 error format 194 195Returns: 196 An object of the form: 197 198 { # Response for ListTraceConfigOverrides. 199 "nextPageToken": "A String", # Token value that can be passed as `page_token` to retrieve the next page of content. 200 "traceConfigOverrides": [ # List all trace configuration overrides in an environment. 201 { # A representation of a configuration override. 202 "apiProxy": "A String", # ID of the API proxy that will have its trace configuration overridden. 203 "name": "A String", # ID of the trace configuration override specified as a system-generated UUID. 204 "samplingConfig": { # TraceSamplingConfig represents the detail settings of distributed tracing. Only the fields that are defined in the distributed trace configuration can be overridden using the distribute trace configuration override APIs. # Trace configuration to override. 205 "sampler": "A String", # Sampler of distributed tracing. OFF is the default value. 206 "samplingRate": 3.14, # Field sampling rate. This value is only applicable when using the PROBABILITY sampler. The supported values are > 0 and <= 0.5. 207 }, 208 }, 209 ], 210}</pre> 211</div> 212 213<div class="method"> 214 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 215 <pre>Retrieves the next page of results. 216 217Args: 218 previous_request: The request for the previous page. (required) 219 previous_response: The response from the request for the previous page. (required) 220 221Returns: 222 A request object that you can call 'execute()' on to request the next 223 page. Returns None if there are no more items in the collection. 224 </pre> 225</div> 226 227<div class="method"> 228 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code> 229 <pre>Updates a distributed trace configuration override. Note that the repeated fields have replace semantics when included in the field mask and that they will be overwritten by the value of the fields in the request body. 230 231Args: 232 name: string, Required. Name of the trace configuration override. Use the following structure in your request: "organizations/*/environments/*/traceConfig/overrides/*". (required) 233 body: object, The request body. 234 The object takes the form of: 235 236{ # A representation of a configuration override. 237 "apiProxy": "A String", # ID of the API proxy that will have its trace configuration overridden. 238 "name": "A String", # ID of the trace configuration override specified as a system-generated UUID. 239 "samplingConfig": { # TraceSamplingConfig represents the detail settings of distributed tracing. Only the fields that are defined in the distributed trace configuration can be overridden using the distribute trace configuration override APIs. # Trace configuration to override. 240 "sampler": "A String", # Sampler of distributed tracing. OFF is the default value. 241 "samplingRate": 3.14, # Field sampling rate. This value is only applicable when using the PROBABILITY sampler. The supported values are > 0 and <= 0.5. 242 }, 243} 244 245 updateMask: string, List of fields to be updated. 246 x__xgafv: string, V1 error format. 247 Allowed values 248 1 - v1 error format 249 2 - v2 error format 250 251Returns: 252 An object of the form: 253 254 { # A representation of a configuration override. 255 "apiProxy": "A String", # ID of the API proxy that will have its trace configuration overridden. 256 "name": "A String", # ID of the trace configuration override specified as a system-generated UUID. 257 "samplingConfig": { # TraceSamplingConfig represents the detail settings of distributed tracing. Only the fields that are defined in the distributed trace configuration can be overridden using the distribute trace configuration override APIs. # Trace configuration to override. 258 "sampler": "A String", # Sampler of distributed tracing. OFF is the default value. 259 "samplingRate": 3.14, # Field sampling rate. This value is only applicable when using the PROBABILITY sampler. The supported values are > 0 and <= 0.5. 260 }, 261}</pre> 262</div> 263 264</body></html>