canaryevaluations

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

Overview

Name	canaryevaluations
Type	Resource
Id	google.apigee.canaryevaluations

Fields

Name	Datatype	Description
name	string	Output only. Name of the canary evalution.
control	string	Required. The stable version that is serving requests.
createTime	string	Output only. Create time of the canary evaluation.
endTime	string	Required. End time for the evaluation's analysis.
metricLabels	object	Labels that can be used to filter Apigee metrics.
startTime	string	Required. Start time for the canary evaluation's analysis.
state	string	Output only. The current state of the canary evaluation.
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.

Methods

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

SELECT examples

Gets a CanaryEvaluation for an organization.

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

INSERT example

Use the following StackQL query and manifest file to create a new canaryevaluations resource.

All Properties

/*+ create */
INSERT INTO google.apigee.canaryevaluations (
instancesId,
organizationsId,
control,
endTime,
metricLabels,
startTime,
treatment
)
SELECT 
'{{ instancesId }}',
'{{ organizationsId }}',
'{{ control }}',
'{{ endTime }}',
'{{ metricLabels }}',
'{{ startTime }}',
'{{ treatment }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: createTime
      value: string
    - name: control
      value: string
    - name: endTime
      value: string
    - name: metricLabels
      value:
        - name: env
          value: string
        - name: location
          value: string
        - name: instance_id
          value: string
    - name: startTime
      value: string
    - name: verdict
      value: string
    - name: treatment
      value: string
    - name: name
      value: string
    - name: state
      value: string