Package com.google.cloud.aiplatform.v1
Class TrainingPipeline
- java.lang.Object
-
- com.google.protobuf.AbstractMessageLite
-
- com.google.protobuf.AbstractMessage
-
- com.google.protobuf.GeneratedMessageV3
-
- com.google.cloud.aiplatform.v1.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.v1.ModelService.UploadModel] the Model to Vertex AI, and evaluate the Model.
Protobuf typegoogle.cloud.aiplatform.v1.TrainingPipeline- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classTrainingPipeline.BuilderThe 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 intCREATE_TIME_FIELD_NUMBERstatic intDISPLAY_NAME_FIELD_NUMBERstatic intENCRYPTION_SPEC_FIELD_NUMBERstatic intEND_TIME_FIELD_NUMBERstatic intERROR_FIELD_NUMBERstatic intINPUT_DATA_CONFIG_FIELD_NUMBERstatic intLABELS_FIELD_NUMBERstatic intMODEL_ID_FIELD_NUMBERstatic intMODEL_TO_UPLOAD_FIELD_NUMBERstatic intNAME_FIELD_NUMBERstatic intPARENT_MODEL_FIELD_NUMBERstatic intSTART_TIME_FIELD_NUMBERstatic intSTATE_FIELD_NUMBERstatic intTRAINING_TASK_DEFINITION_FIELD_NUMBERstatic intTRAINING_TASK_INPUTS_FIELD_NUMBERstatic intTRAINING_TASK_METADATA_FIELD_NUMBERstatic intUPDATE_TIME_FIELD_NUMBER
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description booleancontainsLabels(String key)The labels with user-defined metadata to organize TrainingPipelines.booleanequals(Object obj)com.google.protobuf.TimestampgetCreateTime()Output only.com.google.protobuf.TimestampOrBuildergetCreateTimeOrBuilder()Output only.static TrainingPipelinegetDefaultInstance()TrainingPipelinegetDefaultInstanceForType()static com.google.protobuf.Descriptors.DescriptorgetDescriptor()StringgetDisplayName()Required.com.google.protobuf.ByteStringgetDisplayNameBytes()Required.EncryptionSpecgetEncryptionSpec()Customer-managed encryption key spec for a TrainingPipeline.EncryptionSpecOrBuildergetEncryptionSpecOrBuilder()Customer-managed encryption key spec for a TrainingPipeline.com.google.protobuf.TimestampgetEndTime()Output only.com.google.protobuf.TimestampOrBuildergetEndTimeOrBuilder()Output only.com.google.rpc.StatusgetError()Output only.com.google.rpc.StatusOrBuildergetErrorOrBuilder()Output only.InputDataConfiggetInputDataConfig()Specifies Vertex AI owned input data that may be used for training the Model.InputDataConfigOrBuildergetInputDataConfigOrBuilder()Specifies Vertex AI owned input data that may be used for training the Model.Map<String,String>getLabels()Deprecated.intgetLabelsCount()The labels with user-defined metadata to organize TrainingPipelines.Map<String,String>getLabelsMap()The labels with user-defined metadata to organize TrainingPipelines.StringgetLabelsOrDefault(String key, String defaultValue)The labels with user-defined metadata to organize TrainingPipelines.StringgetLabelsOrThrow(String key)The labels with user-defined metadata to organize TrainingPipelines.StringgetModelId()Optional.com.google.protobuf.ByteStringgetModelIdBytes()Optional.ModelgetModelToUpload()Describes the Model that may be uploaded (via [ModelService.UploadModel][google.cloud.aiplatform.v1.ModelService.UploadModel]) by this TrainingPipeline.ModelOrBuildergetModelToUploadOrBuilder()Describes the Model that may be uploaded (via [ModelService.UploadModel][google.cloud.aiplatform.v1.ModelService.UploadModel]) by this TrainingPipeline.StringgetName()Output only.com.google.protobuf.ByteStringgetNameBytes()Output only.StringgetParentModel()Optional.com.google.protobuf.ByteStringgetParentModelBytes()Optional.com.google.protobuf.Parser<TrainingPipeline>getParserForType()intgetSerializedSize()com.google.protobuf.TimestampgetStartTime()Output only.com.google.protobuf.TimestampOrBuildergetStartTimeOrBuilder()Output only.PipelineStategetState()Output only.intgetStateValue()Output only.StringgetTrainingTaskDefinition()Required.com.google.protobuf.ByteStringgetTrainingTaskDefinitionBytes()Required.com.google.protobuf.ValuegetTrainingTaskInputs()Required.com.google.protobuf.ValueOrBuildergetTrainingTaskInputsOrBuilder()Required.com.google.protobuf.ValuegetTrainingTaskMetadata()Output only.com.google.protobuf.ValueOrBuildergetTrainingTaskMetadataOrBuilder()Output only.com.google.protobuf.TimestampgetUpdateTime()Output only.com.google.protobuf.TimestampOrBuildergetUpdateTimeOrBuilder()Output only.booleanhasCreateTime()Output only.booleanhasEncryptionSpec()Customer-managed encryption key spec for a TrainingPipeline.booleanhasEndTime()Output only.booleanhasError()Output only.inthashCode()booleanhasInputDataConfig()Specifies Vertex AI owned input data that may be used for training the Model.booleanhasModelToUpload()Describes the Model that may be uploaded (via [ModelService.UploadModel][google.cloud.aiplatform.v1.ModelService.UploadModel]) by this TrainingPipeline.booleanhasStartTime()Output only.booleanhasTrainingTaskInputs()Required.booleanhasTrainingTaskMetadata()Output only.booleanhasUpdateTime()Output only.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()protected com.google.protobuf.MapFieldinternalGetMapField(int number)booleanisInitialized()static TrainingPipeline.BuildernewBuilder()static TrainingPipeline.BuildernewBuilder(TrainingPipeline prototype)TrainingPipeline.BuildernewBuilderForType()protected TrainingPipeline.BuildernewBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)protected ObjectnewInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)static TrainingPipelineparseDelimitedFrom(InputStream input)static TrainingPipelineparseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static TrainingPipelineparseFrom(byte[] data)static TrainingPipelineparseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static TrainingPipelineparseFrom(com.google.protobuf.ByteString data)static TrainingPipelineparseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static TrainingPipelineparseFrom(com.google.protobuf.CodedInputStream input)static TrainingPipelineparseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static TrainingPipelineparseFrom(InputStream input)static TrainingPipelineparseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static TrainingPipelineparseFrom(ByteBuffer data)static TrainingPipelineparseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static com.google.protobuf.Parser<TrainingPipeline>parser()TrainingPipeline.BuildertoBuilder()voidwriteTo(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:
newInstancein classcom.google.protobuf.GeneratedMessageV3
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
-
internalGetMapField
protected com.google.protobuf.MapField internalGetMapField(int number)
- Overrides:
internalGetMapFieldin classcom.google.protobuf.GeneratedMessageV3
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
- Specified by:
internalGetFieldAccessorTablein 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:
getNamein 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:
getNameBytesin 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:
getDisplayNamein 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:
getDisplayNameBytesin 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.v1.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.v1.TrainingPipeline.training_task_definition], then it should be assumed that the TrainingPipeline does not depend on this configuration.
.google.cloud.aiplatform.v1.InputDataConfig input_data_config = 3;- Specified by:
hasInputDataConfigin 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.v1.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.v1.TrainingPipeline.training_task_definition], then it should be assumed that the TrainingPipeline does not depend on this configuration.
.google.cloud.aiplatform.v1.InputDataConfig input_data_config = 3;- Specified by:
getInputDataConfigin 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.v1.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.v1.TrainingPipeline.training_task_definition], then it should be assumed that the TrainingPipeline does not depend on this configuration.
.google.cloud.aiplatform.v1.InputDataConfig input_data_config = 3;- Specified by:
getInputDataConfigOrBuilderin 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:
getTrainingTaskDefinitionin 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:
getTrainingTaskDefinitionBytesin 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.v1.TrainingPipeline.training_task_definition]'s `inputs`.
.google.protobuf.Value training_task_inputs = 5 [(.google.api.field_behavior) = REQUIRED];- Specified by:
hasTrainingTaskInputsin 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.v1.TrainingPipeline.training_task_definition]'s `inputs`.
.google.protobuf.Value training_task_inputs = 5 [(.google.api.field_behavior) = REQUIRED];- Specified by:
getTrainingTaskInputsin 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.v1.TrainingPipeline.training_task_definition]'s `inputs`.
.google.protobuf.Value training_task_inputs = 5 [(.google.api.field_behavior) = REQUIRED];- Specified by:
getTrainingTaskInputsOrBuilderin interfaceTrainingPipelineOrBuilder
-
hasTrainingTaskMetadata
public boolean hasTrainingTaskMetadata()
Output only. The metadata information as specified in the [training_task_definition][google.cloud.aiplatform.v1.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.v1.TrainingPipeline.training_task_definition] contains `metadata` object.
.google.protobuf.Value training_task_metadata = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
hasTrainingTaskMetadatain 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.v1.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.v1.TrainingPipeline.training_task_definition] contains `metadata` object.
.google.protobuf.Value training_task_metadata = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getTrainingTaskMetadatain 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.v1.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.v1.TrainingPipeline.training_task_definition] contains `metadata` object.
.google.protobuf.Value training_task_metadata = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getTrainingTaskMetadataOrBuilderin interfaceTrainingPipelineOrBuilder
-
hasModelToUpload
public boolean hasModelToUpload()
Describes the Model that may be uploaded (via [ModelService.UploadModel][google.cloud.aiplatform.v1.ModelService.UploadModel]) by this TrainingPipeline. The TrainingPipeline's [training_task_definition][google.cloud.aiplatform.v1.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.v1.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.v1.Model.name] is populated. The Model is always uploaded into the Project and Location in which this pipeline is.
.google.cloud.aiplatform.v1.Model model_to_upload = 7;- Specified by:
hasModelToUploadin 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.v1.ModelService.UploadModel]) by this TrainingPipeline. The TrainingPipeline's [training_task_definition][google.cloud.aiplatform.v1.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.v1.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.v1.Model.name] is populated. The Model is always uploaded into the Project and Location in which this pipeline is.
.google.cloud.aiplatform.v1.Model model_to_upload = 7;- Specified by:
getModelToUploadin interfaceTrainingPipelineOrBuilder- Returns:
- The modelToUpload.
-
getModelToUploadOrBuilder
public ModelOrBuilder getModelToUploadOrBuilder()
Describes the Model that may be uploaded (via [ModelService.UploadModel][google.cloud.aiplatform.v1.ModelService.UploadModel]) by this TrainingPipeline. The TrainingPipeline's [training_task_definition][google.cloud.aiplatform.v1.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.v1.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.v1.Model.name] is populated. The Model is always uploaded into the Project and Location in which this pipeline is.
.google.cloud.aiplatform.v1.Model model_to_upload = 7;- Specified by:
getModelToUploadOrBuilderin 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:
getModelIdin 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:
getModelIdBytesin 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:
getParentModelin 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:
getParentModelBytesin interfaceTrainingPipelineOrBuilder- Returns:
- The bytes for parentModel.
-
getStateValue
public int getStateValue()
Output only. The detailed state of the pipeline.
.google.cloud.aiplatform.v1.PipelineState state = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getStateValuein 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.v1.PipelineState state = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getStatein 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:
hasErrorin 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:
getErrorin 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:
getErrorOrBuilderin 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:
hasCreateTimein 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:
getCreateTimein 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:
getCreateTimeOrBuilderin 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:
hasStartTimein 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:
getStartTimein 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:
getStartTimeOrBuilderin 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:
hasEndTimein 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:
getEndTimein 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:
getEndTimeOrBuilderin 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:
hasUpdateTimein 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:
getUpdateTimein 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:
getUpdateTimeOrBuilderin interfaceTrainingPipelineOrBuilder
-
getLabelsCount
public int getLabelsCount()
Description copied from interface:TrainingPipelineOrBuilderThe 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:
getLabelsCountin 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:
containsLabelsin interfaceTrainingPipelineOrBuilder
-
getLabels
@Deprecated public Map<String,String> getLabels()
Deprecated.UsegetLabelsMap()instead.- Specified by:
getLabelsin 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:
getLabelsMapin 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:
getLabelsOrDefaultin 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:
getLabelsOrThrowin 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.v1.TrainingPipeline.encryption_spec] is not set separately.
.google.cloud.aiplatform.v1.EncryptionSpec encryption_spec = 18;- Specified by:
hasEncryptionSpecin 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.v1.TrainingPipeline.encryption_spec] is not set separately.
.google.cloud.aiplatform.v1.EncryptionSpec encryption_spec = 18;- Specified by:
getEncryptionSpecin 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.v1.TrainingPipeline.encryption_spec] is not set separately.
.google.cloud.aiplatform.v1.EncryptionSpec encryption_spec = 18;- Specified by:
getEncryptionSpecOrBuilderin interfaceTrainingPipelineOrBuilder
-
isInitialized
public final boolean isInitialized()
- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessageV3
-
writeTo
public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException- Specified by:
writeToin interfacecom.google.protobuf.MessageLite- Overrides:
writeToin classcom.google.protobuf.GeneratedMessageV3- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()
- Specified by:
getSerializedSizein interfacecom.google.protobuf.MessageLite- Overrides:
getSerializedSizein classcom.google.protobuf.GeneratedMessageV3
-
equals
public boolean equals(Object obj)
- Specified by:
equalsin interfacecom.google.protobuf.Message- Overrides:
equalsin classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()
- Specified by:
hashCodein interfacecom.google.protobuf.Message- Overrides:
hashCodein 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:
newBuilderForTypein interfacecom.google.protobuf.Message- Specified by:
newBuilderForTypein 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:
toBuilderin interfacecom.google.protobuf.Message- Specified by:
toBuilderin interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected TrainingPipeline.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
- Specified by:
newBuilderForTypein 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:
getParserForTypein interfacecom.google.protobuf.Message- Specified by:
getParserForTypein interfacecom.google.protobuf.MessageLite- Overrides:
getParserForTypein classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstanceForType
public TrainingPipeline getDefaultInstanceForType()
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-
-