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.instances.html">instances</a> . <a href="apigee_v1.organizations.instances.canaryevaluations.html">canaryevaluations</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 new canary evaluation for an organization.</p> 83<p class="toc_element"> 84 <code><a href="#get">get(name, x__xgafv=None)</a></code></p> 85<p class="firstline">Gets a CanaryEvaluation for an organization.</p> 86<h3>Method Details</h3> 87<div class="method"> 88 <code class="details" id="close">close()</code> 89 <pre>Close httplib2 connections.</pre> 90</div> 91 92<div class="method"> 93 <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code> 94 <pre>Creates a new canary evaluation for an organization. 95 96Args: 97 parent: string, Required. Name of the organization. Use the following structure in your request: `organizations/{org}/instances/{instance}`. (required) 98 body: object, The request body. 99 The object takes the form of: 100 101{ # CanaryEvaluation represents the canary analysis between two versions of the runtime that is serving requests. 102 "control": "A String", # Required. The stable version that is serving requests. 103 "createTime": "A String", # Output only. Create time of the canary evaluation. 104 "endTime": "A String", # Required. End time for the evaluation's analysis. 105 "metricLabels": { # Labels that can be used to filter Apigee metrics. # Required. Labels used to filter the metrics used for a canary evaluation. 106 "env": "A String", # The environment ID associated with the metrics. 107 "instance_id": "A String", # Required. The instance ID associated with the metrics. In Apigee Hybrid, the value is configured during installation. 108 "location": "A String", # Required. The location associated with the metrics. 109 }, 110 "name": "A String", # Output only. Name of the canary evalution. 111 "startTime": "A String", # Required. Start time for the canary evaluation's analysis. 112 "state": "A String", # Output only. The current state of the canary evaluation. 113 "treatment": "A String", # Required. The newer version that is serving requests. 114 "verdict": "A String", # Output only. The resulting verdict of the canary evaluations: NONE, PASS, or FAIL. 115} 116 117 x__xgafv: string, V1 error format. 118 Allowed values 119 1 - v1 error format 120 2 - v2 error format 121 122Returns: 123 An object of the form: 124 125 { # This resource represents a long-running operation that is the result of a network API call. 126 "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. 127 "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. 128 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 129 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 130 { 131 "a_key": "", # Properties of the object. Contains field @type with type URL. 132 }, 133 ], 134 "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. 135 }, 136 "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. 137 "a_key": "", # Properties of the object. Contains field @type with type URL. 138 }, 139 "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. 140 "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. 141 "a_key": "", # Properties of the object. Contains field @type with type URL. 142 }, 143}</pre> 144</div> 145 146<div class="method"> 147 <code class="details" id="get">get(name, x__xgafv=None)</code> 148 <pre>Gets a CanaryEvaluation for an organization. 149 150Args: 151 name: string, Required. Name of the CanaryEvaluation. Use the following structure in your request: `organizations/{org}/instances/*/canaryevaluations/{evaluation}` (required) 152 x__xgafv: string, V1 error format. 153 Allowed values 154 1 - v1 error format 155 2 - v2 error format 156 157Returns: 158 An object of the form: 159 160 { # CanaryEvaluation represents the canary analysis between two versions of the runtime that is serving requests. 161 "control": "A String", # Required. The stable version that is serving requests. 162 "createTime": "A String", # Output only. Create time of the canary evaluation. 163 "endTime": "A String", # Required. End time for the evaluation's analysis. 164 "metricLabels": { # Labels that can be used to filter Apigee metrics. # Required. Labels used to filter the metrics used for a canary evaluation. 165 "env": "A String", # The environment ID associated with the metrics. 166 "instance_id": "A String", # Required. The instance ID associated with the metrics. In Apigee Hybrid, the value is configured during installation. 167 "location": "A String", # Required. The location associated with the metrics. 168 }, 169 "name": "A String", # Output only. Name of the canary evalution. 170 "startTime": "A String", # Required. Start time for the canary evaluation's analysis. 171 "state": "A String", # Output only. The current state of the canary evaluation. 172 "treatment": "A String", # Required. The newer version that is serving requests. 173 "verdict": "A String", # Output only. The resulting verdict of the canary evaluations: NONE, PASS, or FAIL. 174}</pre> 175</div> 176 177</body></html>