canaryevaluations

Creates, updates, deletes, gets or lists a canaryevaluations resource.

Overview

Name	canaryevaluations
Type	Resource
Id	google.apigee.canaryevaluations

Fields

The following fields are returned by SELECT queries:

organizations_instances_canaryevaluations_get

Name	Datatype	Description
name	string	Output only. Name of the canary evalution.
control	string	Required. The stable version that is serving requests.
createTime	string (google-datetime)	Output only. Create time of the canary evaluation.
endTime	string (google-datetime)	Required. End time for the evaluation's analysis.
metricLabels	object	Required. Labels used to filter the metrics used for a canary evaluation. (id: GoogleCloudApigeeV1CanaryEvaluationMetricLabels)
startTime	string (google-datetime)	Required. Start time for the canary evaluation's analysis.
state	string	Output only. The current state of the canary evaluation. (STATE_UNSPECIFIED, RUNNING, SUCCEEDED)
treatment	string	Required. The newer version that is serving requests.
verdict	string	Output only. The resulting verdict of the canary evaluations: NONE, PASS, or FAIL. (VERDICT_UNSPECIFIED, NONE, FAIL, PASS)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
organizations_instances_canaryevaluations_get	select	organizationsId, instancesId, canaryevaluationsId		Gets a CanaryEvaluation for an organization.
organizations_instances_canaryevaluations_create	insert	organizationsId, instancesId		Creates a new canary evaluation for an organization.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
canaryevaluationsId	string
instancesId	string
organizationsId	string

SELECT examples

organizations_instances_canaryevaluations_get

Gets a CanaryEvaluation for an organization.

SELECT
name,
control,
createTime,
endTime,
metricLabels,
startTime,
state,
treatment,
verdict
FROM google.apigee.canaryevaluations
WHERE organizationsId = '{{ organizationsId }}' -- required
AND instancesId = '{{ instancesId }}' -- required
AND canaryevaluationsId = '{{ canaryevaluationsId }}' -- required
;

INSERT examples

organizations_instances_canaryevaluations_create

Creates a new canary evaluation for an organization.

INSERT INTO google.apigee.canaryevaluations (
data__control,
data__metricLabels,
data__endTime,
data__treatment,
data__startTime,
organizationsId,
instancesId
)
SELECT 
'{{ control }}',
'{{ metricLabels }}',
'{{ endTime }}',
'{{ treatment }}',
'{{ startTime }}',
'{{ organizationsId }}',
'{{ instancesId }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: canaryevaluations
props:
  - name: organizationsId
    value: "{{ organizationsId }}"
    description: Required parameter for the canaryevaluations resource.
  - name: instancesId
    value: "{{ instancesId }}"
    description: Required parameter for the canaryevaluations resource.
  - name: control
    value: "{{ control }}"
    description: |
      Required. The stable version that is serving requests.
  - name: metricLabels
    description: |
      Required. Labels used to filter the metrics used for a canary evaluation.
    value:
      instance_id: "{{ instance_id }}"
      location: "{{ location }}"
      env: "{{ env }}"
  - name: endTime
    value: "{{ endTime }}"
    description: |
      Required. End time for the evaluation's analysis.
  - name: treatment
    value: "{{ treatment }}"
    description: |
      Required. The newer version that is serving requests.
  - name: startTime
    value: "{{ startTime }}"
    description: |
      Required. Start time for the canary evaluation's analysis.