public final class RunEvaluationRequest extends GeneratedMessage implements RunEvaluationRequestOrBuilder
Request message for
EvaluationService.RunEvaluation.
Protobuf type google.cloud.ces.v1beta.RunEvaluationRequest
Inherited Members
com.google.protobuf.GeneratedMessage.<ContainingT,T>newFileScopedGeneratedExtension(java.lang.Class<?>,com.google.protobuf.Message)
com.google.protobuf.GeneratedMessage.<ContainingT,T>newMessageScopedGeneratedExtension(com.google.protobuf.Message,int,java.lang.Class<?>,com.google.protobuf.Message)
com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessage.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessage.<V>serializeBooleanMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Boolean,V>,com.google.protobuf.MapEntry<java.lang.Boolean,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeIntegerMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Integer,V>,com.google.protobuf.MapEntry<java.lang.Integer,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeLongMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Long,V>,com.google.protobuf.MapEntry<java.lang.Long,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeStringMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.String,V>,com.google.protobuf.MapEntry<java.lang.String,V>,int)
com.google.protobuf.GeneratedMessage.canUseUnsafe()
com.google.protobuf.GeneratedMessage.emptyBooleanList()
com.google.protobuf.GeneratedMessage.emptyDoubleList()
com.google.protobuf.GeneratedMessage.emptyFloatList()
com.google.protobuf.GeneratedMessage.emptyIntList()
com.google.protobuf.GeneratedMessage.emptyLongList()
com.google.protobuf.GeneratedMessage.internalGetMapFieldReflection(int)
com.google.protobuf.GeneratedMessage.isStringEmpty(java.lang.Object)
com.google.protobuf.GeneratedMessage.mergeFromAndMakeImmutableInternal(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite)
com.google.protobuf.GeneratedMessage.newInstance(com.google.protobuf.GeneratedMessage.UnusedPrivateParameter)
com.google.protobuf.GeneratedMessage.parseUnknownFieldProto3(com.google.protobuf.CodedInputStream,com.google.protobuf.UnknownFieldSet.Builder,com.google.protobuf.ExtensionRegistryLite,int)
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()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static RunEvaluationRequest.Builder newBuilder()
newBuilder(RunEvaluationRequest prototype)
public static RunEvaluationRequest.Builder newBuilder(RunEvaluationRequest prototype)
public static RunEvaluationRequest parseDelimitedFrom(InputStream input)
public static RunEvaluationRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static RunEvaluationRequest parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static RunEvaluationRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static RunEvaluationRequest parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static RunEvaluationRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static RunEvaluationRequest parseFrom(CodedInputStream input)
public static RunEvaluationRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static RunEvaluationRequest parseFrom(InputStream input)
public static RunEvaluationRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static RunEvaluationRequest parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static RunEvaluationRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<RunEvaluationRequest> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
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];
getConfigOrBuilder()
public EvaluationConfigOrBuilder getConfigOrBuilder()
Optional. The configuration to use for the run.
.google.cloud.ces.v1beta.EvaluationConfig config = 8 [(.google.api.field_behavior) = OPTIONAL];
getDefaultInstanceForType()
public RunEvaluationRequest getDefaultInstanceForType()
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) = { ... }
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];
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];
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];
getParserForType()
public Parser<RunEvaluationRequest> getParserForType()
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
|
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];
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
|
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()
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()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public RunEvaluationRequest.Builder newBuilderForType()
newBuilderForType(AbstractMessage.BuilderParent parent)
protected RunEvaluationRequest.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Overrides
toBuilder()
public RunEvaluationRequest.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
