com.google.cloud.aiplatform.v1

Interface PipelineJob.RuntimeConfigOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

PipelineJob.RuntimeConfig, PipelineJob.RuntimeConfig.Builder

Enclosing class:

PipelineJob

public static interface PipelineJob.RuntimeConfigOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
boolean	containsInputArtifacts(String key) The runtime artifacts of the PipelineJob.
boolean	containsParameters(String key) Deprecated.
boolean	containsParameterValues(String key) The runtime parameters of the PipelineJob.
PipelineFailurePolicy	getFailurePolicy() Represents the failure policy of a pipeline.
int	getFailurePolicyValue() Represents the failure policy of a pipeline.
String	getGcsOutputDirectory() Required.
com.google.protobuf.ByteString	getGcsOutputDirectoryBytes() Required.
Map<String,PipelineJob.RuntimeConfig.InputArtifact>	getInputArtifacts() Deprecated.
int	getInputArtifactsCount() The runtime artifacts of the PipelineJob.
Map<String,PipelineJob.RuntimeConfig.InputArtifact>	getInputArtifactsMap() The runtime artifacts of the PipelineJob.
PipelineJob.RuntimeConfig.InputArtifact	getInputArtifactsOrDefault(String key, PipelineJob.RuntimeConfig.InputArtifact defaultValue) The runtime artifacts of the PipelineJob.
PipelineJob.RuntimeConfig.InputArtifact	getInputArtifactsOrThrow(String key) The runtime artifacts of the PipelineJob.
Map<String,Value>	getParameters() Deprecated.
int	getParametersCount() Deprecated.
Map<String,Value>	getParametersMap() Deprecated.
Value	getParametersOrDefault(String key, Value defaultValue) Deprecated.
Value	getParametersOrThrow(String key) Deprecated.
Map<String,com.google.protobuf.Value>	getParameterValues() Deprecated.
int	getParameterValuesCount() The runtime parameters of the PipelineJob.
Map<String,com.google.protobuf.Value>	getParameterValuesMap() The runtime parameters of the PipelineJob.
com.google.protobuf.Value	getParameterValuesOrDefault(String key, com.google.protobuf.Value defaultValue) The runtime parameters of the PipelineJob.
com.google.protobuf.Value	getParameterValuesOrThrow(String key) The runtime parameters of the PipelineJob.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getParametersCount

@Deprecated
int getParametersCount()

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];

containsParameters

@Deprecated
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];

getParameters

@Deprecated
Map<String,Value> getParameters()

Deprecated.

Use getParametersMap() instead.

getParametersMap

@Deprecated
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];

getParametersOrDefault

@Deprecated
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];

getParametersOrThrow

@Deprecated
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];

getGcsOutputDirectory

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];

Returns:

The gcsOutputDirectory.

getGcsOutputDirectoryBytes

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];

Returns:

The bytes for gcsOutputDirectory.

getParameterValuesCount

int getParameterValuesCount()

 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;

containsParameterValues

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;

getParameterValues

@Deprecated
Map<String,com.google.protobuf.Value> getParameterValues()

Deprecated.

Use getParameterValuesMap() instead.

getParameterValuesMap

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;

getParameterValuesOrDefault

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;

getParameterValuesOrThrow

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;

getFailurePolicyValue

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;

Returns:

The enum numeric value on the wire for failurePolicy.

getFailurePolicy

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;

Returns:

The failurePolicy.

getInputArtifactsCount

int getInputArtifactsCount()

 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;

containsInputArtifacts

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;

getInputArtifacts

@Deprecated
Map<String,PipelineJob.RuntimeConfig.InputArtifact> getInputArtifacts()

Deprecated.

Use getInputArtifactsMap() instead.

getInputArtifactsMap

Map<String,PipelineJob.RuntimeConfig.InputArtifact> getInputArtifactsMap()

 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;

getInputArtifactsOrDefault

PipelineJob.RuntimeConfig.InputArtifact getInputArtifactsOrDefault(String key,
                                                                   PipelineJob.RuntimeConfig.InputArtifact defaultValue)

 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;

getInputArtifactsOrThrow

PipelineJob.RuntimeConfig.InputArtifact getInputArtifactsOrThrow(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;