Class TablesAnnotation.Builder (2.45.0)

public static final class TablesAnnotation.Builder extends GeneratedMessageV3.Builder<TablesAnnotation.Builder> implements TablesAnnotationOrBuilder

Contains annotation details specific to Tables.

Protobuf type google.cloud.automl.v1beta1.TablesAnnotation

Static Methods

getDescriptor()

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

Methods

addAllTablesModelColumnInfo(Iterable<? extends TablesModelColumnInfo> values)

public TablesAnnotation.Builder addAllTablesModelColumnInfo(Iterable<? extends TablesModelColumnInfo> values)

Output only. Auxiliary information for each of the model's

input_feature_column_specs with respect to this particular prediction. If no other fields than

column_spec_name and

column_display_name would be populated, then this whole field is not.

repeated .google.cloud.automl.v1beta1.TablesModelColumnInfo tables_model_column_info = 3;

Parameter
Name Description
values Iterable<? extends com.google.cloud.automl.v1beta1.TablesModelColumnInfo>
Returns
Type Description
TablesAnnotation.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public TablesAnnotation.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
TablesAnnotation.Builder
Overrides

addTablesModelColumnInfo(TablesModelColumnInfo value)

public TablesAnnotation.Builder addTablesModelColumnInfo(TablesModelColumnInfo value)

Output only. Auxiliary information for each of the model's

input_feature_column_specs with respect to this particular prediction. If no other fields than

column_spec_name and

column_display_name would be populated, then this whole field is not.

repeated .google.cloud.automl.v1beta1.TablesModelColumnInfo tables_model_column_info = 3;

Parameter
Name Description
value TablesModelColumnInfo
Returns
Type Description
TablesAnnotation.Builder

addTablesModelColumnInfo(TablesModelColumnInfo.Builder builderForValue)

public TablesAnnotation.Builder addTablesModelColumnInfo(TablesModelColumnInfo.Builder builderForValue)

Output only. Auxiliary information for each of the model's

input_feature_column_specs with respect to this particular prediction. If no other fields than

column_spec_name and

column_display_name would be populated, then this whole field is not.

repeated .google.cloud.automl.v1beta1.TablesModelColumnInfo tables_model_column_info = 3;

Parameter
Name Description
builderForValue TablesModelColumnInfo.Builder
Returns
Type Description
TablesAnnotation.Builder

addTablesModelColumnInfo(int index, TablesModelColumnInfo value)

public TablesAnnotation.Builder addTablesModelColumnInfo(int index, TablesModelColumnInfo value)

Output only. Auxiliary information for each of the model's

input_feature_column_specs with respect to this particular prediction. If no other fields than

column_spec_name and

column_display_name would be populated, then this whole field is not.

repeated .google.cloud.automl.v1beta1.TablesModelColumnInfo tables_model_column_info = 3;

Parameters
Name Description
index int
value TablesModelColumnInfo
Returns
Type Description
TablesAnnotation.Builder

addTablesModelColumnInfo(int index, TablesModelColumnInfo.Builder builderForValue)

public TablesAnnotation.Builder addTablesModelColumnInfo(int index, TablesModelColumnInfo.Builder builderForValue)

Output only. Auxiliary information for each of the model's

input_feature_column_specs with respect to this particular prediction. If no other fields than

column_spec_name and

column_display_name would be populated, then this whole field is not.

repeated .google.cloud.automl.v1beta1.TablesModelColumnInfo tables_model_column_info = 3;

Parameters
Name Description
index int
builderForValue TablesModelColumnInfo.Builder
Returns
Type Description
TablesAnnotation.Builder

addTablesModelColumnInfoBuilder()

public TablesModelColumnInfo.Builder addTablesModelColumnInfoBuilder()

Output only. Auxiliary information for each of the model's

input_feature_column_specs with respect to this particular prediction. If no other fields than

column_spec_name and

column_display_name would be populated, then this whole field is not.

repeated .google.cloud.automl.v1beta1.TablesModelColumnInfo tables_model_column_info = 3;

Returns
Type Description
TablesModelColumnInfo.Builder

addTablesModelColumnInfoBuilder(int index)

public TablesModelColumnInfo.Builder addTablesModelColumnInfoBuilder(int index)

Output only. Auxiliary information for each of the model's

input_feature_column_specs with respect to this particular prediction. If no other fields than

column_spec_name and

column_display_name would be populated, then this whole field is not.

repeated .google.cloud.automl.v1beta1.TablesModelColumnInfo tables_model_column_info = 3;

Parameter
Name Description
index int
Returns
Type Description
TablesModelColumnInfo.Builder

build()

public TablesAnnotation build()
Returns
Type Description
TablesAnnotation

buildPartial()

public TablesAnnotation buildPartial()
Returns
Type Description
TablesAnnotation

clear()

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

clearBaselineScore()

public TablesAnnotation.Builder clearBaselineScore()

Output only. Stores the prediction score for the baseline example, which is defined as the example with all values set to their baseline values. This is used as part of the Sampled Shapley explanation of the model's prediction. This field is populated only when feature importance is requested. For regression models, this holds the baseline prediction for the baseline example. For classification models, this holds the baseline prediction for the baseline example for the argmax class.

float baseline_score = 5;

Returns
Type Description
TablesAnnotation.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public TablesAnnotation.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
TablesAnnotation.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public TablesAnnotation.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
TablesAnnotation.Builder
Overrides

clearPredictionInterval()

public TablesAnnotation.Builder clearPredictionInterval()

Output only. Only populated when

target_column_spec has FLOAT64 data type. An interval in which the exactly correct target value has 95% chance to be in.

.google.cloud.automl.v1beta1.DoubleRange prediction_interval = 4;

Returns
Type Description
TablesAnnotation.Builder

clearScore()

public TablesAnnotation.Builder clearScore()

Output only. A confidence estimate between 0.0 and 1.0, inclusive. A higher value means greater confidence in the returned value. For

target_column_spec of FLOAT64 data type the score is not populated.

float score = 1;

Returns
Type Description
TablesAnnotation.Builder

This builder for chaining.

clearTablesModelColumnInfo()

public TablesAnnotation.Builder clearTablesModelColumnInfo()

Output only. Auxiliary information for each of the model's

input_feature_column_specs with respect to this particular prediction. If no other fields than

column_spec_name and

column_display_name would be populated, then this whole field is not.

repeated .google.cloud.automl.v1beta1.TablesModelColumnInfo tables_model_column_info = 3;

Returns
Type Description
TablesAnnotation.Builder

clearValue()

public TablesAnnotation.Builder clearValue()

The predicted value of the row's

target_column. The value depends on the column's DataType:

  • CATEGORY - the predicted (with the above confidence score) CATEGORY value.

  • FLOAT64 - the predicted (with above prediction_interval) FLOAT64 value.

.google.protobuf.Value value = 2;

Returns
Type Description
TablesAnnotation.Builder

clone()

public TablesAnnotation.Builder clone()
Returns
Type Description
TablesAnnotation.Builder
Overrides

getBaselineScore()

public float getBaselineScore()

Output only. Stores the prediction score for the baseline example, which is defined as the example with all values set to their baseline values. This is used as part of the Sampled Shapley explanation of the model's prediction. This field is populated only when feature importance is requested. For regression models, this holds the baseline prediction for the baseline example. For classification models, this holds the baseline prediction for the baseline example for the argmax class.

float baseline_score = 5;

Returns
Type Description
float

The baselineScore.

getDefaultInstanceForType()

public TablesAnnotation getDefaultInstanceForType()
Returns
Type Description
TablesAnnotation

getDescriptorForType()

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

getPredictionInterval()

public DoubleRange getPredictionInterval()

Output only. Only populated when

target_column_spec has FLOAT64 data type. An interval in which the exactly correct target value has 95% chance to be in.

.google.cloud.automl.v1beta1.DoubleRange prediction_interval = 4;

Returns
Type Description
DoubleRange

The predictionInterval.

getPredictionIntervalBuilder()

public DoubleRange.Builder getPredictionIntervalBuilder()

Output only. Only populated when

target_column_spec has FLOAT64 data type. An interval in which the exactly correct target value has 95% chance to be in.

.google.cloud.automl.v1beta1.DoubleRange prediction_interval = 4;

Returns
Type Description
DoubleRange.Builder

getPredictionIntervalOrBuilder()

public DoubleRangeOrBuilder getPredictionIntervalOrBuilder()

Output only. Only populated when

target_column_spec has FLOAT64 data type. An interval in which the exactly correct target value has 95% chance to be in.

.google.cloud.automl.v1beta1.DoubleRange prediction_interval = 4;

Returns
Type Description
DoubleRangeOrBuilder

getScore()

public float getScore()

Output only. A confidence estimate between 0.0 and 1.0, inclusive. A higher value means greater confidence in the returned value. For

target_column_spec of FLOAT64 data type the score is not populated.

float score = 1;

Returns
Type Description
float

The score.

getTablesModelColumnInfo(int index)

public TablesModelColumnInfo getTablesModelColumnInfo(int index)

Output only. Auxiliary information for each of the model's

input_feature_column_specs with respect to this particular prediction. If no other fields than

column_spec_name and

column_display_name would be populated, then this whole field is not.

repeated .google.cloud.automl.v1beta1.TablesModelColumnInfo tables_model_column_info = 3;

Parameter
Name Description
index int
Returns
Type Description
TablesModelColumnInfo

getTablesModelColumnInfoBuilder(int index)

public TablesModelColumnInfo.Builder getTablesModelColumnInfoBuilder(int index)

Output only. Auxiliary information for each of the model's

input_feature_column_specs with respect to this particular prediction. If no other fields than

column_spec_name and

column_display_name would be populated, then this whole field is not.

repeated .google.cloud.automl.v1beta1.TablesModelColumnInfo tables_model_column_info = 3;

Parameter
Name Description
index int
Returns
Type Description
TablesModelColumnInfo.Builder

getTablesModelColumnInfoBuilderList()

public List<TablesModelColumnInfo.Builder> getTablesModelColumnInfoBuilderList()

Output only. Auxiliary information for each of the model's

input_feature_column_specs with respect to this particular prediction. If no other fields than

column_spec_name and

column_display_name would be populated, then this whole field is not.

repeated .google.cloud.automl.v1beta1.TablesModelColumnInfo tables_model_column_info = 3;

Returns
Type Description
List<Builder>

getTablesModelColumnInfoCount()

public int getTablesModelColumnInfoCount()

Output only. Auxiliary information for each of the model's

input_feature_column_specs with respect to this particular prediction. If no other fields than

column_spec_name and

column_display_name would be populated, then this whole field is not.

repeated .google.cloud.automl.v1beta1.TablesModelColumnInfo tables_model_column_info = 3;

Returns
Type Description
int

getTablesModelColumnInfoList()

public List<TablesModelColumnInfo> getTablesModelColumnInfoList()

Output only. Auxiliary information for each of the model's

input_feature_column_specs with respect to this particular prediction. If no other fields than

column_spec_name and

column_display_name would be populated, then this whole field is not.

repeated .google.cloud.automl.v1beta1.TablesModelColumnInfo tables_model_column_info = 3;

Returns
Type Description
List<TablesModelColumnInfo>

getTablesModelColumnInfoOrBuilder(int index)

public TablesModelColumnInfoOrBuilder getTablesModelColumnInfoOrBuilder(int index)

Output only. Auxiliary information for each of the model's

input_feature_column_specs with respect to this particular prediction. If no other fields than

column_spec_name and

column_display_name would be populated, then this whole field is not.

repeated .google.cloud.automl.v1beta1.TablesModelColumnInfo tables_model_column_info = 3;

Parameter
Name Description
index int
Returns
Type Description
TablesModelColumnInfoOrBuilder

getTablesModelColumnInfoOrBuilderList()

