# Apigee API . organizations . instances . canaryevaluations

## Instance Methods

Close httplib2 connections.

Creates a new canary evaluation for an organization.

Gets a CanaryEvaluation for an organization.

### Method Details

`close()`

    Close httplib2 connections.

`create(parent, body=None, x__xgafv=None)`

    Creates a new canary evaluation for an organization.

    Args:
      parent: string, Required. Name of the organization. Use the following structure in your request: `organizations/{org}/instances/{instance}`. (required)
      body: object, The request body.
        The object takes the form of:

    { # CanaryEvaluation represents the canary analysis between two versions of the runtime that is serving requests.
      "control": "A String", # Required. The stable version that is serving requests.
      "createTime": "A String", # Output only. Create time of the canary evaluation.
      "endTime": "A String", # Required. End time for the evaluation's analysis.
      "metricLabels": { # Labels that can be used to filter Apigee metrics. # Required. Labels used to filter the metrics used for a canary evaluation.
        "env": "A String", # The environment ID associated with the metrics.
        "instance_id": "A String", # Required. The instance ID associated with the metrics. In Apigee Hybrid, the value is configured during installation.
        "location": "A String", # Required. The location associated with the metrics.
      },
      "name": "A String", # Output only. Name of the canary evalution.
      "startTime": "A String", # Required. Start time for the canary evaluation's analysis.
      "state": "A String", # Output only. The current state of the canary evaluation.
      "treatment": "A String", # Required. The newer version that is serving requests.
      "verdict": "A String", # Output only. The resulting verdict of the canary evaluations: NONE, PASS, or FAIL.
    }

      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # This resource represents a long-running operation that is the result of a network API call.
      "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.
      "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.
        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
          {
            "a_key": "", # Properties of the object. Contains field @type with type URL.
          },
        ],
        "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.
      },
      "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.
        "a_key": "", # Properties of the object. Contains field @type with type URL.
      },
      "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}`.
      "response": { # The normal, successful response of the operation. 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`.
        "a_key": "", # Properties of the object. Contains field @type with type URL.
      },
    }

`get(name, x__xgafv=None)`

    Gets a CanaryEvaluation for an organization.

    Args:
      name: string, Required. Name of the CanaryEvaluation. Use the following structure in your request: `organizations/{org}/instances/*/canaryevaluations/{evaluation}` (required)
      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # CanaryEvaluation represents the canary analysis between two versions of the runtime that is serving requests.
      "control": "A String", # Required. The stable version that is serving requests.
      "createTime": "A String", # Output only. Create time of the canary evaluation.
      "endTime": "A String", # Required. End time for the evaluation's analysis.
      "metricLabels": { # Labels that can be used to filter Apigee metrics. # Required. Labels used to filter the metrics used for a canary evaluation.
        "env": "A String", # The environment ID associated with the metrics.
        "instance_id": "A String", # Required. The instance ID associated with the metrics. In Apigee Hybrid, the value is configured during installation.
        "location": "A String", # Required. The location associated with the metrics.
      },
      "name": "A String", # Output only. Name of the canary evalution.
      "startTime": "A String", # Required. Start time for the canary evaluation's analysis.
      "state": "A String", # Output only. The current state of the canary evaluation.
      "treatment": "A String", # Required. The newer version that is serving requests.
      "verdict": "A String", # Output only. The resulting verdict of the canary evaluations: NONE, PASS, or FAIL.
    }