Class OptimizationConfig (0.3.0)

public final class OptimizationConfig extends GeneratedMessage implements OptimizationConfigOrBuilder

Configuration for running the optimization step after the evaluation run.

Protobuf type google.cloud.ces.v1beta.OptimizationConfig

Static Fields

ASSISTANT_SESSION_FIELD_NUMBER

public static final int ASSISTANT_SESSION_FIELD_NUMBER
Field Value
Type Description
int

ERROR_MESSAGE_FIELD_NUMBER

public static final int ERROR_MESSAGE_FIELD_NUMBER
Field Value
Type Description
int

GENERATE_LOSS_REPORT_FIELD_NUMBER

public static final int GENERATE_LOSS_REPORT_FIELD_NUMBER
Field Value
Type Description
int

LOSS_REPORT_FIELD_NUMBER

public static final int LOSS_REPORT_FIELD_NUMBER
Field Value
Type Description
int

REPORT_SUMMARY_FIELD_NUMBER

public static final int REPORT_SUMMARY_FIELD_NUMBER
Field Value
Type Description
int

SHOULD_SUGGEST_FIX_FIELD_NUMBER

public static final int SHOULD_SUGGEST_FIX_FIELD_NUMBER
Field Value
Type Description
int

STATUS_FIELD_NUMBER

public static final int STATUS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static OptimizationConfig getDefaultInstance()
Returns
Type Description
OptimizationConfig

getDescriptor()

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

newBuilder()

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

newBuilder(OptimizationConfig prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

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

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.

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

getParserForType()

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

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.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

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 OptimizationConfig.Builder newBuilderForType()
Returns
Type Description
OptimizationConfig.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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