Interface RunEvaluationRequestOrBuilder (0.3.0) 

public interface RunEvaluationRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getApp()

public abstract String getApp()

Required. The app to evaluate. Format: projects/{project}/locations/{location}/apps/{app}

string app = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The app.

getAppBytes()

public abstract ByteString getAppBytes()

Required. The app to evaluate. Format: projects/{project}/locations/{location}/apps/{app}

string app = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for app.

getAppVersion()

public abstract String getAppVersion()

Optional. The app version to evaluate. Format: projects/{project}/locations/{location}/apps/{app}/versions/{version}

string app_version = 6 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The appVersion.

getAppVersionBytes()

public abstract ByteString getAppVersionBytes()

Optional. The app version to evaluate. Format: projects/{project}/locations/{location}/apps/{app}/versions/{version}

string app_version = 6 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for appVersion.

getConfig()

public abstract EvaluationConfig getConfig()

Optional. The configuration to use for the run.

.google.cloud.ces.v1beta.EvaluationConfig config = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
EvaluationConfig

The config.

getConfigOrBuilder()

public abstract EvaluationConfigOrBuilder getConfigOrBuilder()

Optional. The configuration to use for the run.

.google.cloud.ces.v1beta.EvaluationConfig config = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
EvaluationConfigOrBuilder

getDisplayName()

public abstract String getDisplayName()

Optional. The display name of the evaluation run.

string display_name = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public abstract ByteString getDisplayNameBytes()

Optional. The display name of the evaluation run.

string display_name = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for displayName.

getEvaluationDataset()

public abstract String getEvaluationDataset()

Optional. An evaluation dataset to run. Format: projects/{project}/locations/{location}/apps/{app}/evaluationDatasets/{evaluationDataset}

string evaluation_dataset = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The evaluationDataset.

getEvaluationDatasetBytes()

public abstract ByteString getEvaluationDatasetBytes()

Optional. An evaluation dataset to run. Format: projects/{project}/locations/{location}/apps/{app}/evaluationDatasets/{evaluationDataset}

string evaluation_dataset = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for evaluationDataset.

getEvaluations(int index)

public abstract String getEvaluations(int index)

Optional. List of evaluations to run. Format: projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}

repeated string evaluations = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The evaluations at the given index.

getEvaluationsBytes(int index)

public abstract ByteString getEvaluationsBytes(int index)

Optional. List of evaluations to run. Format: projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}

repeated string evaluations = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the evaluations at the given index.

getEvaluationsCount()

public abstract int getEvaluationsCount()

Optional. List of evaluations to run. Format: projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}

repeated string evaluations = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
int

The count of evaluations.

getEvaluationsList()

public abstract List<String> getEvaluationsList()

Optional. List of evaluations to run. Format: projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}

repeated string evaluations = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
List<String>

A list containing the evaluations.

getGenerateLatencyReport()

public abstract boolean getGenerateLatencyReport()

Optional. Whether to generate a latency report for the evaluation run.

bool generate_latency_report = 14 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The generateLatencyReport.

getGoldenRunMethod()

public abstract GoldenRunMethod getGoldenRunMethod()

Optional. The method to run the evaluation if it is a golden evaluation. If not set, default to STABLE.

.google.cloud.ces.v1beta.GoldenRunMethod golden_run_method = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
GoldenRunMethod

The goldenRunMethod.

getGoldenRunMethodValue()

public abstract int getGoldenRunMethodValue()

Optional. The method to run the evaluation if it is a golden evaluation. If not set, default to STABLE.

.google.cloud.ces.v1beta.GoldenRunMethod golden_run_method = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for goldenRunMethod.

getOptimizationConfig()

public abstract OptimizationConfig getOptimizationConfig()

Optional. Configuration for running the optimization step after the evaluation run. If not set, the optimization step will not be run.

.google.cloud.ces.v1beta.OptimizationConfig optimization_config = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
OptimizationConfig

The optimizationConfig.

getOptimizationConfigOrBuilder()

public abstract OptimizationConfigOrBuilder getOptimizationConfigOrBuilder()

Optional. Configuration for running the optimization step after the evaluation run. If not set, the optimization step will not be run.

.google.cloud.ces.v1beta.OptimizationConfig optimization_config = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
OptimizationConfigOrBuilder

getPersonaRunConfigs(int index)

public abstract PersonaRunConfig getPersonaRunConfigs(int index)

Optional. The configuration to use for the run per persona.

repeated .google.cloud.ces.v1beta.PersonaRunConfig persona_run_configs = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
PersonaRunConfig

getPersonaRunConfigsCount()

public abstract int getPersonaRunConfigsCount()

Optional. The configuration to use for the run per persona.

repeated .google.cloud.ces.v1beta.PersonaRunConfig persona_run_configs = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getPersonaRunConfigsList()

public abstract List<PersonaRunConfig> getPersonaRunConfigsList()

Optional. The configuration to use for the run per persona.

repeated .google.cloud.ces.v1beta.PersonaRunConfig persona_run_configs = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<PersonaRunConfig>

getPersonaRunConfigsOrBuilder(int index)

public abstract PersonaRunConfigOrBuilder getPersonaRunConfigsOrBuilder(int index)

Optional. The configuration to use for the run per persona.

repeated .google.cloud.ces.v1beta.PersonaRunConfig persona_run_configs = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
PersonaRunConfigOrBuilder

getPersonaRunConfigsOrBuilderList()

public abstract List<? extends PersonaRunConfigOrBuilder> getPersonaRunConfigsOrBuilderList()

Optional. The configuration to use for the run per persona.

repeated .google.cloud.ces.v1beta.PersonaRunConfig persona_run_configs = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<? extends com.google.cloud.ces.v1beta.PersonaRunConfigOrBuilder>

getRunCount()

public abstract int getRunCount()

Optional. The number of times to run the evaluation. If not set, the default value is 1 per golden, and 5 per scenario.

optional int32 run_count = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The runCount.

getScheduledEvaluationRun()

public abstract String getScheduledEvaluationRun()

Optional. The resource name of the ScheduledEvaluationRun that is triggering this evaluation run.

If this field is set, the scheduled_evaluation_run field on the created EvaluationRun resource will be populated from this value. Format: projects/{project}/locations/{location}/apps/{app}/scheduledEvaluationRuns/{scheduled_evaluation_run}

string scheduled_evaluation_run = 12 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The scheduledEvaluationRun.

getScheduledEvaluationRunBytes()

public abstract ByteString getScheduledEvaluationRunBytes()

Optional. The resource name of the ScheduledEvaluationRun that is triggering this evaluation run.

If this field is set, the scheduled_evaluation_run field on the created EvaluationRun resource will be populated from this value. Format: projects/{project}/locations/{location}/apps/{app}/scheduledEvaluationRuns/{scheduled_evaluation_run}

string scheduled_evaluation_run = 12 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for scheduledEvaluationRun.

hasConfig()

public abstract boolean hasConfig()

Optional. The configuration to use for the run.

.google.cloud.ces.v1beta.EvaluationConfig config = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the config field is set.

hasOptimizationConfig()

public abstract boolean hasOptimizationConfig()

Optional. Configuration for running the optimization step after the evaluation run. If not set, the optimization step will not be run.

.google.cloud.ces.v1beta.OptimizationConfig optimization_config = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the optimizationConfig field is set.

hasRunCount()

public abstract boolean hasRunCount()

Optional. The number of times to run the evaluation. If not set, the default value is 1 per golden, and 5 per scenario.

optional int32 run_count = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the runCount field is set.