Class 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 type google.cloud.aiplatform.v1beta1.TrainingPipeline
    See Also:
    Serialized Form
    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.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 class com.google.protobuf.GeneratedMessageV3
      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.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 interface TrainingPipelineOrBuilder
        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 interface TrainingPipelineOrBuilder
        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 interface TrainingPipelineOrBuilder
        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 interface TrainingPipelineOrBuilder
        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 interface TrainingPipelineOrBuilder
        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 interface TrainingPipelineOrBuilder
        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 interface TrainingPipelineOrBuilder
      • 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 interface TrainingPipelineOrBuilder
        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 interface TrainingPipelineOrBuilder
        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 interface TrainingPipelineOrBuilder
        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 interface TrainingPipelineOrBuilder
        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 interface TrainingPipelineOrBuilder
      • 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 interface TrainingPipelineOrBuilder
        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 interface TrainingPipelineOrBuilder
        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 interface TrainingPipelineOrBuilder
      • 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 interface TrainingPipelineOrBuilder
        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 interface TrainingPipelineOrBuilder
        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 interface TrainingPipelineOrBuilder
      • 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 interface TrainingPipelineOrBuilder
        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 interface TrainingPipelineOrBuilder
        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 interface TrainingPipelineOrBuilder
        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 interface TrainingPipelineOrBuilder
        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 interface TrainingPipelineOrBuilder
        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 interface TrainingPipelineOrBuilder
        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 interface TrainingPipelineOrBuilder
        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 interface TrainingPipelineOrBuilder
        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 interface TrainingPipelineOrBuilder
      • 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 interface TrainingPipelineOrBuilder
        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 interface TrainingPipelineOrBuilder
        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 interface TrainingPipelineOrBuilder
      • 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 interface TrainingPipelineOrBuilder
        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 interface TrainingPipelineOrBuilder
        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 interface TrainingPipelineOrBuilder
      • 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 interface TrainingPipelineOrBuilder
        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 interface TrainingPipelineOrBuilder
        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 interface TrainingPipelineOrBuilder
      • 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 interface TrainingPipelineOrBuilder
        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 interface TrainingPipelineOrBuilder
        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 interface TrainingPipelineOrBuilder
      • 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 interface TrainingPipelineOrBuilder
      • 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 interface TrainingPipelineOrBuilder
      • 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 interface TrainingPipelineOrBuilder
      • 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 interface TrainingPipelineOrBuilder
      • 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 interface TrainingPipelineOrBuilder
      • 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 interface TrainingPipelineOrBuilder
        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 interface TrainingPipelineOrBuilder
        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 interface TrainingPipelineOrBuilder
      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3
      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
                     throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException
      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3
      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage
      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.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​(com.google.protobuf.CodedInputStream input,
                                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                          throws IOException
        Throws:
        IOException
      • newBuilderForType

        public TrainingPipeline.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite
      • toBuilder

        public TrainingPipeline.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite
      • newBuilderForType

        protected TrainingPipeline.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3
      • getParserForType

        public com.google.protobuf.Parser<TrainingPipeline> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3
      • getDefaultInstanceForType

        public TrainingPipeline getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder