google-native logo
Google Cloud Native v0.28.0, Feb 2 23

google-native.apigee/v1.getCanaryEvaluation

Gets a CanaryEvaluation for an organization.

Using getCanaryEvaluation

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getCanaryEvaluation(args: GetCanaryEvaluationArgs, opts?: InvokeOptions): Promise<GetCanaryEvaluationResult>
function getCanaryEvaluationOutput(args: GetCanaryEvaluationOutputArgs, opts?: InvokeOptions): Output<GetCanaryEvaluationResult>
def get_canary_evaluation(canaryevaluation_id: Optional[str] = None,
                          instance_id: Optional[str] = None,
                          organization_id: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetCanaryEvaluationResult
def get_canary_evaluation_output(canaryevaluation_id: Optional[pulumi.Input[str]] = None,
                          instance_id: Optional[pulumi.Input[str]] = None,
                          organization_id: Optional[pulumi.Input[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetCanaryEvaluationResult]
func LookupCanaryEvaluation(ctx *Context, args *LookupCanaryEvaluationArgs, opts ...InvokeOption) (*LookupCanaryEvaluationResult, error)
func LookupCanaryEvaluationOutput(ctx *Context, args *LookupCanaryEvaluationOutputArgs, opts ...InvokeOption) LookupCanaryEvaluationResultOutput

> Note: This function is named LookupCanaryEvaluation in the Go SDK.

public static class GetCanaryEvaluation 
{
    public static Task<GetCanaryEvaluationResult> InvokeAsync(GetCanaryEvaluationArgs args, InvokeOptions? opts = null)
    public static Output<GetCanaryEvaluationResult> Invoke(GetCanaryEvaluationInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetCanaryEvaluationResult> getCanaryEvaluation(GetCanaryEvaluationArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
  function: google-native:apigee/v1:getCanaryEvaluation
  arguments:
    # arguments dictionary

The following arguments are supported:

getCanaryEvaluation Result

The following output properties are available:

Control string

The stable version that is serving requests.

CreateTime string

Create time of the canary evaluation.

EndTime string

End time for the evaluation's analysis.

MetricLabels Pulumi.GoogleNative.Apigee.V1.Outputs.GoogleCloudApigeeV1CanaryEvaluationMetricLabelsResponse

Labels used to filter the metrics used for a canary evaluation.

Name string

Name of the canary evalution.

StartTime string

Start time for the canary evaluation's analysis.

State string

The current state of the canary evaluation.

Treatment string

The newer version that is serving requests.

Verdict string

The resulting verdict of the canary evaluations: NONE, PASS, or FAIL.

Control string

The stable version that is serving requests.

CreateTime string

Create time of the canary evaluation.

EndTime string

End time for the evaluation's analysis.

MetricLabels GoogleCloudApigeeV1CanaryEvaluationMetricLabelsResponse

Labels used to filter the metrics used for a canary evaluation.

Name string

Name of the canary evalution.

StartTime string

Start time for the canary evaluation's analysis.

State string

The current state of the canary evaluation.

Treatment string

The newer version that is serving requests.

Verdict string

The resulting verdict of the canary evaluations: NONE, PASS, or FAIL.

control String

The stable version that is serving requests.

createTime String

Create time of the canary evaluation.

endTime String

End time for the evaluation's analysis.

metricLabels GoogleCloudApigeeV1CanaryEvaluationMetricLabelsResponse

Labels used to filter the metrics used for a canary evaluation.

name String

Name of the canary evalution.

startTime String

Start time for the canary evaluation's analysis.

state String

The current state of the canary evaluation.

treatment String

The newer version that is serving requests.

verdict String

The resulting verdict of the canary evaluations: NONE, PASS, or FAIL.

control string

The stable version that is serving requests.

createTime string

Create time of the canary evaluation.

endTime string

End time for the evaluation's analysis.

metricLabels GoogleCloudApigeeV1CanaryEvaluationMetricLabelsResponse

Labels used to filter the metrics used for a canary evaluation.

name string

Name of the canary evalution.

startTime string

Start time for the canary evaluation's analysis.

state string

The current state of the canary evaluation.

treatment string

The newer version that is serving requests.

verdict string

The resulting verdict of the canary evaluations: NONE, PASS, or FAIL.

control str

The stable version that is serving requests.

create_time str

Create time of the canary evaluation.

end_time str

End time for the evaluation's analysis.

metric_labels GoogleCloudApigeeV1CanaryEvaluationMetricLabelsResponse

Labels used to filter the metrics used for a canary evaluation.

name str

Name of the canary evalution.

start_time str

Start time for the canary evaluation's analysis.

state str

The current state of the canary evaluation.

treatment str

The newer version that is serving requests.

verdict str

The resulting verdict of the canary evaluations: NONE, PASS, or FAIL.

control String

The stable version that is serving requests.

createTime String

Create time of the canary evaluation.

endTime String

End time for the evaluation's analysis.

metricLabels Property Map

Labels used to filter the metrics used for a canary evaluation.

name String

Name of the canary evalution.

startTime String

Start time for the canary evaluation's analysis.

state String

The current state of the canary evaluation.

treatment String

The newer version that is serving requests.

verdict String

The resulting verdict of the canary evaluations: NONE, PASS, or FAIL.

Supporting Types

GoogleCloudApigeeV1CanaryEvaluationMetricLabelsResponse

Env string

The environment ID associated with the metrics.

InstanceId string

The instance ID associated with the metrics. In Apigee Hybrid, the value is configured during installation.

Location string

The location associated with the metrics.

Env string

The environment ID associated with the metrics.

InstanceId string

The instance ID associated with the metrics. In Apigee Hybrid, the value is configured during installation.

Location string

The location associated with the metrics.

env String

The environment ID associated with the metrics.

instanceId String

The instance ID associated with the metrics. In Apigee Hybrid, the value is configured during installation.

location String

The location associated with the metrics.

env string

The environment ID associated with the metrics.

instanceId string

The instance ID associated with the metrics. In Apigee Hybrid, the value is configured during installation.

location string

The location associated with the metrics.

env str

The environment ID associated with the metrics.

instance_id str

The instance ID associated with the metrics. In Apigee Hybrid, the value is configured during installation.

location str

The location associated with the metrics.

env String

The environment ID associated with the metrics.

instanceId String

The instance ID associated with the metrics. In Apigee Hybrid, the value is configured during installation.

location String

The location associated with the metrics.

Package Details

Repository
Google Cloud Native pulumi/pulumi-google-native
License
Apache-2.0