Package com.google.cloud.aiplatform.v1

Class PipelineJob.RuntimeConfig

    • Field Detail

      • PARAMETERS_FIELD_NUMBER

        public static final int PARAMETERS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • GCS_OUTPUT_DIRECTORY_FIELD_NUMBER

        public static final int GCS_OUTPUT_DIRECTORY_FIELD_NUMBER
        See Also:
        Constant Field Values

      • PARAMETER_VALUES_FIELD_NUMBER

        public static final int PARAMETER_VALUES_FIELD_NUMBER
        See Also:
        Constant Field Values

      • FAILURE_POLICY_FIELD_NUMBER

        public static final int FAILURE_POLICY_FIELD_NUMBER
        See Also:
        Constant Field Values

      • INPUT_ARTIFACTS_FIELD_NUMBER

        public static final int INPUT_ARTIFACTS_FIELD_NUMBER
        See Also:
        Constant Field Values

    • 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

      • getParametersCount

        @Deprecated
public int getParametersCount()
        Deprecated.
        Description copied from interface: PipelineJob.RuntimeConfigOrBuilder
         Deprecated. Use
 [RuntimeConfig.parameter_values][google.cloud.aiplatform.v1.PipelineJob.RuntimeConfig.parameter_values]
 instead. The runtime parameters of the PipelineJob. The parameters will
 be passed into
 [PipelineJob.pipeline_spec][google.cloud.aiplatform.v1.PipelineJob.pipeline_spec]
 to replace the placeholders at runtime. This field is used by pipelines
 built using `PipelineJob.pipeline_spec.schema_version` 2.0.0 or lower,
 such as pipelines built using Kubeflow Pipelines SDK 1.8 or lower.
        map<string, .google.cloud.aiplatform.v1.Value> parameters = 1 [deprecated = true];
        Specified by:
        getParametersCount in interface PipelineJob.RuntimeConfigOrBuilder

      • containsParameters

        @Deprecated
public boolean containsParameters​(String key)
        Deprecated.
         Deprecated. Use
 [RuntimeConfig.parameter_values][google.cloud.aiplatform.v1.PipelineJob.RuntimeConfig.parameter_values]
 instead. The runtime parameters of the PipelineJob. The parameters will
 be passed into
 [PipelineJob.pipeline_spec][google.cloud.aiplatform.v1.PipelineJob.pipeline_spec]
 to replace the placeholders at runtime. This field is used by pipelines
 built using `PipelineJob.pipeline_spec.schema_version` 2.0.0 or lower,
 such as pipelines built using Kubeflow Pipelines SDK 1.8 or lower.
        map<string, .google.cloud.aiplatform.v1.Value> parameters = 1 [deprecated = true];
        Specified by:
        containsParameters in interface PipelineJob.RuntimeConfigOrBuilder

      • getParametersMap

        @Deprecated
public Map<String,​Value> getParametersMap()
        Deprecated.
         Deprecated. Use
 [RuntimeConfig.parameter_values][google.cloud.aiplatform.v1.PipelineJob.RuntimeConfig.parameter_values]
 instead. The runtime parameters of the PipelineJob. The parameters will
 be passed into
 [PipelineJob.pipeline_spec][google.cloud.aiplatform.v1.PipelineJob.pipeline_spec]
 to replace the placeholders at runtime. This field is used by pipelines
 built using `PipelineJob.pipeline_spec.schema_version` 2.0.0 or lower,
 such as pipelines built using Kubeflow Pipelines SDK 1.8 or lower.
        map<string, .google.cloud.aiplatform.v1.Value> parameters = 1 [deprecated = true];
        Specified by:
        getParametersMap in interface PipelineJob.RuntimeConfigOrBuilder

      • getParametersOrDefault

        @Deprecated
public Value getParametersOrDefault​(String key,
                                    Value defaultValue)
        Deprecated.
         Deprecated. Use
 [RuntimeConfig.parameter_values][google.cloud.aiplatform.v1.PipelineJob.RuntimeConfig.parameter_values]
 instead. The runtime parameters of the PipelineJob. The parameters will
 be passed into
 [PipelineJob.pipeline_spec][google.cloud.aiplatform.v1.PipelineJob.pipeline_spec]
 to replace the placeholders at runtime. This field is used by pipelines
 built using `PipelineJob.pipeline_spec.schema_version` 2.0.0 or lower,
 such as pipelines built using Kubeflow Pipelines SDK 1.8 or lower.
        map<string, .google.cloud.aiplatform.v1.Value> parameters = 1 [deprecated = true];
        Specified by:
        getParametersOrDefault in interface PipelineJob.RuntimeConfigOrBuilder

      • getParametersOrThrow

        @Deprecated
