- 0.51.0 (latest)
- 0.50.0
- 0.49.0
- 0.48.0
- 0.47.0
- 0.45.0
- 0.44.0
- 0.43.0
- 0.42.0
- 0.41.0
- 0.40.0
- 0.39.0
- 0.38.0
- 0.37.0
- 0.36.0
- 0.35.0
- 0.33.0
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.26.0
- 0.25.0
- 0.24.0
- 0.23.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
- 0.14.0
- 0.13.0
- 0.12.0
- 0.11.0
- 0.10.0
- 0.9.0
- 0.8.0
- 0.7.0
- 0.5.0
- 0.4.0
- 0.3.0
- 0.2.0
- 0.1.0
public static final class CustomTuningModel.Builder extends GeneratedMessageV3.Builder<CustomTuningModel.Builder> implements CustomTuningModelOrBuilderMetadata that describes a custom tuned model.
Protobuf type google.cloud.discoveryengine.v1beta.CustomTuningModel
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > CustomTuningModel.BuilderImplements
CustomTuningModelOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public CustomTuningModel.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
CustomTuningModel.Builder |
|
build()
public CustomTuningModel build()| Returns | |
|---|---|
| Type | Description |
CustomTuningModel |
|
buildPartial()
public CustomTuningModel buildPartial()| Returns | |
|---|---|
| Type | Description |
CustomTuningModel |
|
clear()
public CustomTuningModel.Builder clear()| Returns | |
|---|---|
| Type | Description |
CustomTuningModel.Builder |
|
clearCreateTime() (deprecated)
public CustomTuningModel.Builder clearCreateTime()Deprecated: Timestamp the Model was created at.
.google.protobuf.Timestamp create_time = 5 [deprecated = true];
| Returns | |
|---|---|
| Type | Description |
CustomTuningModel.Builder |
|
clearDisplayName()
public CustomTuningModel.Builder clearDisplayName()The display name of the model.
string display_name = 2;
| Returns | |
|---|---|
| Type | Description |
CustomTuningModel.Builder |
This builder for chaining. |
clearErrorMessage()
public CustomTuningModel.Builder clearErrorMessage() Currently this is only populated if the model state is
INPUT_VALIDATION_FAILED.
string error_message = 8;
| Returns | |
|---|---|
| Type | Description |
CustomTuningModel.Builder |
This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public CustomTuningModel.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
CustomTuningModel.Builder |
|
clearMetrics()
public CustomTuningModel.Builder clearMetrics()| Returns | |
|---|---|
| Type | Description |
CustomTuningModel.Builder |
|
clearModelState()
public CustomTuningModel.Builder clearModelState() The state that the model is in (e.g.TRAINING or TRAINING_FAILED).
.google.cloud.discoveryengine.v1beta.CustomTuningModel.ModelState model_state = 4;
| Returns | |
|---|---|
| Type | Description |
CustomTuningModel.Builder |
This builder for chaining. |
clearModelVersion()
public CustomTuningModel.Builder clearModelVersion()The version of the model.
int64 model_version = 3;
| Returns | |
|---|---|
| Type | Description |
CustomTuningModel.Builder |
This builder for chaining. |
clearName()
public CustomTuningModel.Builder clearName()Required. The fully qualified resource name of the model.
Format:
projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}.
Model must be an alpha-numerical string with limit of 40 characters.
string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
CustomTuningModel.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public CustomTuningModel.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
CustomTuningModel.Builder |
|
clearTrainingStartTime()
public CustomTuningModel.Builder clearTrainingStartTime()Timestamp the model training was initiated.
.google.protobuf.Timestamp training_start_time = 6;
| Returns | |
|---|---|
| Type | Description |
CustomTuningModel.Builder |
|
clone()
public CustomTuningModel.Builder clone()| Returns | |
|---|---|
| Type | Description |
CustomTuningModel.Builder |
|
containsMetrics(String key)
public boolean containsMetrics(String key)The metrics of the trained model.
map<string, double> metrics = 7;
| Parameter | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
getCreateTime() (deprecated)
public Timestamp getCreateTime()Deprecated. google.cloud.discoveryengine.v1beta.CustomTuningModel.create_time is deprecated. See google/cloud/discoveryengine/v1beta/custom_tuning_model.proto;l=89
Deprecated: Timestamp the Model was created at.
.google.protobuf.Timestamp create_time = 5 [deprecated = true];
| Returns | |
|---|---|
| Type | Description |
Timestamp |
The createTime. |
getCreateTimeBuilder() (deprecated)
public Timestamp.Builder getCreateTimeBuilder()Deprecated: Timestamp the Model was created at.
.google.protobuf.Timestamp create_time = 5 [deprecated = true];
| Returns | |
|---|---|
| Type | Description |
Builder |
|
getCreateTimeOrBuilder() (deprecated)
public TimestampOrBuilder getCreateTimeOrBuilder()Deprecated: Timestamp the Model was created at.
.google.protobuf.Timestamp create_time = 5 [deprecated = true];
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
getDefaultInstanceForType()
public CustomTuningModel getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
CustomTuningModel |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getDisplayName()
public String getDisplayName()The display name of the model.
string display_name = 2;
| Returns | |
|---|---|
| Type | Description |
String |
The displayName. |
getDisplayNameBytes()
public ByteString getDisplayNameBytes()The display name of the model.
string display_name = 2;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for displayName. |
getErrorMessage()
public String getErrorMessage() Currently this is only populated if the model state is
INPUT_VALIDATION_FAILED.
string error_message = 8;
| Returns | |
|---|---|
| Type | Description |
String |
The errorMessage. |
getErrorMessageBytes()
public ByteString getErrorMessageBytes() Currently this is only populated if the model state is
INPUT_VALIDATION_FAILED.
string error_message = 8;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for errorMessage. |
getMetrics() (deprecated)
public Map<String,Double> getMetrics()Use #getMetricsMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,Double> |
|
getMetricsCount()
public int getMetricsCount()The metrics of the trained model.
map<string, double> metrics = 7;
| Returns | |
|---|---|
| Type | Description |
int |
|
getMetricsMap()
public Map<String,Double> getMetricsMap()The metrics of the trained model.
map<string, double> metrics = 7;
| Returns | |
|---|---|
| Type | Description |
Map<String,Double> |
|
getMetricsOrDefault(String key, double defaultValue)
public double getMetricsOrDefault(String key, double defaultValue)The metrics of the trained model.
map<string, double> metrics = 7;
| Parameters | |
|---|---|
| Name | Description |
key |
String |
defaultValue |
double |
| Returns | |
|---|---|
| Type | Description |
double |
|
getMetricsOrThrow(String key)
public double getMetricsOrThrow(String key)The metrics of the trained model.
map<string, double> metrics = 7;
| Parameter | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
double |
|
getModelState()
public CustomTuningModel.ModelState getModelState() The state that the model is in (e.g.TRAINING or TRAINING_FAILED).
.google.cloud.discoveryengine.v1beta.CustomTuningModel.ModelState model_state = 4;
| Returns | |
|---|---|
| Type | Description |
CustomTuningModel.ModelState |
The modelState. |
getModelStateValue()
public int getModelStateValue() The state that the model is in (e.g.TRAINING or TRAINING_FAILED).
.google.cloud.discoveryengine.v1beta.CustomTuningModel.ModelState model_state = 4;
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for modelState. |
getModelVersion()
public long getModelVersion()The version of the model.
int64 model_version = 3;
| Returns | |
|---|---|
| Type | Description |
long |
The modelVersion. |
getMutableMetrics() (deprecated)
public Map<String,Double> getMutableMetrics()Use alternate mutation accessors instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,Double> |
|
getName()
public String getName()Required. The fully qualified resource name of the model.
Format:
projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}.
Model must be an alpha-numerical string with limit of 40 characters.
string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
String |
The name. |
getNameBytes()
public ByteString getNameBytes()Required. The fully qualified resource name of the model.
Format:
projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}.
Model must be an alpha-numerical string with limit of 40 characters.
string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for name. |
getTrainingStartTime()
public Timestamp getTrainingStartTime()Timestamp the model training was initiated.
.google.protobuf.Timestamp training_start_time = 6;
| Returns | |
|---|---|
| Type | Description |
Timestamp |
The trainingStartTime. |
getTrainingStartTimeBuilder()
public Timestamp.Builder getTrainingStartTimeBuilder()Timestamp the model training was initiated.
.google.protobuf.Timestamp training_start_time = 6;
| Returns | |
|---|---|
| Type | Description |
Builder |
|
getTrainingStartTimeOrBuilder()
public TimestampOrBuilder getTrainingStartTimeOrBuilder()Timestamp the model training was initiated.
.google.protobuf.Timestamp training_start_time = 6;
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
hasCreateTime() (deprecated)
public boolean hasCreateTime()Deprecated. google.cloud.discoveryengine.v1beta.CustomTuningModel.create_time is deprecated. See google/cloud/discoveryengine/v1beta/custom_tuning_model.proto;l=89
Deprecated: Timestamp the Model was created at.
.google.protobuf.Timestamp create_time = 5 [deprecated = true];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the createTime field is set. |
hasTrainingStartTime()
public boolean hasTrainingStartTime()Timestamp the model training was initiated.
.google.protobuf.Timestamp training_start_time = 6;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the trainingStartTime field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
internalGetMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)| Parameter | |
|---|---|
| Name | Description |
number |
int |
| Returns | |
|---|---|
| Type | Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
internalGetMutableMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)| Parameter | |
|---|---|
| Name | Description |
number |
int |
| Returns | |
|---|---|
| Type | Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeCreateTime(Timestamp value) (deprecated)
public CustomTuningModel.Builder mergeCreateTime(Timestamp value)Deprecated: Timestamp the Model was created at.
.google.protobuf.Timestamp create_time = 5 [deprecated = true];
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
CustomTuningModel.Builder |
|
mergeFrom(CustomTuningModel other)
public CustomTuningModel.Builder mergeFrom(CustomTuningModel other)| Parameter | |
|---|---|
| Name | Description |
other |
CustomTuningModel |
| Returns | |
|---|---|
| Type | Description |
CustomTuningModel.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public CustomTuningModel.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
CustomTuningModel.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public CustomTuningModel.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
CustomTuningModel.Builder |
|
mergeTrainingStartTime(Timestamp value)
public CustomTuningModel.Builder mergeTrainingStartTime(Timestamp value)Timestamp the model training was initiated.
.google.protobuf.Timestamp training_start_time = 6;
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
CustomTuningModel.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final CustomTuningModel.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
CustomTuningModel.Builder |
|
putAllMetrics(Map<String,Double> values)
public CustomTuningModel.Builder putAllMetrics(Map<String,Double> values)The metrics of the trained model.
map<string, double> metrics = 7;
| Parameter | |
|---|---|
| Name | Description |
values |
Map<String,Double> |
| Returns | |
|---|---|
| Type | Description |
CustomTuningModel.Builder |
|
putMetrics(String key, double value)
public CustomTuningModel.Builder putMetrics(String key, double value)The metrics of the trained model.
map<string, double> metrics = 7;
| Parameters | |
|---|---|
| Name | Description |
key |
String |
value |
double |
| Returns | |
|---|---|
| Type | Description |
CustomTuningModel.Builder |
|
removeMetrics(String key)
public CustomTuningModel.Builder removeMetrics(String key)The metrics of the trained model.
map<string, double> metrics = 7;
| Parameter | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
CustomTuningModel.Builder |
|
setCreateTime(Timestamp value) (deprecated)
public CustomTuningModel.Builder setCreateTime(Timestamp value)Deprecated: Timestamp the Model was created at.
.google.protobuf.Timestamp create_time = 5 [deprecated = true];
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
CustomTuningModel.Builder |
|
setCreateTime(Timestamp.Builder builderForValue) (deprecated)
public CustomTuningModel.Builder setCreateTime(Timestamp.Builder builderForValue)Deprecated: Timestamp the Model was created at.
.google.protobuf.Timestamp create_time = 5 [deprecated = true];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Builder |
| Returns | |
|---|---|
| Type | Description |
CustomTuningModel.Builder |
|
setDisplayName(String value)
public CustomTuningModel.Builder setDisplayName(String value)The display name of the model.
string display_name = 2;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe displayName to set. |
| Returns | |
|---|---|
| Type | Description |
CustomTuningModel.Builder |
This builder for chaining. |
setDisplayNameBytes(ByteString value)
public CustomTuningModel.Builder setDisplayNameBytes(ByteString value)The display name of the model.
string display_name = 2;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for displayName to set. |
| Returns | |
|---|---|
| Type | Description |
CustomTuningModel.Builder |
This builder for chaining. |
setErrorMessage(String value)
public CustomTuningModel.Builder setErrorMessage(String value) Currently this is only populated if the model state is
INPUT_VALIDATION_FAILED.
string error_message = 8;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe errorMessage to set. |
| Returns | |
|---|---|
| Type | Description |
CustomTuningModel.Builder |
This builder for chaining. |
setErrorMessageBytes(ByteString value)
public CustomTuningModel.Builder setErrorMessageBytes(ByteString value) Currently this is only populated if the model state is
INPUT_VALIDATION_FAILED.
string error_message = 8;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for errorMessage to set. |
| Returns | |
|---|---|
| Type | Description |
CustomTuningModel.Builder |
This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public CustomTuningModel.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
CustomTuningModel.Builder |
|
setModelState(CustomTuningModel.ModelState value)
public CustomTuningModel.Builder setModelState(CustomTuningModel.ModelState value) The state that the model is in (e.g.TRAINING or TRAINING_FAILED).
.google.cloud.discoveryengine.v1beta.CustomTuningModel.ModelState model_state = 4;
| Parameter | |
|---|---|
| Name | Description |
value |
CustomTuningModel.ModelStateThe modelState to set. |
| Returns | |
|---|---|
| Type | Description |
CustomTuningModel.Builder |
This builder for chaining. |
setModelStateValue(int value)
public CustomTuningModel.Builder setModelStateValue(int value) The state that the model is in (e.g.TRAINING or TRAINING_FAILED).
.google.cloud.discoveryengine.v1beta.CustomTuningModel.ModelState model_state = 4;
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for modelState to set. |
| Returns | |
|---|---|
| Type | Description |
CustomTuningModel.Builder |
This builder for chaining. |
setModelVersion(long value)
public CustomTuningModel.Builder setModelVersion(long value)The version of the model.
int64 model_version = 3;
| Parameter | |
|---|---|
| Name | Description |
value |
longThe modelVersion to set. |
| Returns | |
|---|---|
| Type | Description |
CustomTuningModel.Builder |
This builder for chaining. |
setName(String value)
public CustomTuningModel.Builder setName(String value)Required. The fully qualified resource name of the model.
Format:
projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}.
Model must be an alpha-numerical string with limit of 40 characters.
string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe name to set. |
| Returns | |
|---|---|
| Type | Description |
CustomTuningModel.Builder |
This builder for chaining. |
setNameBytes(ByteString value)
public CustomTuningModel.Builder setNameBytes(ByteString value)Required. The fully qualified resource name of the model.
Format:
projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}.
Model must be an alpha-numerical string with limit of 40 characters.
string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for name to set. |
| Returns | |
|---|---|
| Type | Description |
CustomTuningModel.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public CustomTuningModel.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
CustomTuningModel.Builder |
|
setTrainingStartTime(Timestamp value)
public CustomTuningModel.Builder setTrainingStartTime(Timestamp value)Timestamp the model training was initiated.
.google.protobuf.Timestamp training_start_time = 6;
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
CustomTuningModel.Builder |
|
setTrainingStartTime(Timestamp.Builder builderForValue)
public CustomTuningModel.Builder setTrainingStartTime(Timestamp.Builder builderForValue)Timestamp the model training was initiated.
.google.protobuf.Timestamp training_start_time = 6;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Builder |
| Returns | |
|---|---|
| Type | Description |
CustomTuningModel.Builder |
|
setUnknownFields(UnknownFieldSet unknownFields)
public final CustomTuningModel.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
CustomTuningModel.Builder |
|