Interface EvaluationRunOrBuilder (0.3.0)

public interface EvaluationRunOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsEvaluationRunSummaries(String key)

public abstract boolean containsEvaluationRunSummaries(String key)

Output only. Map of evaluation name to EvaluationRunSummary.

map<string, .google.cloud.ces.v1beta.EvaluationRun.EvaluationRunSummary> evaluation_run_summaries = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
key String
Returns
Type Description
boolean

getAppVersion()

public abstract String getAppVersion()

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

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

Returns
Type Description
String

The appVersion.

getAppVersionBytes()

public abstract ByteString getAppVersionBytes()

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

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

Returns
Type Description
ByteString

The bytes for appVersion.

getAppVersionDisplayName()

public abstract String getAppVersionDisplayName()

Output only. The display name of the app_version that the evaluation ran against.

string app_version_display_name = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The appVersionDisplayName.

getAppVersionDisplayNameBytes()

public abstract ByteString getAppVersionDisplayNameBytes()

Output only. The display name of the app_version that the evaluation ran against.

string app_version_display_name = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for appVersionDisplayName.

getChangelog()

public abstract String getChangelog()

Output only. The changelog of the app version that the evaluation ran against. This is populated if user runs evaluation on latest/draft.

string changelog = 22 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The changelog.

getChangelogBytes()

public abstract ByteString getChangelogBytes()

Output only. The changelog of the app version that the evaluation ran against. This is populated if user runs evaluation on latest/draft.

string changelog = 22 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for changelog.

getChangelogCreateTime()

public abstract Timestamp getChangelogCreateTime()

Output only. The create time of the changelog of the app version that the evaluation ran against. This is populated if user runs evaluation on latest/draft.

.google.protobuf.Timestamp changelog_create_time = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The changelogCreateTime.

getChangelogCreateTimeOrBuilder()

public abstract TimestampOrBuilder getChangelogCreateTimeOrBuilder()

Output only. The create time of the changelog of the app version that the evaluation ran against. This is populated if user runs evaluation on latest/draft.

.google.protobuf.Timestamp changelog_create_time = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getConfig()

public abstract EvaluationConfig getConfig()

Output only. The configuration used in the run.

.google.cloud.ces.v1beta.EvaluationConfig config = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
EvaluationConfig

The config.

getConfigOrBuilder()

public abstract EvaluationConfigOrBuilder getConfigOrBuilder()

Output only. The configuration used in the run.

.google.cloud.ces.v1beta.EvaluationConfig config = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
EvaluationConfigOrBuilder

getCreateTime()

public abstract Timestamp getCreateTime()

Output only. Timestamp when the evaluation run was created.

.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public abstract TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Timestamp when the evaluation run was created.

.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getDisplayName()

public abstract String getDisplayName()

Optional. User-defined display name of the evaluation run. default: "<evaluation-dataset-display-name> run - <timestamp>".

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

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public abstract ByteString getDisplayNameBytes()

Optional. User-defined display name of the evaluation run. default: "<evaluation-dataset-display-name> run - <timestamp>".

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

Returns
Type Description
ByteString

The bytes for displayName.

getError() (deprecated)

public abstract Status getError()

Deprecated. google.cloud.ces.v1beta.EvaluationRun.error is deprecated. See google/cloud/ces/v1beta/evaluation.proto;l=1206

Output only. Deprecated: Use error_info instead. Errors encountered during execution.

.google.rpc.Status error = 14 [deprecated = true, (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
com.google.rpc.Status

The error.

getErrorInfo()

public abstract EvaluationErrorInfo getErrorInfo()

Output only. Error information for the evaluation run.

.google.cloud.ces.v1beta.EvaluationErrorInfo error_info = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
EvaluationErrorInfo

The errorInfo.

getErrorInfoOrBuilder()

public abstract EvaluationErrorInfoOrBuilder getErrorInfoOrBuilder()

Output only. Error information for the evaluation run.

.google.cloud.ces.v1beta.EvaluationErrorInfo error_info = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
EvaluationErrorInfoOrBuilder

getErrorOrBuilder() (deprecated)

public abstract StatusOrBuilder getErrorOrBuilder()

Output only. Deprecated: Use error_info instead. Errors encountered during execution.

.google.rpc.Status error = 14 [deprecated = true, (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
com.google.rpc.StatusOrBuilder

getEvaluationDataset()

public abstract String getEvaluationDataset()

Output only. The evaluation dataset that this run is associated with. This field is mutually exclusive with evaluations. Format: projects/{project}/locations/{location}/apps/{app}/evaluationDatasets/{evaluationDataset}

string evaluation_dataset = 8 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The evaluationDataset.

getEvaluationDatasetBytes()

public abstract ByteString getEvaluationDatasetBytes()

Output only. The evaluation dataset that this run is associated with. This field is mutually exclusive with evaluations. Format: projects/{project}/locations/{location}/apps/{app}/evaluationDatasets/{evaluationDataset}

string evaluation_dataset = 8 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for evaluationDataset.

getEvaluationResults(int index)

public abstract String getEvaluationResults(int index)

Output only. The evaluation results that are part of this run. Format: projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}/results/{result}

repeated string evaluation_results = 3 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The evaluationResults at the given index.

getEvaluationResultsBytes(int index)

public abstract ByteString getEvaluationResultsBytes(int index)

Output only. The evaluation results that are part of this run. Format: projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}/results/{result}

repeated string evaluation_results = 3 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the evaluationResults at the given index.

getEvaluationResultsCount()

public abstract int getEvaluationResultsCount()

Output only. The evaluation results that are part of this run. Format: projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}/results/{result}

repeated string evaluation_results = 3 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
int

The count of evaluationResults.

getEvaluationResultsList()

public abstract List<String> getEvaluationResultsList()

Output only. The evaluation results that are part of this run. Format: projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}/results/{result}

repeated string evaluation_results = 3 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
List<String>

A list containing the evaluationResults.

getEvaluationRunSummaries() (deprecated)

public abstract Map<String,EvaluationRun.EvaluationRunSummary> getEvaluationRunSummaries()
Returns
Type Description
Map<String,EvaluationRunSummary>

getEvaluationRunSummariesCount()

public abstract int getEvaluationRunSummariesCount()

Output only. Map of evaluation name to EvaluationRunSummary.

map<string, .google.cloud.ces.v1beta.EvaluationRun.EvaluationRunSummary> evaluation_run_summaries = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

getEvaluationRunSummariesMap()

public abstract Map<String,EvaluationRun.EvaluationRunSummary> getEvaluationRunSummariesMap()

Output only. Map of evaluation name to EvaluationRunSummary.

map<string, .google.cloud.ces.v1beta.EvaluationRun.EvaluationRunSummary> evaluation_run_summaries = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Map<String,EvaluationRunSummary>

getEvaluationRunSummariesOrDefault(String key, EvaluationRun.EvaluationRunSummary defaultValue)

public abstract EvaluationRun.EvaluationRunSummary getEvaluationRunSummariesOrDefault(String key, EvaluationRun.EvaluationRunSummary defaultValue)

Output only. Map of evaluation name to EvaluationRunSummary.

map<string, .google.cloud.ces.v1beta.EvaluationRun.EvaluationRunSummary> evaluation_run_summaries = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name Description
key String
defaultValue EvaluationRun.EvaluationRunSummary
Returns
Type Description
EvaluationRun.EvaluationRunSummary

getEvaluationRunSummariesOrThrow(String key)

public abstract EvaluationRun.EvaluationRunSummary getEvaluationRunSummariesOrThrow(String key)

Output only. Map of evaluation name to EvaluationRunSummary.

map<string, .google.cloud.ces.v1beta.EvaluationRun.EvaluationRunSummary> evaluation_run_summaries = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
key String
Returns
Type Description
EvaluationRun.EvaluationRunSummary

getEvaluationType()

public abstract EvaluationRun.EvaluationType getEvaluationType()

Output only. The type of the evaluations in this run.

.google.cloud.ces.v1beta.EvaluationRun.EvaluationType evaluation_type = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
EvaluationRun.EvaluationType

The evaluationType.

getEvaluationTypeValue()

public abstract int getEvaluationTypeValue()

Output only. The type of the evaluations in this run.

.google.cloud.ces.v1beta.EvaluationRun.EvaluationType evaluation_type = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for evaluationType.

getEvaluations(int index)

public abstract String getEvaluations(int index)

Output only. The evaluations that are part of this run. The list may contain evaluations of either type. This field is mutually exclusive with evaluation_dataset. Format: projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}

repeated string evaluations = 7 [(.google.api.field_behavior) = OUTPUT_ONLY, (.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)

Output only. The evaluations that are part of this run. The list may contain evaluations of either type. This field is mutually exclusive with evaluation_dataset. Format: projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}

repeated string evaluations = 7 [(.google.api.field_behavior) = OUTPUT_ONLY, (.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()

Output only. The evaluations that are part of this run. The list may contain evaluations of either type. This field is mutually exclusive with evaluation_dataset. Format: projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}

repeated string evaluations = 7 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
int

The count of evaluations.

getEvaluationsList()

public abstract List<String> getEvaluationsList()

Output only. The evaluations that are part of this run. The list may contain evaluations of either type. This field is mutually exclusive with evaluation_dataset. Format: projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}

repeated string evaluations = 7 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
List<String>

A list containing the evaluations.

getGoldenRunMethod()

public abstract GoldenRunMethod getGoldenRunMethod()

Output only. The method used to run the evaluation.

.google.cloud.ces.v1beta.GoldenRunMethod golden_run_method = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
GoldenRunMethod

The goldenRunMethod.

getGoldenRunMethodValue()

public abstract int getGoldenRunMethodValue()

Output only. The method used to run the evaluation.

.google.cloud.ces.v1beta.GoldenRunMethod golden_run_method = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for goldenRunMethod.

getInitiatedBy()

public abstract String getInitiatedBy()

Output only. The user who initiated the evaluation run.

string initiated_by = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The initiatedBy.

getInitiatedByBytes()

public abstract ByteString getInitiatedByBytes()

Output only. The user who initiated the evaluation run.

string initiated_by = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for initiatedBy.

getLatencyReport()

public abstract LatencyReport getLatencyReport()

Output only. Latency report for the evaluation run.

.google.cloud.ces.v1beta.LatencyReport latency_report = 25 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
LatencyReport

The latencyReport.

getLatencyReportOrBuilder()

public abstract LatencyReportOrBuilder getLatencyReportOrBuilder()

Output only. Latency report for the evaluation run.

.google.cloud.ces.v1beta.LatencyReport latency_report = 25 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
LatencyReportOrBuilder

getName()

public abstract String getName()

Identifier. The unique identifier of the evaluation run. Format: projects/{project}/locations/{location}/apps/{app}/evaluationRuns/{evaluationRun}

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
String

The name.

getNameBytes()

public abstract ByteString getNameBytes()

Identifier. The unique identifier of the evaluation run. Format: projects/{project}/locations/{location}/apps/{app}/evaluationRuns/{evaluationRun}

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
ByteString

The bytes for name.

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 = 19 [(.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 = 19 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
OptimizationConfigOrBuilder

getPersonaRunConfigs(int index)

public abstract PersonaRunConfig getPersonaRunConfigs(int index)

Output only. The configuration to use for the run per persona.

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

Parameter
Name Description
index int
Returns
Type Description
PersonaRunConfig

getPersonaRunConfigsCount()

public abstract int getPersonaRunConfigsCount()

Output only. The configuration to use for the run per persona.

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

Returns
Type Description
int

getPersonaRunConfigsList()

public abstract List<PersonaRunConfig> getPersonaRunConfigsList()

Output only. The configuration to use for the run per persona.

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

Returns
Type Description
List<PersonaRunConfig>

getPersonaRunConfigsOrBuilder(int index)

public abstract PersonaRunConfigOrBuilder getPersonaRunConfigsOrBuilder(int index)

Output only. The configuration to use for the run per persona.

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

Parameter
Name Description
index int
Returns
Type Description
PersonaRunConfigOrBuilder

getPersonaRunConfigsOrBuilderList()

public abstract List<? extends PersonaRunConfigOrBuilder> getPersonaRunConfigsOrBuilderList()

Output only. The configuration to use for the run per persona.

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

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

getProgress()

public abstract EvaluationRun.Progress getProgress()

Output only. The progress of the evaluation run.

.google.cloud.ces.v1beta.EvaluationRun.Progress progress = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
EvaluationRun.Progress

The progress.

getProgressOrBuilder()

public abstract EvaluationRun.ProgressOrBuilder getProgressOrBuilder()

Output only. The progress of the evaluation run.

.google.cloud.ces.v1beta.EvaluationRun.Progress progress = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
EvaluationRun.ProgressOrBuilder

getRunCount()

public abstract int getRunCount()

Output only. The number of times the evaluations inside the run were run.

int32 run_count = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The runCount.

getScheduledEvaluationRun()

public abstract String getScheduledEvaluationRun()

Output only. The scheduled evaluation run resource name that created this evaluation run. This field is only set if the evaluation run was created by a scheduled evaluation run. Format: projects/{project}/locations/{location}/apps/{app}/scheduledEvaluationRuns/{scheduled_evaluation_run}

string scheduled_evaluation_run = 20 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The scheduledEvaluationRun.

getScheduledEvaluationRunBytes()

public abstract ByteString getScheduledEvaluationRunBytes()

Output only. The scheduled evaluation run resource name that created this evaluation run. This field is only set if the evaluation run was created by a scheduled evaluation run. Format: projects/{project}/locations/{location}/apps/{app}/scheduledEvaluationRuns/{scheduled_evaluation_run}

string scheduled_evaluation_run = 20 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for scheduledEvaluationRun.

getState()

public abstract EvaluationRun.EvaluationRunState getState()

Output only. The state of the evaluation run.

.google.cloud.ces.v1beta.EvaluationRun.EvaluationRunState state = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
EvaluationRun.EvaluationRunState

The state.

getStateValue()

public abstract int getStateValue()

Output only. The state of the evaluation run.

.google.cloud.ces.v1beta.EvaluationRun.EvaluationRunState state = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for state.

hasChangelogCreateTime()

public abstract boolean hasChangelogCreateTime()

Output only. The create time of the changelog of the app version that the evaluation ran against. This is populated if user runs evaluation on latest/draft.

.google.protobuf.Timestamp changelog_create_time = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the changelogCreateTime field is set.

hasConfig()

public abstract boolean hasConfig()

Output only. The configuration used in the run.

.google.cloud.ces.v1beta.EvaluationConfig config = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the config field is set.

hasCreateTime()

public abstract boolean hasCreateTime()

Output only. Timestamp when the evaluation run was created.

.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the createTime field is set.

hasError() (deprecated)

public abstract boolean hasError()

Deprecated. google.cloud.ces.v1beta.EvaluationRun.error is deprecated. See google/cloud/ces/v1beta/evaluation.proto;l=1206

Output only. Deprecated: Use error_info instead. Errors encountered during execution.

.google.rpc.Status error = 14 [deprecated = true, (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the error field is set.

hasErrorInfo()

public abstract boolean hasErrorInfo()

Output only. Error information for the evaluation run.

.google.cloud.ces.v1beta.EvaluationErrorInfo error_info = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the errorInfo field is set.

hasLatencyReport()

public abstract boolean hasLatencyReport()

Output only. Latency report for the evaluation run.

.google.cloud.ces.v1beta.LatencyReport latency_report = 25 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the latencyReport 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 = 19 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the optimizationConfig field is set.

hasProgress()

public abstract boolean hasProgress()

Output only. The progress of the evaluation run.

.google.cloud.ces.v1beta.EvaluationRun.Progress progress = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the progress field is set.