public Value getParametersOrThrow​(String key)
        Deprecated.
         Deprecated. Use
 [RuntimeConfig.parameter_values][google.cloud.aiplatform.v1.PipelineJob.RuntimeConfig.parameter_values]
 instead. The runtime parameters of the PipelineJob. The parameters will
 be passed into
 [PipelineJob.pipeline_spec][google.cloud.aiplatform.v1.PipelineJob.pipeline_spec]
 to replace the placeholders at runtime. This field is used by pipelines
 built using `PipelineJob.pipeline_spec.schema_version` 2.0.0 or lower,
 such as pipelines built using Kubeflow Pipelines SDK 1.8 or lower.
        map<string, .google.cloud.aiplatform.v1.Value> parameters = 1 [deprecated = true];
        Specified by:
        getParametersOrThrow in interface PipelineJob.RuntimeConfigOrBuilder

      • getGcsOutputDirectory

        public String getGcsOutputDirectory()
         Required. A path in a Cloud Storage bucket, which will be treated as the
 root output directory of the pipeline. It is used by the system to
 generate the paths of output artifacts. The artifact paths are generated
 with a sub-path pattern `{job_id}/{task_id}/{output_key}` under the
 specified output directory. The service account specified in this
 pipeline must have the `storage.objects.get` and `storage.objects.create`
 permissions for this bucket.
        string gcs_output_directory = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getGcsOutputDirectory in interface PipelineJob.RuntimeConfigOrBuilder
        Returns:
        The gcsOutputDirectory.

      • getGcsOutputDirectoryBytes

        public com.google.protobuf.ByteString getGcsOutputDirectoryBytes()
         Required. A path in a Cloud Storage bucket, which will be treated as the
 root output directory of the pipeline. It is used by the system to
 generate the paths of output artifacts. The artifact paths are generated
 with a sub-path pattern `{job_id}/{task_id}/{output_key}` under the
 specified output directory. The service account specified in this
 pipeline must have the `storage.objects.get` and `storage.objects.create`
 permissions for this bucket.
        string gcs_output_directory = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getGcsOutputDirectoryBytes in interface PipelineJob.RuntimeConfigOrBuilder
        Returns:
        The bytes for gcsOutputDirectory.

      • getParameterValuesCount

        public int getParameterValuesCount()
        Description copied from interface: PipelineJob.RuntimeConfigOrBuilder
         The runtime parameters of the PipelineJob. The parameters will be
 passed into
 [PipelineJob.pipeline_spec][google.cloud.aiplatform.v1.PipelineJob.pipeline_spec]
 to replace the placeholders at runtime. This field is used by pipelines
 built using `PipelineJob.pipeline_spec.schema_version` 2.1.0, such as
 pipelines built using Kubeflow Pipelines SDK 1.9 or higher and the v2
 DSL.
        map<string, .google.protobuf.Value> parameter_values = 3;
        Specified by:
        getParameterValuesCount in interface PipelineJob.RuntimeConfigOrBuilder

      • containsParameterValues

        public boolean containsParameterValues​(String key)
         The runtime parameters of the PipelineJob. The parameters will be
 passed into
 [PipelineJob.pipeline_spec][google.cloud.aiplatform.v1.PipelineJob.pipeline_spec]
 to replace the placeholders at runtime. This field is used by pipelines
 built using `PipelineJob.pipeline_spec.schema_version` 2.1.0, such as
 pipelines built using Kubeflow Pipelines SDK 1.9 or higher and the v2
 DSL.
        map<string, .google.protobuf.Value> parameter_values = 3;
        Specified by:
        containsParameterValues in interface PipelineJob.RuntimeConfigOrBuilder

      • getParameterValuesMap

        public Map<String,​com.google.protobuf.Value> getParameterValuesMap()
         The runtime parameters of the PipelineJob. The parameters will be
 passed into
 [PipelineJob.pipeline_spec][google.cloud.aiplatform.v1.PipelineJob.pipeline_spec]
 to replace the placeholders at runtime. This field is used by pipelines
 built using `PipelineJob.pipeline_spec.schema_version` 2.1.0, such as
 pipelines built using Kubeflow Pipelines SDK 1.9 or higher and the v2
 DSL.
        map<string, .google.protobuf.Value> parameter_values = 3;
        Specified by:
        getParameterValuesMap in interface PipelineJob.RuntimeConfigOrBuilder

      • getParameterValuesOrDefault

        public com.google.protobuf.Value getParameterValuesOrDefault​(String key,
                                                             com.google.protobuf.Value defaultValue)
         The runtime parameters of the PipelineJob. The parameters will be
 passed into
 [PipelineJob.pipeline_spec][google.cloud.aiplatform.v1.PipelineJob.pipeline_spec]
 to replace the placeholders at runtime. This field is used by pipelines
 built using `PipelineJob.pipeline_spec.schema_version` 2.1.0, such as
 pipelines built using Kubeflow Pipelines SDK 1.9 or higher and the v2
 DSL.
        map<string, .google.protobuf.Value> parameter_values = 3;
        Specified by:
        getParameterValuesOrDefault in interface PipelineJob.RuntimeConfigOrBuilder

      • getParameterValuesOrThrow

        public com.google.protobuf.Value getParameterValuesOrThrow​(String key)
         The runtime parameters of the PipelineJob. The parameters will be
 passed into
 [PipelineJob.pipeline_spec][google.cloud.aiplatform.v1.PipelineJob.pipeline_spec]
 to replace the placeholders at runtime. This field is used by pipelines
 built using `PipelineJob.pipeline_spec.schema_version` 2.1.0, such as
 pipelines built using Kubeflow Pipelines SDK 1.9 or higher and the v2
 DSL.
        map<string, .google.protobuf.Value> parameter_values = 3;
        Specified by:
        getParameterValuesOrThrow in interface PipelineJob.RuntimeConfigOrBuilder

      • getFailurePolicyValue

        public int getFailurePolicyValue()
         Represents the failure policy of a pipeline. Currently, the default of a
 pipeline is that the pipeline will continue to run until no more tasks
 can be executed, also known as PIPELINE_FAILURE_POLICY_FAIL_SLOW.
 However, if a pipeline is set to PIPELINE_FAILURE_POLICY_FAIL_FAST, it
 will stop scheduling any new tasks when a task has failed. Any scheduled
 tasks will continue to completion.
        .google.cloud.aiplatform.v1.PipelineFailurePolicy failure_policy = 4;
        Specified by:
        getFailurePolicyValue in interface PipelineJob.RuntimeConfigOrBuilder
        Returns:
        The enum numeric value on the wire for failurePolicy.

      • getFailurePolicy

        public PipelineFailurePolicy getFailurePolicy()
         Represents the failure policy of a pipeline. Currently, the default of a
 pipeline is that the pipeline will continue to run until no more tasks
 can be executed, also known as PIPELINE_FAILURE_POLICY_FAIL_SLOW.
 However, if a pipeline is set to PIPELINE_FAILURE_POLICY_FAIL_FAST, it
 will stop scheduling any new tasks when a task has failed. Any scheduled
 tasks will continue to completion.
        .google.cloud.aiplatform.v1.PipelineFailurePolicy failure_policy = 4;
        Specified by:
        getFailurePolicy in interface PipelineJob.RuntimeConfigOrBuilder
        Returns:
        The failurePolicy.

      • getInputArtifactsCount

        public int getInputArtifactsCount()
        Description copied from interface: PipelineJob.RuntimeConfigOrBuilder
         The runtime artifacts of the PipelineJob. The key will be the input
 artifact name and the value would be one of the InputArtifact.
        map<string, .google.cloud.aiplatform.v1.PipelineJob.RuntimeConfig.InputArtifact> input_artifacts = 5;
        Specified by:
        getInputArtifactsCount in interface PipelineJob.RuntimeConfigOrBuilder

      • containsInputArtifacts

        public boolean containsInputArtifacts​(String key)
         The runtime artifacts of the PipelineJob. The key will be the input
 artifact name and the value would be one of the InputArtifact.
        map<string, .google.cloud.aiplatform.v1.PipelineJob.RuntimeConfig.InputArtifact> input_artifacts = 5;
        Specified by:
        containsInputArtifacts in interface PipelineJob.RuntimeConfigOrBuilder

      • 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 PipelineJob.RuntimeConfig parseFrom​(ByteBuffer data)
                                           throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static PipelineJob.RuntimeConfig parseFrom​(ByteBuffer data,
                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                           throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static PipelineJob.RuntimeConfig parseFrom​(com.google.protobuf.ByteString data)
                                           throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static PipelineJob.RuntimeConfig parseFrom​(com.google.protobuf.ByteString data,
                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                           throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static PipelineJob.RuntimeConfig parseFrom​(byte[] data)
                                           throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static PipelineJob.RuntimeConfig parseFrom​(byte[] data,
                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                           throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • newBuilderForType

        public PipelineJob.RuntimeConfig.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public PipelineJob.RuntimeConfig.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected PipelineJob.RuntimeConfig.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<PipelineJob.RuntimeConfig> 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 PipelineJob.RuntimeConfig getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder