public final class PipelineJob extends GeneratedMessageV3 implements PipelineJobOrBuilder
An instance of a machine learning PipelineJob.
Protobuf type google.cloud.aiplatform.v1.PipelineJob
Static Fields
public static final int CREATE_TIME_FIELD_NUMBER
Field Value
public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
public static final int ENCRYPTION_SPEC_FIELD_NUMBER
Field Value
public static final int END_TIME_FIELD_NUMBER
Field Value
public static final int ERROR_FIELD_NUMBER
Field Value
public static final int JOB_DETAIL_FIELD_NUMBER
Field Value
public static final int LABELS_FIELD_NUMBER
Field Value
public static final int NAME_FIELD_NUMBER
Field Value
public static final int NETWORK_FIELD_NUMBER
Field Value
public static final int PIPELINE_SPEC_FIELD_NUMBER
Field Value
public static final int RUNTIME_CONFIG_FIELD_NUMBER
Field Value
public static final int SERVICE_ACCOUNT_FIELD_NUMBER
Field Value
public static final int START_TIME_FIELD_NUMBER
Field Value
public static final int STATE_FIELD_NUMBER
Field Value
public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Static Methods
public static PipelineJob getDefaultInstance()
Returns
public static final Descriptors.Descriptor getDescriptor()
Returns
public static PipelineJob.Builder newBuilder()
Returns
public static PipelineJob.Builder newBuilder(PipelineJob prototype)
Parameter
Returns
public static PipelineJob parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static PipelineJob parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static PipelineJob parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
public static PipelineJob parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static PipelineJob parseFrom(ByteString data)
Parameter
Returns
Exceptions
public static PipelineJob parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static PipelineJob parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static PipelineJob parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static PipelineJob parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static PipelineJob parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static PipelineJob parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
public static PipelineJob parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Parser<PipelineJob> parser()
Returns
Methods
public boolean containsLabels(String key)
The labels with user-defined metadata to organize PipelineJob.
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 = 11;
public boolean equals(Object obj)
Parameter
Returns
Overrides
public Timestamp getCreateTime()
Output only. Pipeline creation time.
.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
public TimestampOrBuilder getCreateTimeOrBuilder()
Output only. Pipeline creation time.
.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
public PipelineJob getDefaultInstanceForType()
Returns
public String getDisplayName()
The display name of the Pipeline.
The name can be up to 128 characters long and can be consist of any UTF-8
characters.
string display_name = 2;
| Type | Description |
| String | The displayName.
|
public ByteString getDisplayNameBytes()
The display name of the Pipeline.
The name can be up to 128 characters long and can be consist of any UTF-8
characters.
string display_name = 2;
| Type | Description |
| ByteString | The bytes for displayName.
|
public EncryptionSpec getEncryptionSpec()
Customer-managed encryption key spec for a pipelineJob. If set, this
PipelineJob and all of its sub-resources will be secured by this key.
.google.cloud.aiplatform.v1.EncryptionSpec encryption_spec = 16;
public EncryptionSpecOrBuilder getEncryptionSpecOrBuilder()
Customer-managed encryption key spec for a pipelineJob. If set, this
PipelineJob and all of its sub-resources will be secured by this key.
.google.cloud.aiplatform.v1.EncryptionSpec encryption_spec = 16;
public Timestamp getEndTime()
Output only. Pipeline end time.
.google.protobuf.Timestamp end_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
public TimestampOrBuilder getEndTimeOrBuilder()
Output only. Pipeline end time.
.google.protobuf.Timestamp end_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
Output only. The error that occurred during pipeline execution.
Only populated when the pipeline's state is FAILED or CANCELLED.
.google.rpc.Status error = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| com.google.rpc.Status | The error.
|
public StatusOrBuilder getErrorOrBuilder()
Output only. The error that occurred during pipeline execution.
Only populated when the pipeline's state is FAILED or CANCELLED.
.google.rpc.Status error = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| com.google.rpc.StatusOrBuilder | |
public PipelineJobDetail getJobDetail()
Output only. The details of pipeline run. Not available in the list view.
.google.cloud.aiplatform.v1.PipelineJobDetail job_detail = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
public PipelineJobDetailOrBuilder getJobDetailOrBuilder()
Output only. The details of pipeline run. Not available in the list view.
.google.cloud.aiplatform.v1.PipelineJobDetail job_detail = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
public Map<String,String> getLabels()
Returns
public int getLabelsCount()
The labels with user-defined metadata to organize PipelineJob.
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 = 11;
public Map<String,String> getLabelsMap()
The labels with user-defined metadata to organize PipelineJob.
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 = 11;
public String getLabelsOrDefault(String key, String defaultValue)
The labels with user-defined metadata to organize PipelineJob.
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 = 11;
public String getLabelsOrThrow(String key)
The labels with user-defined metadata to organize PipelineJob.
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 = 11;
Output only. The resource name of the PipelineJob.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| String | The name.
|
public ByteString getNameBytes()
Output only. The resource name of the PipelineJob.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
public String getNetwork()
The full name of the Compute Engine
network to which the
Pipeline Job's workload should be peered. For example,
projects/12345/global/networks/myVPC.
Format
is of the form projects/{project}/global/networks/{network}.
Where {project} is a project number, as in 12345, and {network} is a
network name.
Private services access must already be configured for the network.
Pipeline job will apply the network configuration to the GCP resources
being launched, if applied, such as Vertex AI
Training or Dataflow job. If left unspecified, the workload is not peered
with any network.
string network = 18 [(.google.api.resource_reference) = { ... }
| Type | Description |
| String | The network.
|
public ByteString getNetworkBytes()
The full name of the Compute Engine
network to which the
Pipeline Job's workload should be peered. For example,
projects/12345/global/networks/myVPC.
Format
is of the form projects/{project}/global/networks/{network}.
Where {project} is a project number, as in 12345, and {network} is a
network name.
Private services access must already be configured for the network.
Pipeline job will apply the network configuration to the GCP resources
being launched, if applied, such as Vertex AI
Training or Dataflow job. If left unspecified, the workload is not peered
with any network.
string network = 18 [(.google.api.resource_reference) = { ... }
public Parser<PipelineJob> getParserForType()
Returns
Overrides
public Struct getPipelineSpec()
The spec of the pipeline.
.google.protobuf.Struct pipeline_spec = 7;
| Type | Description |
| Struct | The pipelineSpec.
|
public StructOrBuilder getPipelineSpecOrBuilder()
The spec of the pipeline.
.google.protobuf.Struct pipeline_spec = 7;
public PipelineJob.RuntimeConfig getRuntimeConfig()
Runtime config of the pipeline.
.google.cloud.aiplatform.v1.PipelineJob.RuntimeConfig runtime_config = 12;
public PipelineJob.RuntimeConfigOrBuilder getRuntimeConfigOrBuilder()
Runtime config of the pipeline.
.google.cloud.aiplatform.v1.PipelineJob.RuntimeConfig runtime_config = 12;
public int getSerializedSize()
Returns
Overrides
public String getServiceAccount()
Returns
| Type | Description |
| String | The serviceAccount.
|
public ByteString getServiceAccountBytes()
Returns
| Type | Description |
| ByteString | The bytes for serviceAccount.
|
public Timestamp getStartTime()
Output only. Pipeline start time.
.google.protobuf.Timestamp start_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
public TimestampOrBuilder getStartTimeOrBuilder()
Output only. Pipeline start time.
.google.protobuf.Timestamp start_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
public PipelineState getState()
Output only. The detailed state of the job.
.google.cloud.aiplatform.v1.PipelineState state = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
public int getStateValue()
Output only. The detailed state of the job.
.google.cloud.aiplatform.v1.PipelineState state = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| int | The enum numeric value on the wire for state.
|
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
public Timestamp getUpdateTime()
Output only. Timestamp when this PipelineJob was most recently updated.
.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
public TimestampOrBuilder getUpdateTimeOrBuilder()
Output only. Timestamp when this PipelineJob was most recently updated.
.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
public boolean hasCreateTime()
Output only. Pipeline creation time.
.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| boolean | Whether the createTime field is set.
|
public boolean hasEncryptionSpec()
Customer-managed encryption key spec for a pipelineJob. If set, this
PipelineJob and all of its sub-resources will be secured by this key.
.google.cloud.aiplatform.v1.EncryptionSpec encryption_spec = 16;
| Type | Description |
| boolean | Whether the encryptionSpec field is set.
|
public boolean hasEndTime()
Output only. Pipeline end time.
.google.protobuf.Timestamp end_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| boolean | Whether the endTime field is set.
|
public boolean hasError()
Output only. The error that occurred during pipeline execution.
Only populated when the pipeline's state is FAILED or CANCELLED.
.google.rpc.Status error = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| boolean | Whether the error field is set.
|
public boolean hasJobDetail()
Output only. The details of pipeline run. Not available in the list view.
.google.cloud.aiplatform.v1.PipelineJobDetail job_detail = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| boolean | Whether the jobDetail field is set.
|
public boolean hasPipelineSpec()
The spec of the pipeline.
.google.protobuf.Struct pipeline_spec = 7;
| Type | Description |
| boolean | Whether the pipelineSpec field is set.
|
public boolean hasRuntimeConfig()
Runtime config of the pipeline.
.google.cloud.aiplatform.v1.PipelineJob.RuntimeConfig runtime_config = 12;
| Type | Description |
| boolean | Whether the runtimeConfig field is set.
|
public boolean hasStartTime()
Output only. Pipeline start time.
.google.protobuf.Timestamp start_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| boolean | Whether the startTime field is set.
|
public boolean hasUpdateTime()
Output only. Timestamp when this PipelineJob was most recently updated.
.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| boolean | Whether the updateTime field is set.
|
Returns
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
protected MapField internalGetMapField(int number)
Parameter
Returns
Overrides
public final boolean isInitialized()
Returns
Overrides
public PipelineJob.Builder newBuilderForType()
Returns
protected PipelineJob.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
public PipelineJob.Builder toBuilder()
Returns
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
