Class RunEvaluationRequest (0.3.0)

public final class RunEvaluationRequest extends GeneratedMessage implements RunEvaluationRequestOrBuilder

Request message for EvaluationService.RunEvaluation.

Protobuf type google.cloud.ces.v1beta.RunEvaluationRequest

Static Fields

APP_FIELD_NUMBER

public static final int APP_FIELD_NUMBER
Field Value
Type Description
int

APP_VERSION_FIELD_NUMBER

public static final int APP_VERSION_FIELD_NUMBER
Field Value
Type Description
int

CONFIG_FIELD_NUMBER

public static final int CONFIG_FIELD_NUMBER
Field Value
Type Description
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int

EVALUATIONS_FIELD_NUMBER

public static final int EVALUATIONS_FIELD_NUMBER
Field Value
Type Description
int

EVALUATION_DATASET_FIELD_NUMBER

public static final int EVALUATION_DATASET_FIELD_NUMBER
Field Value
Type Description
int

GENERATE_LATENCY_REPORT_FIELD_NUMBER

public static final int GENERATE_LATENCY_REPORT_FIELD_NUMBER
Field Value
Type Description
int

GOLDEN_RUN_METHOD_FIELD_NUMBER

public static final int GOLDEN_RUN_METHOD_FIELD_NUMBER
Field Value
Type Description
int

OPTIMIZATION_CONFIG_FIELD_NUMBER

public static final int OPTIMIZATION_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

PERSONA_RUN_CONFIGS_FIELD_NUMBER

public static final int PERSONA_RUN_CONFIGS_FIELD_NUMBER
Field Value
Type Description
int

RUN_COUNT_FIELD_NUMBER

public static final int RUN_COUNT_FIELD_NUMBER
Field Value
Type Description
int

SCHEDULED_EVALUATION_RUN_FIELD_NUMBER

public static final int SCHEDULED_EVALUATION_RUN_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static RunEvaluationRequest getDefaultInstance()
Returns
Type Description
RunEvaluationRequest

getDescriptor()

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

newBuilder()

public static RunEvaluationRequest.Builder newBuilder()
Returns
Type Description
RunEvaluationRequest.Builder

newBuilder(RunEvaluationRequest prototype)

public static RunEvaluationRequest.Builder newBuilder(RunEvaluationRequest prototype)
Parameter
Name Description
prototype RunEvaluationRequest
Returns
Type Description
RunEvaluationRequest.Builder

parseDelimitedFrom(InputStream input)

public static RunEvaluationRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
RunEvaluationRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RunEvaluationRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RunEvaluationRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static RunEvaluationRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
RunEvaluationRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static RunEvaluationRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RunEvaluationRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static RunEvaluationRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
RunEvaluationRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static RunEvaluationRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RunEvaluationRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static RunEvaluationRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
RunEvaluationRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static RunEvaluationRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RunEvaluationRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static RunEvaluationRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
RunEvaluationRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RunEvaluationRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RunEvaluationRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static RunEvaluationRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
RunEvaluationRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static RunEvaluationRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RunEvaluationRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<RunEvaluationRequest> parser()
Returns
Type Description
Parser<RunEvaluationRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

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.

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

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.

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

getParserForType()

public Parser<RunEvaluationRequest> getParserForType()
Returns
Type Description
Parser<RunEvaluationRequest>
Overrides

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

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.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public RunEvaluationRequest.Builder newBuilderForType()
Returns
Type Description
RunEvaluationRequest.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected RunEvaluationRequest.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
RunEvaluationRequest.Builder
Overrides

toBuilder()

public RunEvaluationRequest.Builder toBuilder()
Returns
Type Description
RunEvaluationRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException