Class OptimizationConfig.Builder (0.3.0)

public static final class OptimizationConfig.Builder extends GeneratedMessage.Builder<OptimizationConfig.Builder> implements OptimizationConfigOrBuilder

Configuration for running the optimization step after the evaluation run.

Protobuf type google.cloud.ces.v1beta.OptimizationConfig

Static Methods

getDescriptor()

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

Methods

build()

public OptimizationConfig build()
Returns
Type Description
OptimizationConfig

buildPartial()

public OptimizationConfig buildPartial()
Returns
Type Description
OptimizationConfig

clear()

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

clearAssistantSession()

public OptimizationConfig.Builder clearAssistantSession()

Output only. The assistant session to use for the optimization based on this evaluation run. Format: projects/{project}/locations/{location}/apps/{app}/assistantSessions/{assistantSession}

string assistant_session = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
OptimizationConfig.Builder

This builder for chaining.

clearErrorMessage()

public OptimizationConfig.Builder clearErrorMessage()

Output only. The error message if the optimization run failed.

string error_message = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
OptimizationConfig.Builder

This builder for chaining.

clearGenerateLossReport()

public OptimizationConfig.Builder clearGenerateLossReport()

Optional. Whether to generate a loss report.

bool generate_loss_report = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
OptimizationConfig.Builder

This builder for chaining.

clearLossReport()

public OptimizationConfig.Builder clearLossReport()

Output only. The generated loss report.

.google.protobuf.Struct loss_report = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
OptimizationConfig.Builder

clearReportSummary()

public OptimizationConfig.Builder clearReportSummary()

Output only. The summary of the loss report.

string report_summary = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
OptimizationConfig.Builder

This builder for chaining.

clearShouldSuggestFix()

public OptimizationConfig.Builder clearShouldSuggestFix()

Output only. Whether to suggest a fix for the losses.

bool should_suggest_fix = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
OptimizationConfig.Builder

This builder for chaining.

clearStatus()

public OptimizationConfig.Builder clearStatus()

Output only. The status of the optimization run.

.google.cloud.ces.v1beta.OptimizationConfig.OptimizationStatus status = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
OptimizationConfig.Builder

This builder for chaining.

getAssistantSession()

public String getAssistantSession()

Output only. The assistant session to use for the optimization based on this evaluation run. Format: projects/{project}/locations/{location}/apps/{app}/assistantSessions/{assistantSession}

string assistant_session = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The assistantSession.

getAssistantSessionBytes()

public ByteString getAssistantSessionBytes()

Output only. The assistant session to use for the optimization based on this evaluation run. Format: projects/{project}/locations/{location}/apps/{app}/assistantSessions/{assistantSession}

string assistant_session = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for assistantSession.

getDefaultInstanceForType()

public OptimizationConfig getDefaultInstanceForType()
Returns
Type Description
OptimizationConfig

getDescriptorForType()

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

getErrorMessage()

public String getErrorMessage()

Output only. The error message if the optimization run failed.

string error_message = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The errorMessage.

getErrorMessageBytes()

public ByteString getErrorMessageBytes()

Output only. The error message if the optimization run failed.

string error_message = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for errorMessage.

getGenerateLossReport()

public boolean getGenerateLossReport()

Optional. Whether to generate a loss report.

bool generate_loss_report = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The generateLossReport.

getLossReport()

public Struct getLossReport()

Output only. The generated loss report.

.google.protobuf.Struct loss_report = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Struct

The lossReport.

getLossReportBuilder()

public Struct.Builder getLossReportBuilder()

Output only. The generated loss report.

.google.protobuf.Struct loss_report = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Builder

getLossReportOrBuilder()

public StructOrBuilder getLossReportOrBuilder()

Output only. The generated loss report.

.google.protobuf.Struct loss_report = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
StructOrBuilder

getReportSummary()

public String getReportSummary()

Output only. The summary of the loss report.

string report_summary = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The reportSummary.

getReportSummaryBytes()

public ByteString getReportSummaryBytes()

Output only. The summary of the loss report.

string report_summary = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for reportSummary.

getShouldSuggestFix()

public boolean getShouldSuggestFix()

Output only. Whether to suggest a fix for the losses.

bool should_suggest_fix = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

The shouldSuggestFix.

getStatus()

public OptimizationConfig.OptimizationStatus getStatus()

Output only. The status of the optimization run.

.google.cloud.ces.v1beta.OptimizationConfig.OptimizationStatus status = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
OptimizationConfig.OptimizationStatus

The status.

getStatusValue()

public int getStatusValue()

Output only. The status of the optimization run.

.google.cloud.ces.v1beta.OptimizationConfig.OptimizationStatus status = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for status.

hasLossReport()

public boolean hasLossReport()

Output only. The generated loss report.

.google.protobuf.Struct loss_report = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the lossReport field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(OptimizationConfig other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeLossReport(Struct value)

public OptimizationConfig.Builder mergeLossReport(Struct value)

Output only. The generated loss report.

.google.protobuf.Struct loss_report = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Struct
Returns
Type Description
OptimizationConfig.Builder

setAssistantSession(String value)

public OptimizationConfig.Builder setAssistantSession(String value)

Output only. The assistant session to use for the optimization based on this evaluation run. Format: projects/{project}/locations/{location}/apps/{app}/assistantSessions/{assistantSession}

string assistant_session = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The assistantSession to set.

Returns
Type Description
OptimizationConfig.Builder

This builder for chaining.

setAssistantSessionBytes(ByteString value)

public OptimizationConfig.Builder setAssistantSessionBytes(ByteString value)

Output only. The assistant session to use for the optimization based on this evaluation run. Format: projects/{project}/locations/{location}/apps/{app}/assistantSessions/{assistantSession}

string assistant_session = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes for assistantSession to set.

Returns
Type Description
OptimizationConfig.Builder

This builder for chaining.

setErrorMessage(String value)

public OptimizationConfig.Builder setErrorMessage(String value)

Output only. The error message if the optimization run failed.

string error_message = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The errorMessage to set.

Returns
Type Description
OptimizationConfig.Builder

This builder for chaining.

setErrorMessageBytes(ByteString value)

public OptimizationConfig.Builder setErrorMessageBytes(ByteString value)

Output only. The error message if the optimization run failed.

string error_message = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes for errorMessage to set.

Returns
Type Description
OptimizationConfig.Builder

This builder for chaining.

setGenerateLossReport(boolean value)

public OptimizationConfig.Builder setGenerateLossReport(boolean value)

Optional. Whether to generate a loss report.

bool generate_loss_report = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value boolean

The generateLossReport to set.

Returns
Type Description
OptimizationConfig.Builder

This builder for chaining.

setLossReport(Struct value)

public OptimizationConfig.Builder setLossReport(Struct value)

Output only. The generated loss report.

.google.protobuf.Struct loss_report = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Struct
Returns
Type Description
OptimizationConfig.Builder

setLossReport(Struct.Builder builderForValue)

public OptimizationConfig.Builder setLossReport(Struct.Builder builderForValue)

Output only. The generated loss report.

.google.protobuf.Struct loss_report = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
OptimizationConfig.Builder

setReportSummary(String value)

public OptimizationConfig.Builder setReportSummary(String value)

Output only. The summary of the loss report.

string report_summary = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The reportSummary to set.

Returns
Type Description
OptimizationConfig.Builder

This builder for chaining.

setReportSummaryBytes(ByteString value)

public OptimizationConfig.Builder setReportSummaryBytes(ByteString value)

Output only. The summary of the loss report.

string report_summary = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes for reportSummary to set.

Returns
Type Description
OptimizationConfig.Builder

This builder for chaining.

setShouldSuggestFix(boolean value)

public OptimizationConfig.Builder setShouldSuggestFix(boolean value)

Output only. Whether to suggest a fix for the losses.

bool should_suggest_fix = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value boolean

The shouldSuggestFix to set.

Returns
Type Description
OptimizationConfig.Builder

This builder for chaining.

setStatus(OptimizationConfig.OptimizationStatus value)

public OptimizationConfig.Builder setStatus(OptimizationConfig.OptimizationStatus value)

Output only. The status of the optimization run.

.google.cloud.ces.v1beta.OptimizationConfig.OptimizationStatus status = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value OptimizationConfig.OptimizationStatus

The status to set.

Returns
Type Description
OptimizationConfig.Builder

This builder for chaining.

setStatusValue(int value)

public OptimizationConfig.Builder setStatusValue(int value)

Output only. The status of the optimization run.

.google.cloud.ces.v1beta.OptimizationConfig.OptimizationStatus status = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value int

The enum numeric value on the wire for status to set.

Returns
Type Description
OptimizationConfig.Builder

This builder for chaining.