Class RunEvaluationRequest.Builder (0.3.0) 

public static final class RunEvaluationRequest.Builder extends GeneratedMessage.Builder<RunEvaluationRequest.Builder> implements RunEvaluationRequestOrBuilder

Request message for EvaluationService.RunEvaluation.

Protobuf type google.cloud.ces.v1beta.RunEvaluationRequest

Inheritance

java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > RunEvaluationRequest.Builder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllEvaluations(Iterable<String> values)

public RunEvaluationRequest.Builder addAllEvaluations(Iterable<String> values)

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
values Iterable<String>

The evaluations to add.
Returns
Type Description
RunEvaluationRequest.Builder

This builder for chaining.

addAllPersonaRunConfigs(Iterable<? extends PersonaRunConfig> values)

public RunEvaluationRequest.Builder addAllPersonaRunConfigs(Iterable<? extends PersonaRunConfig> values)

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
values Iterable<? extends com.google.cloud.ces.v1beta.PersonaRunConfig>
Returns
Type Description
RunEvaluationRequest.Builder

addEvaluations(String value)

public RunEvaluationRequest.Builder addEvaluations(String value)

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
value String

The evaluations to add.
Returns
Type Description
RunEvaluationRequest.Builder

This builder for chaining.

addEvaluationsBytes(ByteString value)

public RunEvaluationRequest.Builder addEvaluationsBytes(ByteString value)

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
value ByteString

The bytes of the evaluations to add.
Returns
Type Description
RunEvaluationRequest.Builder

This builder for chaining.

addPersonaRunConfigs(PersonaRunConfig value)

public RunEvaluationRequest.Builder addPersonaRunConfigs(PersonaRunConfig value)

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
value PersonaRunConfig
Returns
Type Description
RunEvaluationRequest.Builder

addPersonaRunConfigs(PersonaRunConfig.Builder builderForValue)

public RunEvaluationRequest.Builder addPersonaRunConfigs(PersonaRunConfig.Builder builderForValue)

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
builderForValue PersonaRunConfig.Builder
Returns
Type Description
RunEvaluationRequest.Builder

addPersonaRunConfigs(int index, PersonaRunConfig value)

public RunEvaluationRequest.Builder addPersonaRunConfigs(int index, PersonaRunConfig value)

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];

Parameters
Name Description
index int
value PersonaRunConfig
Returns
Type Description
RunEvaluationRequest.Builder

addPersonaRunConfigs(int index, PersonaRunConfig.Builder builderForValue)

public RunEvaluationRequest.Builder addPersonaRunConfigs(int index, PersonaRunConfig.Builder builderForValue)

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];

Parameters
Name Description
index int
builderForValue PersonaRunConfig.Builder
Returns
Type Description
RunEvaluationRequest.Builder

addPersonaRunConfigsBuilder()

public PersonaRunConfig.Builder addPersonaRunConfigsBuilder()

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
PersonaRunConfig.Builder

addPersonaRunConfigsBuilder(int index)

public PersonaRunConfig.Builder addPersonaRunConfigsBuilder(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.Builder

build()

public RunEvaluationRequest build()
Returns
Type Description
RunEvaluationRequest

buildPartial()

public RunEvaluationRequest buildPartial()
Returns
Type Description
RunEvaluationRequest

clear()

public RunEvaluationRequest.Builder clear()
Returns
Type Description
RunEvaluationRequest.Builder
Overrides

clearApp()

public RunEvaluationRequest.Builder clearApp()

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
RunEvaluationRequest.Builder

This builder for chaining.

clearAppVersion()

public RunEvaluationRequest.Builder clearAppVersion()

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
RunEvaluationRequest.Builder

This builder for chaining.

clearConfig()

public RunEvaluationRequest.Builder clearConfig()

Optional. The configuration to use for the run.

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

Returns
Type Description
RunEvaluationRequest.Builder

clearDisplayName()

public RunEvaluationRequest.Builder clearDisplayName()

Optional. The display name of the evaluation run.

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

Returns
Type Description
RunEvaluationRequest.Builder

This builder for chaining.

clearEvaluationDataset()

public RunEvaluationRequest.Builder clearEvaluationDataset()

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
RunEvaluationRequest.Builder

This builder for chaining.

clearEvaluations()

public RunEvaluationRequest.Builder clearEvaluations()

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
RunEvaluationRequest.Builder

This builder for chaining.

clearGenerateLatencyReport()

public RunEvaluationRequest.Builder clearGenerateLatencyReport()

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

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

Returns
Type Description
RunEvaluationRequest.Builder

This builder for chaining.

clearGoldenRunMethod()

public RunEvaluationRequest.Builder clearGoldenRunMethod()

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
RunEvaluationRequest.Builder

This builder for chaining.

clearOptimizationConfig()

public RunEvaluationRequest.Builder clearOptimizationConfig()

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
RunEvaluationRequest.Builder

clearPersonaRunConfigs()

public RunEvaluationRequest.Builder clearPersonaRunConfigs()

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
RunEvaluationRequest.Builder

clearRunCount()

public RunEvaluationRequest.Builder clearRunCount()

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
RunEvaluationRequest.Builder

This builder for chaining.

clearScheduledEvaluationRun()

public RunEvaluationRequest.Builder clearScheduledEvaluationRun()

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
RunEvaluationRequest.Builder

This builder for chaining.

getApp()

public 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 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 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 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 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.

getConfigBuilder()

public EvaluationConfig.Builder getConfigBuilder()

Optional. The configuration to use for the run.

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

Returns
Type Description
EvaluationConfig.Builder

getConfigOrBuilder()

public 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

getDefaultInstanceForType()

public RunEvaluationRequest getDefaultInstanceForType()
Returns
Type Description
RunEvaluationRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getDisplayName()

public 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 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 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 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 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 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 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 ProtocolStringList 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
ProtocolStringList

A list containing the evaluations.

getGenerateLatencyReport()

public 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 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 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 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.

getOptimizationConfigBuilder()

public OptimizationConfig.Builder getOptimizationConfigBuilder()

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.Builder

getOptimizationConfigOrBuilder()

public 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 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

getPersonaRunConfigsBuilder(int index)

public PersonaRunConfig.Builder getPersonaRunConfigsBuilder(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.Builder

getPersonaRunConfigsBuilderList()

public List<PersonaRunConfig.Builder> getPersonaRunConfigsBuilderList()

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<Builder>

getPersonaRunConfigsCount()

public 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 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 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 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 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 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 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 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 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 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.

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeConfig(EvaluationConfig value)

public RunEvaluationRequest.Builder mergeConfig(EvaluationConfig value)

Optional. The configuration to use for the run.

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

Parameter
Name Description
value EvaluationConfig
Returns
Type Description
RunEvaluationRequest.Builder

mergeFrom(RunEvaluationRequest other)

public RunEvaluationRequest.Builder mergeFrom(RunEvaluationRequest other)
Parameter
Name Description
other RunEvaluationRequest
Returns
Type Description
RunEvaluationRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public RunEvaluationRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RunEvaluationRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public RunEvaluationRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
RunEvaluationRequest.Builder
Overrides

mergeOptimizationConfig(OptimizationConfig value)

public RunEvaluationRequest.Builder mergeOptimizationConfig(OptimizationConfig value)

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];

Parameter
Name Description
value OptimizationConfig
Returns
Type Description
RunEvaluationRequest.Builder

removePersonaRunConfigs(int index)

public RunEvaluationRequest.Builder removePersonaRunConfigs(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
RunEvaluationRequest.Builder

setApp(String value)

public RunEvaluationRequest.Builder setApp(String value)

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

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

Parameter
Name Description
value String

The app to set.
Returns
Type Description
RunEvaluationRequest.Builder

This builder for chaining.

setAppBytes(ByteString value)

public RunEvaluationRequest.Builder setAppBytes(ByteString value)

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

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

Parameter
Name Description
value ByteString

The bytes for app to set.
Returns
Type Description
RunEvaluationRequest.Builder

This builder for chaining.

setAppVersion(String value)

public RunEvaluationRequest.Builder setAppVersion(String value)

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) = { ... }

Parameter
Name Description
value String

The appVersion to set.
Returns
Type Description
RunEvaluationRequest.Builder

This builder for chaining.

setAppVersionBytes(ByteString value)

public RunEvaluationRequest.Builder setAppVersionBytes(ByteString value)

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) = { ... }

Parameter
Name Description
value ByteString

The bytes for appVersion to set.
Returns
Type Description
RunEvaluationRequest.Builder

This builder for chaining.

setConfig(EvaluationConfig value)

public RunEvaluationRequest.Builder setConfig(EvaluationConfig value)

Optional. The configuration to use for the run.

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

Parameter
Name Description
value EvaluationConfig
Returns
Type Description
RunEvaluationRequest.Builder

setConfig(EvaluationConfig.Builder builderForValue)

public RunEvaluationRequest.Builder setConfig(EvaluationConfig.Builder builderForValue)

Optional. The configuration to use for the run.

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

Parameter
Name Description
builderForValue EvaluationConfig.Builder
Returns
Type Description
RunEvaluationRequest.Builder

setDisplayName(String value)

public RunEvaluationRequest.Builder setDisplayName(String value)

Optional. The display name of the evaluation run.

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

Parameter
Name Description
value String

The displayName to set.
Returns
Type Description
RunEvaluationRequest.Builder

This builder for chaining.

setDisplayNameBytes(ByteString value)

public RunEvaluationRequest.Builder setDisplayNameBytes(ByteString value)

Optional. The display name of the evaluation run.

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

Parameter
Name Description
value ByteString

The bytes for displayName to set.
Returns
Type Description
RunEvaluationRequest.Builder

This builder for chaining.

setEvaluationDataset(String value)

public RunEvaluationRequest.Builder setEvaluationDataset(String value)

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) = { ... }

Parameter
Name Description
value String

The evaluationDataset to set.
Returns
Type Description
RunEvaluationRequest.Builder

This builder for chaining.

setEvaluationDatasetBytes(ByteString value)

public RunEvaluationRequest.Builder setEvaluationDatasetBytes(ByteString value)

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) = { ... }

Parameter
Name Description
value ByteString

The bytes for evaluationDataset to set.
Returns
Type Description
RunEvaluationRequest.Builder

This builder for chaining.

setEvaluations(int index, String value)

public RunEvaluationRequest.Builder setEvaluations(int index, String value)

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) = { ... }

Parameters
Name Description
index int

The index to set the value at.
value String

The evaluations to set.
Returns
Type Description
RunEvaluationRequest.Builder

This builder for chaining.

setGenerateLatencyReport(boolean value)

public RunEvaluationRequest.Builder setGenerateLatencyReport(boolean value)

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

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

Parameter
Name Description
value boolean

The generateLatencyReport to set.
Returns
Type Description
RunEvaluationRequest.Builder

This builder for chaining.

setGoldenRunMethod(GoldenRunMethod value)

public RunEvaluationRequest.Builder setGoldenRunMethod(GoldenRunMethod value)

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];

Parameter
Name Description
value GoldenRunMethod

The goldenRunMethod to set.
Returns
Type Description
RunEvaluationRequest.Builder

This builder for chaining.

setGoldenRunMethodValue(int value)

public RunEvaluationRequest.Builder setGoldenRunMethodValue(int value)

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];

Parameter
Name Description
value int

The enum numeric value on the wire for goldenRunMethod to set.
Returns
Type Description
RunEvaluationRequest.Builder

This builder for chaining.

setOptimizationConfig(OptimizationConfig value)

public RunEvaluationRequest.Builder setOptimizationConfig(OptimizationConfig value)

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];

Parameter
Name Description
value OptimizationConfig
Returns
Type Description
RunEvaluationRequest.Builder

setOptimizationConfig(OptimizationConfig.Builder builderForValue)

public RunEvaluationRequest.Builder setOptimizationConfig(OptimizationConfig.Builder builderForValue)

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];

Parameter
Name Description
builderForValue OptimizationConfig.Builder
Returns
Type Description
RunEvaluationRequest.Builder

setPersonaRunConfigs(int index, PersonaRunConfig value)

public RunEvaluationRequest.Builder setPersonaRunConfigs(int index, PersonaRunConfig value)

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];

Parameters
Name Description
index int
value PersonaRunConfig
Returns
Type Description
RunEvaluationRequest.Builder

setPersonaRunConfigs(int index, PersonaRunConfig.Builder builderForValue)

public RunEvaluationRequest.Builder setPersonaRunConfigs(int index, PersonaRunConfig.Builder builderForValue)

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];

Parameters
Name Description
index int
builderForValue PersonaRunConfig.Builder
Returns
Type Description
RunEvaluationRequest.Builder

setRunCount(int value)

public RunEvaluationRequest.Builder setRunCount(int value)

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];

Parameter
Name Description
value int

The runCount to set.
Returns
Type Description
RunEvaluationRequest.Builder

This builder for chaining.

setScheduledEvaluationRun(String value)

public RunEvaluationRequest.Builder setScheduledEvaluationRun(String value)

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) = { ... }

Parameter
Name Description
value String

The scheduledEvaluationRun to set.
Returns
Type Description
RunEvaluationRequest.Builder

This builder for chaining.

setScheduledEvaluationRunBytes(ByteString value)

public RunEvaluationRequest.Builder setScheduledEvaluationRunBytes(ByteString value)

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) = { ... }

Parameter
Name Description
value ByteString

The bytes for scheduledEvaluationRun to set.
Returns
Type Description
RunEvaluationRequest.Builder

This builder for chaining.