public static final class PipelineJob.RuntimeConfig extends GeneratedMessageV3 implements PipelineJob.RuntimeConfigOrBuilder
The runtime config of a PipelineJob.
Protobuf type google.cloud.aiplatform.v1.PipelineJob.RuntimeConfig
Static Fields
public static final int GCS_OUTPUT_DIRECTORY_FIELD_NUMBER
Field Value
public static final int PARAMETERS_FIELD_NUMBER
Field Value
public static final int PARAMETER_VALUES_FIELD_NUMBER
Field Value
Static Methods
public static PipelineJob.RuntimeConfig getDefaultInstance()
Returns
public static final Descriptors.Descriptor getDescriptor()
Returns
public static PipelineJob.RuntimeConfig.Builder newBuilder()
Returns
public static PipelineJob.RuntimeConfig.Builder newBuilder(PipelineJob.RuntimeConfig prototype)
Parameter
Returns
public static PipelineJob.RuntimeConfig parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static PipelineJob.RuntimeConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static PipelineJob.RuntimeConfig parseFrom(byte[] data)
Parameter
Name | Description |
data | byte[]
|
Returns
Exceptions
public static PipelineJob.RuntimeConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static PipelineJob.RuntimeConfig parseFrom(ByteString data)
Parameter
Returns
Exceptions
public static PipelineJob.RuntimeConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static PipelineJob.RuntimeConfig parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static PipelineJob.RuntimeConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static PipelineJob.RuntimeConfig parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static PipelineJob.RuntimeConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static PipelineJob.RuntimeConfig parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
public static PipelineJob.RuntimeConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Parser<PipelineJob.RuntimeConfig> parser()
Returns
Methods
public boolean containsParameterValues(String key)
The runtime parameters of the PipelineJob. The parameters will be
passed into 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;
Parameter
Returns
public boolean containsParameters(String key)
Deprecated. Use RuntimeConfig.parameter_values instead. The runtime
parameters of the PipelineJob. The parameters will be passed into
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];
Parameter
Returns
public boolean equals(Object obj)
Parameter
Returns
Overrides
public PipelineJob.RuntimeConfig getDefaultInstanceForType()
Returns
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];
Returns
Type | Description |
String | The gcsOutputDirectory.
|
public 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
Type | Description |
ByteString | The bytes for gcsOutputDirectory.
|
public Map<String,Value> getParameterValues()
Returns
public int getParameterValuesCount()
The runtime parameters of the PipelineJob. The parameters will be
passed into 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;
Returns
public Map<String,Value> getParameterValuesMap()
The runtime parameters of the PipelineJob. The parameters will be
passed into 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;
Returns
public Value getParameterValuesOrDefault(String key, Value defaultValue)
The runtime parameters of the PipelineJob. The parameters will be
passed into 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;
Parameters
Returns
public Value getParameterValuesOrThrow(String key)
The runtime parameters of the PipelineJob. The parameters will be
passed into 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;
Parameter
Returns
public Map<String,Value> getParameters()
Returns
public int getParametersCount()
Deprecated. Use RuntimeConfig.parameter_values instead. The runtime
parameters of the PipelineJob. The parameters will be passed into
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];
Returns
public Map<String,Value> getParametersMap()
Deprecated. Use RuntimeConfig.parameter_values instead. The runtime
parameters of the PipelineJob. The parameters will be passed into
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];
Returns
public Value getParametersOrDefault(String key, Value defaultValue)
Deprecated. Use RuntimeConfig.parameter_values instead. The runtime
parameters of the PipelineJob. The parameters will be passed into
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];
Parameters
Returns
public Value getParametersOrThrow(String key)
Deprecated. Use RuntimeConfig.parameter_values instead. The runtime
parameters of the PipelineJob. The parameters will be passed into
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];
Parameter
Returns
public Parser<PipelineJob.RuntimeConfig> getParserForType()
Returns
Overrides
public int getSerializedSize()
Returns
Overrides
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
Returns
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
protected MapField internalGetMapField(int number)
Parameter
Returns
Overrides
public final boolean isInitialized()
Returns
Overrides
public PipelineJob.RuntimeConfig.Builder newBuilderForType()
Returns
protected PipelineJob.RuntimeConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
public PipelineJob.RuntimeConfig.Builder toBuilder()
Returns
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions