public final class PredictionResult extends GeneratedMessageV3 implements PredictionResultOrBuilder
PredictionResult is the result of using a model to create predictions.
Protobuf type google.cloud.financialservices.v1.PredictionResult
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
DATASET_FIELD_NUMBER
public static final int DATASET_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
END_TIME_FIELD_NUMBER
public static final int END_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
LABELS_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
LINE_OF_BUSINESS_FIELD_NUMBER
public static final int LINE_OF_BUSINESS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
MODEL_FIELD_NUMBER
public static final int MODEL_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
OUTPUTS_FIELD_NUMBER
public static final int OUTPUTS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
PREDICTION_PERIODS_FIELD_NUMBER
public static final int PREDICTION_PERIODS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
STATE_FIELD_NUMBER
public static final int STATE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
UPDATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static PredictionResult getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static PredictionResult.Builder newBuilder()
newBuilder(PredictionResult prototype)
public static PredictionResult.Builder newBuilder(PredictionResult prototype)
public static PredictionResult parseDelimitedFrom(InputStream input)
public static PredictionResult parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static PredictionResult parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static PredictionResult parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static PredictionResult parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static PredictionResult parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static PredictionResult parseFrom(CodedInputStream input)
public static PredictionResult parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static PredictionResult parseFrom(InputStream input)
public static PredictionResult parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static PredictionResult parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static PredictionResult parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<PredictionResult> parser()
Methods
containsLabels(String key)
public boolean containsLabels(String key)
Labels
map<string, string> labels = 4;
| Parameter |
| Name |
Description |
key |
String
|
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getCreateTime()
public Timestamp getCreateTime()
Output only. The timestamp of creation of this resource.
.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
Timestamp |
The createTime.
|
getCreateTimeOrBuilder()
public TimestampOrBuilder getCreateTimeOrBuilder()
Output only. The timestamp of creation of this resource.
.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
getDataset()
public String getDataset()
Required. The resource name of the Dataset to do predictions on
Format:
"/projects/{project_num}/locations/{location}/instances/{instance}/dataset/{dataset_id}"
string dataset = 6 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns |
| Type |
Description |
String |
The dataset.
|
getDatasetBytes()
public ByteString getDatasetBytes()
Required. The resource name of the Dataset to do predictions on
Format:
"/projects/{project_num}/locations/{location}/instances/{instance}/dataset/{dataset_id}"
string dataset = 6 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns |
| Type |
Description |
ByteString |
The bytes for dataset.
|
getDefaultInstanceForType()
public PredictionResult getDefaultInstanceForType()
getEndTime()
public Timestamp getEndTime()
Required. Specifies the latest time from which data is used to generate
features for predictions. This time should be no later than the end of the
date_range of the
dataset.
.google.protobuf.Timestamp end_time = 9 [(.google.api.field_behavior) = REQUIRED];
| Returns |
| Type |
Description |
Timestamp |
The endTime.
|
getEndTimeOrBuilder()
public TimestampOrBuilder getEndTimeOrBuilder()
Required. Specifies the latest time from which data is used to generate
features for predictions. This time should be no later than the end of the
date_range of the
dataset.
.google.protobuf.Timestamp end_time = 9 [(.google.api.field_behavior) = REQUIRED];
getLabels() (deprecated)
public Map<String,String> getLabels()
getLabelsCount()
public int getLabelsCount()
Labels
map<string, string> labels = 4;
| Returns |
| Type |
Description |
int |
|
getLabelsMap()
public Map<String,String> getLabelsMap()
Labels
map<string, string> labels = 4;
getLabelsOrDefault(String key, String defaultValue)
public String getLabelsOrDefault(String key, String defaultValue)
Labels
map<string, string> labels = 4;
| Returns |
| Type |
Description |
String |
|
getLabelsOrThrow(String key)
public String getLabelsOrThrow(String key)
Labels
map<string, string> labels = 4;
| Parameter |
| Name |
Description |
key |
String
|
| Returns |
| Type |
Description |
String |
|
getLineOfBusiness()
public LineOfBusiness getLineOfBusiness()
Output only. The line of business (Retail/Commercial) this prediction is
for. Determined by Model, cannot be set by user.
.google.cloud.financialservices.v1.LineOfBusiness line_of_business = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
getLineOfBusinessValue()
public int getLineOfBusinessValue()
Output only. The line of business (Retail/Commercial) this prediction is
for. Determined by Model, cannot be set by user.
.google.cloud.financialservices.v1.LineOfBusiness line_of_business = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
int |
The enum numeric value on the wire for lineOfBusiness.
|
getModel()
Required. The resource name of the Model to use to use to make predictions
Format:
"/projects/{project_num}/locations/{location}/instances/{instance}/models/{model}"
string model = 7 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns |
| Type |
Description |
String |
The model.
|
getModelBytes()
public ByteString getModelBytes()
Required. The resource name of the Model to use to use to make predictions
Format:
"/projects/{project_num}/locations/{location}/instances/{instance}/models/{model}"
string model = 7 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns |
| Type |
Description |
ByteString |
The bytes for model.
|
getName()
Output only. The resource name of the PredictionResult.
format:
"/projects/{project_num}/locations/{location}/instances/{instance}/predictionResults/{prediction_result}"
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
String |
The name.
|
getNameBytes()
public ByteString getNameBytes()
Output only. The resource name of the PredictionResult.
format:
"/projects/{project_num}/locations/{location}/instances/{instance}/predictionResults/{prediction_result}"
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
ByteString |
The bytes for name.
|
getOutputs()
public PredictionResult.Outputs getOutputs()
Required. Where to write the output of the predictions.
.google.cloud.financialservices.v1.PredictionResult.Outputs outputs = 11 [(.google.api.field_behavior) = REQUIRED];
getOutputsOrBuilder()
public PredictionResult.OutputsOrBuilder getOutputsOrBuilder()
Required. Where to write the output of the predictions.
.google.cloud.financialservices.v1.PredictionResult.Outputs outputs = 11 [(.google.api.field_behavior) = REQUIRED];
getParserForType()
public Parser<PredictionResult> getParserForType()
Overrides
getPredictionPeriods()
public int getPredictionPeriods()
The number of consecutive months to produce predictions for, ending with
the last full month prior to
end_time
according to the dataset's timezone.
int32 prediction_periods = 10;
| Returns |
| Type |
Description |
int |
The predictionPeriods.
|
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
getState()
public PredictionResult.State getState()
Output only. State of the PredictionResult (creating, active, deleting,
etc.)
.google.cloud.financialservices.v1.PredictionResult.State state = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
getStateValue()
public int getStateValue()
Output only. State of the PredictionResult (creating, active, deleting,
etc.)
.google.cloud.financialservices.v1.PredictionResult.State state = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
int |
The enum numeric value on the wire for state.
|
getUpdateTime()
public Timestamp getUpdateTime()
Output only. The timestamp of the most recent update of this resource.
.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
Timestamp |
The updateTime.
|
getUpdateTimeOrBuilder()
public TimestampOrBuilder getUpdateTimeOrBuilder()
Output only. The timestamp of the most recent update of this resource.
.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
hasCreateTime()
public boolean hasCreateTime()
Output only. The timestamp of creation of this resource.
.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
boolean |
Whether the createTime field is set.
|
hasEndTime()
public boolean hasEndTime()
Required. Specifies the latest time from which data is used to generate
features for predictions. This time should be no later than the end of the
date_range of the
dataset.
.google.protobuf.Timestamp end_time = 9 [(.google.api.field_behavior) = REQUIRED];
| Returns |
| Type |
Description |
boolean |
Whether the endTime field is set.
|
hasOutputs()
public boolean hasOutputs()
Required. Where to write the output of the predictions.
.google.cloud.financialservices.v1.PredictionResult.Outputs outputs = 11 [(.google.api.field_behavior) = REQUIRED];
| Returns |
| Type |
Description |
boolean |
Whether the outputs field is set.
|
hasUpdateTime()
public boolean hasUpdateTime()
Output only. The timestamp of the most recent update of this resource.
.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
boolean |
Whether the updateTime field is set.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
internalGetMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
| Parameter |
| Name |
Description |
number |
int
|
| Returns |
| Type |
Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public PredictionResult.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected PredictionResult.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public PredictionResult.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
