Class TrainingPipeline
- java.lang.Object
-
- com.google.protobuf.AbstractMessageLite
-
- com.google.protobuf.AbstractMessage
-
- com.google.protobuf.GeneratedMessageV3
-
- com.google.cloud.aiplatform.v1beta1.TrainingPipeline
-
- All Implemented Interfaces:
TrainingPipelineOrBuilder
,com.google.protobuf.Message
,com.google.protobuf.MessageLite
,com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
,Serializable
public final class TrainingPipeline extends com.google.protobuf.GeneratedMessageV3 implements TrainingPipelineOrBuilder
The TrainingPipeline orchestrates tasks associated with training a Model. It always executes the training task, and optionally may also export data from Vertex AI's Dataset which becomes the training input, [upload][google.cloud.aiplatform.v1beta1.ModelService.UploadModel] the Model to Vertex AI, and evaluate the Model.
Protobuf typegoogle.cloud.aiplatform.v1beta1.TrainingPipeline
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
TrainingPipeline.Builder
The TrainingPipeline orchestrates tasks associated with training a Model.-
Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter
-
-
Field Summary
Fields Modifier and Type Field Description static int
CREATE_TIME_FIELD_NUMBER
static int
DISPLAY_NAME_FIELD_NUMBER
static int
ENCRYPTION_SPEC_FIELD_NUMBER
static int
END_TIME_FIELD_NUMBER
static int
ERROR_FIELD_NUMBER
static int
INPUT_DATA_CONFIG_FIELD_NUMBER
static int
LABELS_FIELD_NUMBER
static int
MODEL_ID_FIELD_NUMBER
static int
MODEL_TO_UPLOAD_FIELD_NUMBER
static int
NAME_FIELD_NUMBER
static int
PARENT_MODEL_FIELD_NUMBER
static int
START_TIME_FIELD_NUMBER
static int
STATE_FIELD_NUMBER
static int
TRAINING_TASK_DEFINITION_FIELD_NUMBER
static int
TRAINING_TASK_INPUTS_FIELD_NUMBER
static int
TRAINING_TASK_METADATA_FIELD_NUMBER
static int
UPDATE_TIME_FIELD_NUMBER
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description boolean
containsLabels(String key)
The labels with user-defined metadata to organize TrainingPipelines.boolean
equals(Object obj)
com.google.protobuf.Timestamp
getCreateTime()
Output only.com.google.protobuf.TimestampOrBuilder
getCreateTimeOrBuilder()
Output only.static TrainingPipeline
getDefaultInstance()
TrainingPipeline
getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor
getDescriptor()
String
getDisplayName()
Required.com.google.protobuf.ByteString
getDisplayNameBytes()
Required.EncryptionSpec
getEncryptionSpec()
Customer-managed encryption key spec for a TrainingPipeline.EncryptionSpecOrBuilder
getEncryptionSpecOrBuilder()
Customer-managed encryption key spec for a TrainingPipeline.com.google.protobuf.Timestamp
getEndTime()
Output only.com.google.protobuf.TimestampOrBuilder
getEndTimeOrBuilder()
Output only.com.google.rpc.Status
getError()
Output only.com.google.rpc.StatusOrBuilder
getErrorOrBuilder()
Output only.InputDataConfig
getInputDataConfig()
Specifies Vertex AI owned input data that may be used for training the Model.InputDataConfigOrBuilder
getInputDataConfigOrBuilder()
Specifies Vertex AI owned input data that may be used for training the Model.Map<String,String>
getLabels()
Deprecated.int
getLabelsCount()
The labels with user-defined metadata to organize TrainingPipelines.Map<String,String>
getLabelsMap()
The labels with user-defined metadata to organize TrainingPipelines.String
getLabelsOrDefault(String key, String defaultValue)
The labels with user-defined metadata to organize TrainingPipelines.String
getLabelsOrThrow(String key)
The labels with user-defined metadata to organize TrainingPipelines.String
getModelId()
Optional.com.google.protobuf.ByteString
getModelIdBytes()
Optional.Model
getModelToUpload()
Describes the Model that may be uploaded (via [ModelService.UploadModel][google.cloud.aiplatform.v1beta1.ModelService.UploadModel]) by this TrainingPipeline.ModelOrBuilder
getModelToUploadOrBuilder()
Describes the Model that may be uploaded (via [ModelService.UploadModel][google.cloud.aiplatform.v1beta1.ModelService.UploadModel]) by this TrainingPipeline.String
getName()
Output only.com.google.protobuf.ByteString
getNameBytes()
Output only.String
getParentModel()
Optional.com.google.protobuf.ByteString
getParentModelBytes()
Optional.com.google.protobuf.Parser<TrainingPipeline>
getParserForType()
int
getSerializedSize()
com.google.protobuf.Timestamp
getStartTime()
Output only.com.google.protobuf.TimestampOrBuilder
getStartTimeOrBuilder()
Output only.PipelineState
getState()
Output only.int
getStateValue()
Output only.String
getTrainingTaskDefinition()
Required.com.google.protobuf.ByteString
getTrainingTaskDefinitionBytes()
Required.com.google.protobuf.Value
getTrainingTaskInputs()
Required.com.google.protobuf.ValueOrBuilder
getTrainingTaskInputsOrBuilder()
Required.com.google.protobuf.Value
getTrainingTaskMetadata()
Output only.com.google.protobuf.ValueOrBuilder
getTrainingTaskMetadataOrBuilder()
Output only.com.google.protobuf.Timestamp
getUpdateTime()
Output only.com.google.protobuf.TimestampOrBuilder
getUpdateTimeOrBuilder()
Output only.boolean
hasCreateTime()
Output only.boolean
hasEncryptionSpec()
Customer-managed encryption key spec for a TrainingPipeline.boolean
hasEndTime()
Output only.boolean
hasError()
Output only.int
hashCode()
boolean
hasInputDataConfig()
Specifies Vertex AI owned input data that may be used for training the Model.boolean
hasModelToUpload()
Describes the Model that may be uploaded (via [ModelService.UploadModel][google.cloud.aiplatform.v1beta1.ModelService.UploadModel]) by this TrainingPipeline.boolean
hasStartTime()
Output only.boolean
hasTrainingTaskInputs()
Required.boolean
hasTrainingTaskMetadata()
Output only.boolean
hasUpdateTime()
Output only.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
internalGetFieldAccessorTable()
protected com.google.protobuf.MapField
internalGetMapField(int number)
boolean
isInitialized()
static TrainingPipeline.Builder
newBuilder()
static TrainingPipeline.Builder
newBuilder(TrainingPipeline prototype)
TrainingPipeline.Builder
newBuilderForType()
protected TrainingPipeline.Builder
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static TrainingPipeline
parseDelimitedFrom(InputStream input)
static TrainingPipeline
parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static TrainingPipeline
parseFrom(byte[] data)
static TrainingPipeline
parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static TrainingPipeline
parseFrom(com.google.protobuf.ByteString data)
static TrainingPipeline
parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static TrainingPipeline
parseFrom(com.google.protobuf.CodedInputStream input)
static TrainingPipeline
parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static TrainingPipeline
parseFrom(InputStream input)
static TrainingPipeline
parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static TrainingPipeline
parseFrom(ByteBuffer data)
static TrainingPipeline
parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<TrainingPipeline>
parser()
TrainingPipeline.Builder
toBuilder()
void
writeTo(com.google.protobuf.CodedOutputStream output)
-
Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag
-
Methods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString
-
Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
-
-
-
Field Detail
-
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
- See Also:
- Constant Field Values
-
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
- See Also:
- Constant Field Values
-
INPUT_DATA_CONFIG_FIELD_NUMBER
public static final int INPUT_DATA_CONFIG_FIELD_NUMBER
- See Also:
- Constant Field Values
-
TRAINING_TASK_DEFINITION_FIELD_NUMBER
public static final int TRAINING_TASK_DEFINITION_FIELD_NUMBER
- See Also:
- Constant Field Values
-
TRAINING_TASK_INPUTS_FIELD_NUMBER
public static final int TRAINING_TASK_INPUTS_FIELD_NUMBER
- See Also:
- Constant Field Values
-
TRAINING_TASK_METADATA_FIELD_NUMBER
public static final int TRAINING_TASK_METADATA_FIELD_NUMBER
- See Also:
- Constant Field Values
-
MODEL_TO_UPLOAD_FIELD_NUMBER
public static final int MODEL_TO_UPLOAD_FIELD_NUMBER
- See Also:
- Constant Field Values
-
MODEL_ID_FIELD_NUMBER
public static final int MODEL_ID_FIELD_NUMBER
- See Also:
- Constant Field Values
-
PARENT_MODEL_FIELD_NUMBER
public static final int PARENT_MODEL_FIELD_NUMBER
- See Also:
- Constant Field Values
-
STATE_FIELD_NUMBER
public static final int STATE_FIELD_NUMBER
- See Also:
- Constant Field Values
-
ERROR_FIELD_NUMBER
public static final int ERROR_FIELD_NUMBER
- See Also:
- Constant Field Values
-
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
- See Also:
- Constant Field Values
-
START_TIME_FIELD_NUMBER
public static final int START_TIME_FIELD_NUMBER
- See Also:
- Constant Field Values
-
END_TIME_FIELD_NUMBER
public static final int END_TIME_FIELD_NUMBER
- See Also:
- Constant Field Values
-
UPDATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER
- See Also:
- Constant Field Values
-
LABELS_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
- See Also:
- Constant Field Values
-
ENCRYPTION_SPEC_FIELD_NUMBER
public static final int ENCRYPTION_SPEC_FIELD_NUMBER
- See Also:
- Constant Field Values
-
-
Method Detail
-
newInstance
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
- Overrides:
newInstance
in classcom.google.protobuf.GeneratedMessageV3
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
-
internalGetMapField
protected com.google.protobuf.MapField internalGetMapField(int number)
- Overrides:
internalGetMapField
in classcom.google.protobuf.GeneratedMessageV3
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
- Specified by:
internalGetFieldAccessorTable
in classcom.google.protobuf.GeneratedMessageV3
-
getName
public String getName()
Output only. Resource name of the TrainingPipeline.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
- Specified by:
getName
in interfaceTrainingPipelineOrBuilder
- Returns:
- The name.
-
getNameBytes
public com.google.protobuf.ByteString getNameBytes()
Output only. Resource name of the TrainingPipeline.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
- Specified by:
getNameBytes
in interfaceTrainingPipelineOrBuilder
- Returns:
- The bytes for name.
-
getDisplayName
public String getDisplayName()
Required. The user-defined name of this TrainingPipeline.
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
- Specified by:
getDisplayName
in interfaceTrainingPipelineOrBuilder
- Returns:
- The displayName.
-
getDisplayNameBytes
public com.google.protobuf.ByteString getDisplayNameBytes()
Required. The user-defined name of this TrainingPipeline.
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
- Specified by:
getDisplayNameBytes
in interfaceTrainingPipelineOrBuilder
- Returns:
- The bytes for displayName.
-
hasInputDataConfig
public boolean hasInputDataConfig()
Specifies Vertex AI owned input data that may be used for training the Model. The TrainingPipeline's [training_task_definition][google.cloud.aiplatform.v1beta1.TrainingPipeline.training_task_definition] should make clear whether this config is used and if there are any special requirements on how it should be filled. If nothing about this config is mentioned in the [training_task_definition][google.cloud.aiplatform.v1beta1.TrainingPipeline.training_task_definition], then it should be assumed that the TrainingPipeline does not depend on this configuration.
.google.cloud.aiplatform.v1beta1.InputDataConfig input_data_config = 3;
- Specified by:
hasInputDataConfig
in interfaceTrainingPipelineOrBuilder
- Returns:
- Whether the inputDataConfig field is set.
-
getInputDataConfig
public InputDataConfig getInputDataConfig()
Specifies Vertex AI owned input data that may be used for training the Model. The TrainingPipeline's [training_task_definition][google.cloud.aiplatform.v1beta1.TrainingPipeline.training_task_definition] should make clear whether this config is used and if there are any special requirements on how it should be filled. If nothing about this config is mentioned in the [training_task_definition][google.cloud.aiplatform.v1beta1.TrainingPipeline.training_task_definition], then it should be assumed that the TrainingPipeline does not depend on this configuration.
.google.cloud.aiplatform.v1beta1.InputDataConfig input_data_config = 3;
- Specified by:
getInputDataConfig
in interfaceTrainingPipelineOrBuilder
- Returns:
- The inputDataConfig.
-
getInputDataConfigOrBuilder
public InputDataConfigOrBuilder getInputDataConfigOrBuilder()
Specifies Vertex AI owned input data that may be used for training the Model. The TrainingPipeline's [training_task_definition][google.cloud.aiplatform.v1beta1.TrainingPipeline.training_task_definition] should make clear whether this config is used and if there are any special requirements on how it should be filled. If nothing about this config is mentioned in the [training_task_definition][google.cloud.aiplatform.v1beta1.TrainingPipeline.training_task_definition], then it should be assumed that the TrainingPipeline does not depend on this configuration.
.google.cloud.aiplatform.v1beta1.InputDataConfig input_data_config = 3;
- Specified by:
getInputDataConfigOrBuilder
in interfaceTrainingPipelineOrBuilder
-
getTrainingTaskDefinition
public String getTrainingTaskDefinition()
Required. A Google Cloud Storage path to the YAML file that defines the training task which is responsible for producing the model artifact, and may also include additional auxiliary work. The definition files that can be used here are found in gs://google-cloud-aiplatform/schema/trainingjob/definition/. Note: The URI given on output will be immutable and probably different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access.
string training_task_definition = 4 [(.google.api.field_behavior) = REQUIRED];
- Specified by:
getTrainingTaskDefinition
in interfaceTrainingPipelineOrBuilder
- Returns:
- The trainingTaskDefinition.
-
getTrainingTaskDefinitionBytes
public com.google.protobuf.ByteString getTrainingTaskDefinitionBytes()
Required. A Google Cloud Storage path to the YAML file that defines the training task which is responsible for producing the model artifact, and may also include additional auxiliary work. The definition files that can be used here are found in gs://google-cloud-aiplatform/schema/trainingjob/definition/. Note: The URI given on output will be immutable and probably different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access.
string training_task_definition = 4 [(.google.api.field_behavior) = REQUIRED];
- Specified by:
getTrainingTaskDefinitionBytes
in interfaceTrainingPipelineOrBuilder
- Returns:
- The bytes for trainingTaskDefinition.
-
hasTrainingTaskInputs
public boolean hasTrainingTaskInputs()
Required. The training task's parameter(s), as specified in the [training_task_definition][google.cloud.aiplatform.v1beta1.TrainingPipeline.training_task_definition]'s `inputs`.
.google.protobuf.Value training_task_inputs = 5 [(.google.api.field_behavior) = REQUIRED];
- Specified by:
hasTrainingTaskInputs
in interfaceTrainingPipelineOrBuilder
- Returns:
- Whether the trainingTaskInputs field is set.
-
getTrainingTaskInputs
public com.google.protobuf.Value getTrainingTaskInputs()
Required. The training task's parameter(s), as specified in the [training_task_definition][google.cloud.aiplatform.v1beta1.TrainingPipeline.training_task_definition]'s `inputs`.
.google.protobuf.Value training_task_inputs = 5 [(.google.api.field_behavior) = REQUIRED];
- Specified by:
getTrainingTaskInputs
in interfaceTrainingPipelineOrBuilder
- Returns:
- The trainingTaskInputs.
-
getTrainingTaskInputsOrBuilder
public com.google.protobuf.ValueOrBuilder getTrainingTaskInputsOrBuilder()
Required. The training task's parameter(s), as specified in the [training_task_definition][google.cloud.aiplatform.v1beta1.TrainingPipeline.training_task_definition]'s `inputs`.
.google.protobuf.Value training_task_inputs = 5 [(.google.api.field_behavior) = REQUIRED];
- Specified by:
getTrainingTaskInputsOrBuilder
in interfaceTrainingPipelineOrBuilder
-
hasTrainingTaskMetadata
public boolean hasTrainingTaskMetadata()
Output only. The metadata information as specified in the [training_task_definition][google.cloud.aiplatform.v1beta1.TrainingPipeline.training_task_definition]'s `metadata`. This metadata is an auxiliary runtime and final information about the training task. While the pipeline is running this information is populated only at a best effort basis. Only present if the pipeline's [training_task_definition][google.cloud.aiplatform.v1beta1.TrainingPipeline.training_task_definition] contains `metadata` object.
.google.protobuf.Value training_task_metadata = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
- Specified by:
hasTrainingTaskMetadata
in interfaceTrainingPipelineOrBuilder
- Returns:
- Whether the trainingTaskMetadata field is set.
-
getTrainingTaskMetadata
public com.google.protobuf.Value getTrainingTaskMetadata()
Output only. The metadata information as specified in the [training_task_definition][google.cloud.aiplatform.v1beta1.TrainingPipeline.training_task_definition]'s `metadata`. This metadata is an auxiliary runtime and final information about the training task. While the pipeline is running this information is populated only at a best effort basis. Only present if the pipeline's [training_task_definition][google.cloud.aiplatform.v1beta1.TrainingPipeline.training_task_definition] contains `metadata` object.
.google.protobuf.Value training_task_metadata = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
- Specified by:
getTrainingTaskMetadata
in interfaceTrainingPipelineOrBuilder
- Returns:
- The trainingTaskMetadata.
-
getTrainingTaskMetadataOrBuilder
public com.google.protobuf.ValueOrBuilder getTrainingTaskMetadataOrBuilder()
Output only. The metadata information as specified in the [training_task_definition][google.cloud.aiplatform.v1beta1.TrainingPipeline.training_task_definition]'s `metadata`. This metadata is an auxiliary runtime and final information about the training task. While the pipeline is running this information is populated only at a best effort basis. Only present if the pipeline's [training_task_definition][google.cloud.aiplatform.v1beta1.TrainingPipeline.training_task_definition] contains `metadata` object.
.google.protobuf.Value training_task_metadata = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
- Specified by:
getTrainingTaskMetadataOrBuilder
in interfaceTrainingPipelineOrBuilder
-
hasModelToUpload
public boolean hasModelToUpload()
Describes the Model that may be uploaded (via [ModelService.UploadModel][google.cloud.aiplatform.v1beta1.ModelService.UploadModel]) by this TrainingPipeline. The TrainingPipeline's [training_task_definition][google.cloud.aiplatform.v1beta1.TrainingPipeline.training_task_definition] should make clear whether this Model description should be populated, and if there are any special requirements regarding how it should be filled. If nothing is mentioned in the [training_task_definition][google.cloud.aiplatform.v1beta1.TrainingPipeline.training_task_definition], then it should be assumed that this field should not be filled and the training task either uploads the Model without a need of this information, or that training task does not support uploading a Model as part of the pipeline. When the Pipeline's state becomes `PIPELINE_STATE_SUCCEEDED` and the trained Model had been uploaded into Vertex AI, then the model_to_upload's resource [name][google.cloud.aiplatform.v1beta1.Model.name] is populated. The Model is always uploaded into the Project and Location in which this pipeline is.
.google.cloud.aiplatform.v1beta1.Model model_to_upload = 7;
- Specified by:
hasModelToUpload
in interfaceTrainingPipelineOrBuilder
- Returns:
- Whether the modelToUpload field is set.
-
getModelToUpload
public Model getModelToUpload()
Describes the Model that may be uploaded (via [ModelService.UploadModel][google.cloud.aiplatform.v1beta1.ModelService.UploadModel]) by this TrainingPipeline. The TrainingPipeline's [training_task_definition][google.cloud.aiplatform.v1beta1.TrainingPipeline.training_task_definition] should make clear whether this Model description should be populated, and if there are any special requirements regarding how it should be filled. If nothing is mentioned in the [training_task_definition][google.cloud.aiplatform.v1beta1.TrainingPipeline.training_task_definition], then it should be assumed that this field should not be filled and the training task either uploads the Model without a need of this information, or that training task does not support uploading a Model as part of the pipeline. When the Pipeline's state becomes `PIPELINE_STATE_SUCCEEDED` and the trained Model had been uploaded into Vertex AI, then the model_to_upload's resource [name][google.cloud.aiplatform.v1beta1.Model.name] is populated. The Model is always uploaded into the Project and Location in which this pipeline is.
.google.cloud.aiplatform.v1beta1.Model model_to_upload = 7;
- Specified by:
getModelToUpload
in interfaceTrainingPipelineOrBuilder
- Returns:
- The modelToUpload.
-
getModelToUploadOrBuilder
public ModelOrBuilder getModelToUploadOrBuilder()
Describes the Model that may be uploaded (via [ModelService.UploadModel][google.cloud.aiplatform.v1beta1.ModelService.UploadModel]) by this TrainingPipeline. The TrainingPipeline's [training_task_definition][google.cloud.aiplatform.v1beta1.TrainingPipeline.training_task_definition] should make clear whether this Model description should be populated, and if there are any special requirements regarding how it should be filled. If nothing is mentioned in the [training_task_definition][google.cloud.aiplatform.v1beta1.TrainingPipeline.training_task_definition], then it should be assumed that this field should not be filled and the training task either uploads the Model without a need of this information, or that training task does not support uploading a Model as part of the pipeline. When the Pipeline's state becomes `PIPELINE_STATE_SUCCEEDED` and the trained Model had been uploaded into Vertex AI, then the model_to_upload's resource [name][google.cloud.aiplatform.v1beta1.Model.name] is populated. The Model is always uploaded into the Project and Location in which this pipeline is.
.google.cloud.aiplatform.v1beta1.Model model_to_upload = 7;
- Specified by:
getModelToUploadOrBuilder
in interfaceTrainingPipelineOrBuilder
-
getModelId
public String getModelId()
Optional. The ID to use for the uploaded Model, which will become the final component of the model resource name. This value may be up to 63 characters, and valid characters are `[a-z0-9_-]`. The first character cannot be a number or hyphen.
string model_id = 22 [(.google.api.field_behavior) = OPTIONAL];
- Specified by:
getModelId
in interfaceTrainingPipelineOrBuilder
- Returns:
- The modelId.
-
getModelIdBytes
public com.google.protobuf.ByteString getModelIdBytes()
Optional. The ID to use for the uploaded Model, which will become the final component of the model resource name. This value may be up to 63 characters, and valid characters are `[a-z0-9_-]`. The first character cannot be a number or hyphen.
string model_id = 22 [(.google.api.field_behavior) = OPTIONAL];
- Specified by:
getModelIdBytes
in interfaceTrainingPipelineOrBuilder
- Returns:
- The bytes for modelId.
-
getParentModel
public String getParentModel()
Optional. When specify this field, the `model_to_upload` will not be uploaded as a new model, instead, it will become a new version of this `parent_model`.
string parent_model = 21 [(.google.api.field_behavior) = OPTIONAL];
- Specified by:
getParentModel
in interfaceTrainingPipelineOrBuilder
- Returns:
- The parentModel.
-
getParentModelBytes
public com.google.protobuf.ByteString getParentModelBytes()
Optional. When specify this field, the `model_to_upload` will not be uploaded as a new model, instead, it will become a new version of this `parent_model`.
string parent_model = 21 [(.google.api.field_behavior) = OPTIONAL];
- Specified by:
getParentModelBytes
in interfaceTrainingPipelineOrBuilder
- Returns:
- The bytes for parentModel.
-
getStateValue
public int getStateValue()
Output only. The detailed state of the pipeline.
.google.cloud.aiplatform.v1beta1.PipelineState state = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
- Specified by:
getStateValue
in interfaceTrainingPipelineOrBuilder
- Returns:
- The enum numeric value on the wire for state.
-
getState
public PipelineState getState()
Output only. The detailed state of the pipeline.
.google.cloud.aiplatform.v1beta1.PipelineState state = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
- Specified by:
getState
in interfaceTrainingPipelineOrBuilder
- Returns:
- The state.
-
hasError
public boolean hasError()
Output only. Only populated when the pipeline's state is `PIPELINE_STATE_FAILED` or `PIPELINE_STATE_CANCELLED`.
.google.rpc.Status error = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
- Specified by:
hasError
in interfaceTrainingPipelineOrBuilder
- Returns:
- Whether the error field is set.
-
getError
public com.google.rpc.Status getError()
Output only. Only populated when the pipeline's state is `PIPELINE_STATE_FAILED` or `PIPELINE_STATE_CANCELLED`.
.google.rpc.Status error = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
- Specified by:
getError
in interfaceTrainingPipelineOrBuilder
- Returns:
- The error.
-
getErrorOrBuilder
public com.google.rpc.StatusOrBuilder getErrorOrBuilder()
Output only. Only populated when the pipeline's state is `PIPELINE_STATE_FAILED` or `PIPELINE_STATE_CANCELLED`.
.google.rpc.Status error = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
- Specified by:
getErrorOrBuilder
in interfaceTrainingPipelineOrBuilder
-
hasCreateTime
public boolean hasCreateTime()
Output only. Time when the TrainingPipeline was created.
.google.protobuf.Timestamp create_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
- Specified by:
hasCreateTime
in interfaceTrainingPipelineOrBuilder
- Returns:
- Whether the createTime field is set.
-
getCreateTime
public com.google.protobuf.Timestamp getCreateTime()
Output only. Time when the TrainingPipeline was created.
.google.protobuf.Timestamp create_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
- Specified by:
getCreateTime
in interfaceTrainingPipelineOrBuilder
- Returns:
- The createTime.
-
getCreateTimeOrBuilder
public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
Output only. Time when the TrainingPipeline was created.
.google.protobuf.Timestamp create_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
- Specified by:
getCreateTimeOrBuilder
in interfaceTrainingPipelineOrBuilder
-
hasStartTime
public boolean hasStartTime()
Output only. Time when the TrainingPipeline for the first time entered the `PIPELINE_STATE_RUNNING` state.
.google.protobuf.Timestamp start_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
- Specified by:
hasStartTime
in interfaceTrainingPipelineOrBuilder
- Returns:
- Whether the startTime field is set.
-
getStartTime
public com.google.protobuf.Timestamp getStartTime()
Output only. Time when the TrainingPipeline for the first time entered the `PIPELINE_STATE_RUNNING` state.
.google.protobuf.Timestamp start_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
- Specified by:
getStartTime
in interfaceTrainingPipelineOrBuilder
- Returns:
- The startTime.
-
getStartTimeOrBuilder
public com.google.protobuf.TimestampOrBuilder getStartTimeOrBuilder()
Output only. Time when the TrainingPipeline for the first time entered the `PIPELINE_STATE_RUNNING` state.
.google.protobuf.Timestamp start_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
- Specified by:
getStartTimeOrBuilder
in interfaceTrainingPipelineOrBuilder
-
hasEndTime
public boolean hasEndTime()
Output only. Time when the TrainingPipeline entered any of the following states: `PIPELINE_STATE_SUCCEEDED`, `PIPELINE_STATE_FAILED`, `PIPELINE_STATE_CANCELLED`.
.google.protobuf.Timestamp end_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
- Specified by:
hasEndTime
in interfaceTrainingPipelineOrBuilder
- Returns:
- Whether the endTime field is set.
-
getEndTime
public com.google.protobuf.Timestamp getEndTime()
Output only. Time when the TrainingPipeline entered any of the following states: `PIPELINE_STATE_SUCCEEDED`, `PIPELINE_STATE_FAILED`, `PIPELINE_STATE_CANCELLED`.
.google.protobuf.Timestamp end_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
- Specified by:
getEndTime
in interfaceTrainingPipelineOrBuilder
- Returns:
- The endTime.
-
getEndTimeOrBuilder
public com.google.protobuf.TimestampOrBuilder getEndTimeOrBuilder()
Output only. Time when the TrainingPipeline entered any of the following states: `PIPELINE_STATE_SUCCEEDED`, `PIPELINE_STATE_FAILED`, `PIPELINE_STATE_CANCELLED`.
.google.protobuf.Timestamp end_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
- Specified by:
getEndTimeOrBuilder
in interfaceTrainingPipelineOrBuilder
-
hasUpdateTime
public boolean hasUpdateTime()
Output only. Time when the TrainingPipeline was most recently updated.
.google.protobuf.Timestamp update_time = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
- Specified by:
hasUpdateTime
in interfaceTrainingPipelineOrBuilder
- Returns:
- Whether the updateTime field is set.
-
getUpdateTime
public com.google.protobuf.Timestamp getUpdateTime()
Output only. Time when the TrainingPipeline was most recently updated.
.google.protobuf.Timestamp update_time = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
- Specified by:
getUpdateTime
in interfaceTrainingPipelineOrBuilder
- Returns:
- The updateTime.
-
getUpdateTimeOrBuilder
public com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
Output only. Time when the TrainingPipeline was most recently updated.
.google.protobuf.Timestamp update_time = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
- Specified by:
getUpdateTimeOrBuilder
in interfaceTrainingPipelineOrBuilder
-
getLabelsCount
public int getLabelsCount()
Description copied from interface:TrainingPipelineOrBuilder
The labels with user-defined metadata to organize TrainingPipelines. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.
map<string, string> labels = 15;
- Specified by:
getLabelsCount
in interfaceTrainingPipelineOrBuilder
-
containsLabels
public boolean containsLabels(String key)
The labels with user-defined metadata to organize TrainingPipelines. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.
map<string, string> labels = 15;
- Specified by:
containsLabels
in interfaceTrainingPipelineOrBuilder
-
getLabels
@Deprecated public Map<String,String> getLabels()
Deprecated.UsegetLabelsMap()
instead.- Specified by:
getLabels
in interfaceTrainingPipelineOrBuilder
-
getLabelsMap
public Map<String,String> getLabelsMap()
The labels with user-defined metadata to organize TrainingPipelines. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.
map<string, string> labels = 15;
- Specified by:
getLabelsMap
in interfaceTrainingPipelineOrBuilder
-
getLabelsOrDefault
public String getLabelsOrDefault(String key, String defaultValue)
The labels with user-defined metadata to organize TrainingPipelines. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.
map<string, string> labels = 15;
- Specified by:
getLabelsOrDefault
in interfaceTrainingPipelineOrBuilder
-
getLabelsOrThrow
public String getLabelsOrThrow(String key)
The labels with user-defined metadata to organize TrainingPipelines. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.
map<string, string> labels = 15;
- Specified by:
getLabelsOrThrow
in interfaceTrainingPipelineOrBuilder
-
hasEncryptionSpec
public boolean hasEncryptionSpec()
Customer-managed encryption key spec for a TrainingPipeline. If set, this TrainingPipeline will be secured by this key. Note: Model trained by this TrainingPipeline is also secured by this key if [model_to_upload][google.cloud.aiplatform.v1beta1.TrainingPipeline.encryption_spec] is not set separately.
.google.cloud.aiplatform.v1beta1.EncryptionSpec encryption_spec = 18;
- Specified by:
hasEncryptionSpec
in interfaceTrainingPipelineOrBuilder
- Returns:
- Whether the encryptionSpec field is set.
-
getEncryptionSpec
public EncryptionSpec getEncryptionSpec()
Customer-managed encryption key spec for a TrainingPipeline. If set, this TrainingPipeline will be secured by this key. Note: Model trained by this TrainingPipeline is also secured by this key if [model_to_upload][google.cloud.aiplatform.v1beta1.TrainingPipeline.encryption_spec] is not set separately.
.google.cloud.aiplatform.v1beta1.EncryptionSpec encryption_spec = 18;
- Specified by:
getEncryptionSpec
in interfaceTrainingPipelineOrBuilder
- Returns:
- The encryptionSpec.
-
getEncryptionSpecOrBuilder
public EncryptionSpecOrBuilder getEncryptionSpecOrBuilder()
Customer-managed encryption key spec for a TrainingPipeline. If set, this TrainingPipeline will be secured by this key. Note: Model trained by this TrainingPipeline is also secured by this key if [model_to_upload][google.cloud.aiplatform.v1beta1.TrainingPipeline.encryption_spec] is not set separately.
.google.cloud.aiplatform.v1beta1.EncryptionSpec encryption_spec = 18;
- Specified by:
getEncryptionSpecOrBuilder
in interfaceTrainingPipelineOrBuilder
-
isInitialized
public final boolean isInitialized()
- Specified by:
isInitialized
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Overrides:
isInitialized
in classcom.google.protobuf.GeneratedMessageV3
-
writeTo
public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
- Specified by:
writeTo
in interfacecom.google.protobuf.MessageLite
- Overrides:
writeTo
in classcom.google.protobuf.GeneratedMessageV3
- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()
- Specified by:
getSerializedSize
in interfacecom.google.protobuf.MessageLite
- Overrides:
getSerializedSize
in classcom.google.protobuf.GeneratedMessageV3
-
equals
public boolean equals(Object obj)
- Specified by:
equals
in interfacecom.google.protobuf.Message
- Overrides:
equals
in classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()
- Specified by:
hashCode
in interfacecom.google.protobuf.Message
- Overrides:
hashCode
in classcom.google.protobuf.AbstractMessage
-
parseFrom
public static TrainingPipeline parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static TrainingPipeline parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static TrainingPipeline parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static TrainingPipeline parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static TrainingPipeline parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static TrainingPipeline parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static TrainingPipeline parseFrom(InputStream input) throws IOException
- Throws:
IOException
-
parseFrom
public static TrainingPipeline parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
- Throws:
IOException
-
parseDelimitedFrom
public static TrainingPipeline parseDelimitedFrom(InputStream input) throws IOException
- Throws:
IOException
-
parseDelimitedFrom
public static TrainingPipeline parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
- Throws:
IOException
-
parseFrom
public static TrainingPipeline parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
- Throws:
IOException
-
parseFrom
public static TrainingPipeline parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
- Throws:
IOException
-
newBuilderForType
public TrainingPipeline.Builder newBuilderForType()
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.Message
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.MessageLite
-
newBuilder
public static TrainingPipeline.Builder newBuilder()
-
newBuilder
public static TrainingPipeline.Builder newBuilder(TrainingPipeline prototype)
-
toBuilder
public TrainingPipeline.Builder toBuilder()
- Specified by:
toBuilder
in interfacecom.google.protobuf.Message
- Specified by:
toBuilder
in interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected TrainingPipeline.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
- Specified by:
newBuilderForType
in classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstance
public static TrainingPipeline getDefaultInstance()
-
parser
public static com.google.protobuf.Parser<TrainingPipeline> parser()
-
getParserForType
public com.google.protobuf.Parser<TrainingPipeline> getParserForType()
- Specified by:
getParserForType
in interfacecom.google.protobuf.Message
- Specified by:
getParserForType
in interfacecom.google.protobuf.MessageLite
- Overrides:
getParserForType
in classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstanceForType
public TrainingPipeline getDefaultInstanceForType()
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-
-