public List<? extends TablesModelColumnInfoOrBuilder> getTablesModelColumnInfoOrBuilderList()

Output only. Auxiliary information for each of the model's

input_feature_column_specs with respect to this particular prediction. If no other fields than

column_spec_name and

column_display_name would be populated, then this whole field is not.

repeated .google.cloud.automl.v1beta1.TablesModelColumnInfo tables_model_column_info = 3;

Returns
Type Description
List<? extends com.google.cloud.automl.v1beta1.TablesModelColumnInfoOrBuilder>

getValue()

public Value getValue()

The predicted value of the row's

target_column. The value depends on the column's DataType:

  • CATEGORY - the predicted (with the above confidence score) CATEGORY value.

  • FLOAT64 - the predicted (with above prediction_interval) FLOAT64 value.

.google.protobuf.Value value = 2;

Returns
Type Description
Value

The value.

getValueBuilder()

public Value.Builder getValueBuilder()

The predicted value of the row's

target_column. The value depends on the column's DataType:

  • CATEGORY - the predicted (with the above confidence score) CATEGORY value.

  • FLOAT64 - the predicted (with above prediction_interval) FLOAT64 value.

.google.protobuf.Value value = 2;

Returns
Type Description
Builder

getValueOrBuilder()

public ValueOrBuilder getValueOrBuilder()

The predicted value of the row's

target_column. The value depends on the column's DataType:

  • CATEGORY - the predicted (with the above confidence score) CATEGORY value.

  • FLOAT64 - the predicted (with above prediction_interval) FLOAT64 value.

.google.protobuf.Value value = 2;

Returns
Type Description
ValueOrBuilder

hasPredictionInterval()

public boolean hasPredictionInterval()

Output only. Only populated when

target_column_spec has FLOAT64 data type. An interval in which the exactly correct target value has 95% chance to be in.

.google.cloud.automl.v1beta1.DoubleRange prediction_interval = 4;

Returns
Type Description
boolean

Whether the predictionInterval field is set.

hasValue()

public boolean hasValue()

The predicted value of the row's

target_column. The value depends on the column's DataType:

  • CATEGORY - the predicted (with the above confidence score) CATEGORY value.

  • FLOAT64 - the predicted (with above prediction_interval) FLOAT64 value.

.google.protobuf.Value value = 2;

Returns
Type Description
boolean

Whether the value field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(TablesAnnotation other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergePredictionInterval(DoubleRange value)

public TablesAnnotation.Builder mergePredictionInterval(DoubleRange value)

Output only. Only populated when

target_column_spec has FLOAT64 data type. An interval in which the exactly correct target value has 95% chance to be in.

.google.cloud.automl.v1beta1.DoubleRange prediction_interval = 4;

Parameter
Name Description
value DoubleRange
Returns
Type Description
TablesAnnotation.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final TablesAnnotation.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
TablesAnnotation.Builder
Overrides

mergeValue(Value value)

public TablesAnnotation.Builder mergeValue(Value value)

The predicted value of the row's

target_column. The value depends on the column's DataType:

  • CATEGORY - the predicted (with the above confidence score) CATEGORY value.

  • FLOAT64 - the predicted (with above prediction_interval) FLOAT64 value.

.google.protobuf.Value value = 2;

Parameter
Name Description
value Value
Returns
Type Description
TablesAnnotation.Builder

removeTablesModelColumnInfo(int index)

public TablesAnnotation.Builder removeTablesModelColumnInfo(int index)

Output only. Auxiliary information for each of the model's

input_feature_column_specs with respect to this particular prediction. If no other fields than

column_spec_name and

column_display_name would be populated, then this whole field is not.

repeated .google.cloud.automl.v1beta1.TablesModelColumnInfo tables_model_column_info = 3;

Parameter
Name Description
index int
Returns
Type Description
TablesAnnotation.Builder

setBaselineScore(float value)

public TablesAnnotation.Builder setBaselineScore(float value)

Output only. Stores the prediction score for the baseline example, which is defined as the example with all values set to their baseline values. This is used as part of the Sampled Shapley explanation of the model's prediction. This field is populated only when feature importance is requested. For regression models, this holds the baseline prediction for the baseline example. For classification models, this holds the baseline prediction for the baseline example for the argmax class.

float baseline_score = 5;

Parameter
Name Description
value float

The baselineScore to set.

Returns
Type Description
TablesAnnotation.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public TablesAnnotation.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
TablesAnnotation.Builder
Overrides

setPredictionInterval(DoubleRange value)

public TablesAnnotation.Builder setPredictionInterval(DoubleRange value)

Output only. Only populated when

target_column_spec has FLOAT64 data type. An interval in which the exactly correct target value has 95% chance to be in.

.google.cloud.automl.v1beta1.DoubleRange prediction_interval = 4;

Parameter
Name Description
value DoubleRange
Returns
Type Description
TablesAnnotation.Builder

setPredictionInterval(DoubleRange.Builder builderForValue)

public TablesAnnotation.Builder setPredictionInterval(DoubleRange.Builder builderForValue)

Output only. Only populated when

target_column_spec has FLOAT64 data type. An interval in which the exactly correct target value has 95% chance to be in.

.google.cloud.automl.v1beta1.DoubleRange prediction_interval = 4;

Parameter
Name Description
builderForValue DoubleRange.Builder
Returns
Type Description
TablesAnnotation.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public TablesAnnotation.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
TablesAnnotation.Builder
Overrides

setScore(float value)

public TablesAnnotation.Builder setScore(float value)

Output only. A confidence estimate between 0.0 and 1.0, inclusive. A higher value means greater confidence in the returned value. For

target_column_spec of FLOAT64 data type the score is not populated.

float score = 1;

Parameter
Name Description
value float

The score to set.

Returns
Type Description
TablesAnnotation.Builder

This builder for chaining.

setTablesModelColumnInfo(int index, TablesModelColumnInfo value)

public TablesAnnotation.Builder setTablesModelColumnInfo(int index, TablesModelColumnInfo value)

Output only. Auxiliary information for each of the model's

input_feature_column_specs with respect to this particular prediction. If no other fields than

column_spec_name and

column_display_name would be populated, then this whole field is not.

repeated .google.cloud.automl.v1beta1.TablesModelColumnInfo tables_model_column_info = 3;

Parameters
Name Description
index int
value TablesModelColumnInfo
Returns
Type Description
TablesAnnotation.Builder

setTablesModelColumnInfo(int index, TablesModelColumnInfo.Builder builderForValue)

public TablesAnnotation.Builder setTablesModelColumnInfo(int index, TablesModelColumnInfo.Builder builderForValue)

Output only. Auxiliary information for each of the model's

input_feature_column_specs with respect to this particular prediction. If no other fields than

column_spec_name and

column_display_name would be populated, then this whole field is not.

repeated .google.cloud.automl.v1beta1.TablesModelColumnInfo tables_model_column_info = 3;

Parameters
Name Description
index int
builderForValue TablesModelColumnInfo.Builder
Returns
Type Description
TablesAnnotation.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final TablesAnnotation.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
TablesAnnotation.Builder
Overrides

setValue(Value value)

public TablesAnnotation.Builder setValue(Value value)

The predicted value of the row's

target_column. The value depends on the column's DataType:

  • CATEGORY - the predicted (with the above confidence score) CATEGORY value.

  • FLOAT64 - the predicted (with above prediction_interval) FLOAT64 value.

.google.protobuf.Value value = 2;

Parameter
Name Description
value Value
Returns
Type Description
TablesAnnotation.Builder

setValue(Value.Builder builderForValue)

public TablesAnnotation.Builder setValue(Value.Builder builderForValue)

The predicted value of the row's

target_column. The value depends on the column's DataType:

  • CATEGORY - the predicted (with the above confidence score) CATEGORY value.

  • FLOAT64 - the predicted (with above prediction_interval) FLOAT64 value.

.google.protobuf.Value value = 2;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
TablesAnnotation.Builder