- 3.52.0 (latest)
- 3.50.0
- 3.49.0
- 3.48.0
- 3.47.0
- 3.46.0
- 3.45.0
- 3.44.0
- 3.43.0
- 3.42.0
- 3.41.0
- 3.40.0
- 3.38.0
- 3.37.0
- 3.36.0
- 3.35.0
- 3.34.0
- 3.33.0
- 3.32.0
- 3.31.0
- 3.30.0
- 3.29.0
- 3.28.0
- 3.25.0
- 3.24.0
- 3.23.0
- 3.22.0
- 3.21.0
- 3.20.0
- 3.19.0
- 3.18.0
- 3.17.0
- 3.16.0
- 3.15.0
- 3.14.0
- 3.13.0
- 3.12.0
- 3.11.0
- 3.10.0
- 3.9.0
- 3.8.0
- 3.7.0
- 3.6.0
- 3.5.0
- 3.4.2
- 3.3.0
- 3.2.0
- 3.0.0
- 2.9.8
- 2.8.9
- 2.7.4
- 2.5.3
- 2.4.0
public final class PipelineJob extends GeneratedMessageV3 implements PipelineJobOrBuilder
An instance of a machine learning PipelineJob.
Protobuf type google.cloud.aiplatform.v1.PipelineJob
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > PipelineJobImplements
PipelineJobOrBuilderStatic Fields
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
Type | Description |
int |
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
Type | Description |
int |
ENCRYPTION_SPEC_FIELD_NUMBER
public static final int ENCRYPTION_SPEC_FIELD_NUMBER
Type | Description |
int |
END_TIME_FIELD_NUMBER
public static final int END_TIME_FIELD_NUMBER
Type | Description |
int |
ERROR_FIELD_NUMBER
public static final int ERROR_FIELD_NUMBER
Type | Description |
int |
JOB_DETAIL_FIELD_NUMBER
public static final int JOB_DETAIL_FIELD_NUMBER
Type | Description |
int |
LABELS_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
Type | Description |
int |
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Type | Description |
int |
NETWORK_FIELD_NUMBER
public static final int NETWORK_FIELD_NUMBER
Type | Description |
int |
PIPELINE_SPEC_FIELD_NUMBER
public static final int PIPELINE_SPEC_FIELD_NUMBER
Type | Description |
int |
RUNTIME_CONFIG_FIELD_NUMBER
public static final int RUNTIME_CONFIG_FIELD_NUMBER
Type | Description |
int |
SERVICE_ACCOUNT_FIELD_NUMBER
public static final int SERVICE_ACCOUNT_FIELD_NUMBER
Type | Description |
int |
START_TIME_FIELD_NUMBER
public static final int START_TIME_FIELD_NUMBER
Type | Description |
int |
STATE_FIELD_NUMBER
public static final int STATE_FIELD_NUMBER
Type | Description |
int |
TEMPLATE_METADATA_FIELD_NUMBER
public static final int TEMPLATE_METADATA_FIELD_NUMBER
Type | Description |
int |
TEMPLATE_URI_FIELD_NUMBER
public static final int TEMPLATE_URI_FIELD_NUMBER
Type | Description |
int |
UPDATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER
Type | Description |
int |
Static Methods
getDefaultInstance()
public static PipelineJob getDefaultInstance()
Type | Description |
PipelineJob |
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Type | Description |
Descriptor |
newBuilder()
public static PipelineJob.Builder newBuilder()
Type | Description |
PipelineJob.Builder |
newBuilder(PipelineJob prototype)
public static PipelineJob.Builder newBuilder(PipelineJob prototype)
Name | Description |
prototype | PipelineJob |
Type | Description |
PipelineJob.Builder |
parseDelimitedFrom(InputStream input)
public static PipelineJob parseDelimitedFrom(InputStream input)
Name | Description |
input | InputStream |
Type | Description |
PipelineJob |
Type | Description |
IOException |
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static PipelineJob parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Name | Description |
input | InputStream |
extensionRegistry | ExtensionRegistryLite |
Type | Description |
PipelineJob |
Type | Description |
IOException |
parseFrom(byte[] data)
public static PipelineJob parseFrom(byte[] data)
Name | Description |
data | byte[] |
Type | Description |
PipelineJob |
Type | Description |
InvalidProtocolBufferException |
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static PipelineJob parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Name | Description |
data | byte[] |
extensionRegistry | ExtensionRegistryLite |
Type | Description |
PipelineJob |
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteString data)
public static PipelineJob parseFrom(ByteString data)
Name | Description |
data | ByteString |
Type | Description |
PipelineJob |
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static PipelineJob parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Name | Description |
data | ByteString |
extensionRegistry | ExtensionRegistryLite |
Type | Description |
PipelineJob |
Type | Description |
InvalidProtocolBufferException |
parseFrom(CodedInputStream input)
public static PipelineJob parseFrom(CodedInputStream input)
Name | Description |
input | CodedInputStream |
Type | Description |
PipelineJob |
Type | Description |
IOException |
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static PipelineJob parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
Type | Description |
PipelineJob |
Type | Description |
IOException |
parseFrom(InputStream input)
public static PipelineJob parseFrom(InputStream input)
Name | Description |
input | InputStream |
Type | Description |
PipelineJob |
Type | Description |
IOException |
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static PipelineJob parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Name | Description |
input | InputStream |
extensionRegistry | ExtensionRegistryLite |
Type | Description |
PipelineJob |
Type | Description |
IOException |
parseFrom(ByteBuffer data)
public static PipelineJob parseFrom(ByteBuffer data)
Name | Description |
data | ByteBuffer |
Type | Description |
PipelineJob |
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static PipelineJob parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Name | Description |
data | ByteBuffer |
extensionRegistry | ExtensionRegistryLite |
Type | Description |
PipelineJob |
Type | Description |
InvalidProtocolBufferException |
parser()
public static Parser<PipelineJob> parser()
Type | Description |
Parser<PipelineJob> |
Methods
containsLabels(String key)
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;
Name | Description |
key | String |
Type | Description |
boolean |
equals(Object obj)
public boolean equals(Object obj)
Name | Description |
obj | Object |
Type | Description |
boolean |
getCreateTime()
public Timestamp getCreateTime()
Output only. Pipeline creation time.
.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
Type | Description |
Timestamp | The createTime. |
getCreateTimeOrBuilder()
public TimestampOrBuilder getCreateTimeOrBuilder()
Output only. Pipeline creation time.
.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
Type | Description |
TimestampOrBuilder |
getDefaultInstanceForType()
public PipelineJob getDefaultInstanceForType()
Type | Description |
PipelineJob |
getDisplayName()
public String getDisplayName()
The display name of the Pipeline. The name can be up to 128 characters long and can consist of any UTF-8 characters.
string display_name = 2;
Type | Description |
String | The displayName. |
getDisplayNameBytes()
public ByteString getDisplayNameBytes()
The display name of the Pipeline. The name can be up to 128 characters long and can consist of any UTF-8 characters.
string display_name = 2;
Type | Description |
ByteString | The bytes for displayName. |
getEncryptionSpec()
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;
Type | Description |
EncryptionSpec | The encryptionSpec. |
getEncryptionSpecOrBuilder()
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;
Type | Description |
EncryptionSpecOrBuilder |
getEndTime()
public Timestamp getEndTime()
Output only. Pipeline end time.
.google.protobuf.Timestamp end_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
Type | Description |
Timestamp | The endTime. |
getEndTimeOrBuilder()
public TimestampOrBuilder getEndTimeOrBuilder()
Output only. Pipeline end time.
.google.protobuf.Timestamp end_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
Type | Description |
TimestampOrBuilder |
getError()
public Status getError()
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. |
getErrorOrBuilder()
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 |
getJobDetail()
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];
Type | Description |
PipelineJobDetail | The jobDetail. |
getJobDetailOrBuilder()
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];
Type | Description |
PipelineJobDetailOrBuilder |
getLabels()
public Map<String,String> getLabels()
Use #getLabelsMap() instead.
Type | Description |
Map<String,String> |
getLabelsCount()
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;
Type | Description |
int |
getLabelsMap()
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;
Type | Description |
Map<String,String> |
getLabelsOrDefault(String key, String defaultValue)
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;
Name | Description |
key | String |
defaultValue | String |
Type | Description |
String |
getLabelsOrThrow(String key)
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;
Name | Description |
key | String |
Type | Description |
String |
getName()
public String getName()
Output only. The resource name of the PipelineJob.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
Type | Description |
String | The name. |
getNameBytes()
public ByteString getNameBytes()
Output only. The resource name of the PipelineJob.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
Type | Description |
ByteString | The bytes for name. |
getNetwork()
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 Google Cloud
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. |
getNetworkBytes()
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 Google Cloud
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 |
ByteString | The bytes for network. |
getParserForType()
public Parser<PipelineJob> getParserForType()
Type | Description |
Parser<PipelineJob> |
getPipelineSpec()
public Struct getPipelineSpec()
The spec of the pipeline.
.google.protobuf.Struct pipeline_spec = 7;
Type | Description |
Struct | The pipelineSpec. |
getPipelineSpecOrBuilder()
public StructOrBuilder getPipelineSpecOrBuilder()
The spec of the pipeline.
.google.protobuf.Struct pipeline_spec = 7;
Type | Description |
StructOrBuilder |
getRuntimeConfig()
public PipelineJob.RuntimeConfig getRuntimeConfig()
Runtime config of the pipeline.
.google.cloud.aiplatform.v1.PipelineJob.RuntimeConfig runtime_config = 12;
Type | Description |
PipelineJob.RuntimeConfig | The runtimeConfig. |
getRuntimeConfigOrBuilder()
public PipelineJob.RuntimeConfigOrBuilder getRuntimeConfigOrBuilder()
Runtime config of the pipeline.
.google.cloud.aiplatform.v1.PipelineJob.RuntimeConfig runtime_config = 12;
Type | Description |
PipelineJob.RuntimeConfigOrBuilder |
getSerializedSize()
public int getSerializedSize()
Type | Description |
int |
getServiceAccount()
public String getServiceAccount()
The service account that the pipeline workload runs as.
If not specified, the Compute Engine default service account in the project
will be used.
See
https://cloud.google.com/compute/docs/access/service-accounts#default_service_account
Users starting the pipeline must have the iam.serviceAccounts.actAs
permission on this service account.
string service_account = 17;
Type | Description |
String | The serviceAccount. |
getServiceAccountBytes()
public ByteString getServiceAccountBytes()
The service account that the pipeline workload runs as.
If not specified, the Compute Engine default service account in the project
will be used.
See
https://cloud.google.com/compute/docs/access/service-accounts#default_service_account
Users starting the pipeline must have the iam.serviceAccounts.actAs
permission on this service account.
string service_account = 17;
Type | Description |
ByteString | The bytes for serviceAccount. |
getStartTime()
public Timestamp getStartTime()
Output only. Pipeline start time.
.google.protobuf.Timestamp start_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
Type | Description |
Timestamp | The startTime. |
getStartTimeOrBuilder()
public TimestampOrBuilder getStartTimeOrBuilder()
Output only. Pipeline start time.
.google.protobuf.Timestamp start_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
Type | Description |
TimestampOrBuilder |
getState()
public PipelineState getState()
Output only. The detailed state of the job.
.google.cloud.aiplatform.v1.PipelineState state = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
Type | Description |
PipelineState | The state. |
getStateValue()
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. |
getTemplateMetadata()
public PipelineTemplateMetadata getTemplateMetadata()
Output only. Pipeline template metadata. Will fill up fields if PipelineJob.template_uri is from supported template registry.
.google.cloud.aiplatform.v1.PipelineTemplateMetadata template_metadata = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];
Type | Description |
PipelineTemplateMetadata | The templateMetadata. |
getTemplateMetadataOrBuilder()
public PipelineTemplateMetadataOrBuilder getTemplateMetadataOrBuilder()
Output only. Pipeline template metadata. Will fill up fields if PipelineJob.template_uri is from supported template registry.
.google.cloud.aiplatform.v1.PipelineTemplateMetadata template_metadata = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];
Type | Description |
PipelineTemplateMetadataOrBuilder |
getTemplateUri()
public String getTemplateUri()
A template uri from where the PipelineJob.pipeline_spec, if empty, will be downloaded.
string template_uri = 19;
Type | Description |
String | The templateUri. |
getTemplateUriBytes()
public ByteString getTemplateUriBytes()
A template uri from where the PipelineJob.pipeline_spec, if empty, will be downloaded.
string template_uri = 19;
Type | Description |
ByteString | The bytes for templateUri. |
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Type | Description |
UnknownFieldSet |
getUpdateTime()
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];
Type | Description |
Timestamp | The updateTime. |
getUpdateTimeOrBuilder()
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];
Type | Description |
TimestampOrBuilder |
hasCreateTime()
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. |
hasEncryptionSpec()
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. |
hasEndTime()
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. |
hasError()
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. |
hasJobDetail()
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. |
hasPipelineSpec()
public boolean hasPipelineSpec()
The spec of the pipeline.
.google.protobuf.Struct pipeline_spec = 7;
Type | Description |
boolean | Whether the pipelineSpec field is set. |
hasRuntimeConfig()
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. |
hasStartTime()
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. |
hasTemplateMetadata()
public boolean hasTemplateMetadata()
Output only. Pipeline template metadata. Will fill up fields if PipelineJob.template_uri is from supported template registry.
.google.cloud.aiplatform.v1.PipelineTemplateMetadata template_metadata = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];
Type | Description |
boolean | Whether the templateMetadata field is set. |
hasUpdateTime()
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. |
hashCode()
public int hashCode()
Type | Description |
int |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Type | Description |
FieldAccessorTable |
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
Name | Description |
number | int |
Type | Description |
MapField |
isInitialized()
public final boolean isInitialized()
Type | Description |
boolean |
newBuilderForType()
public PipelineJob.Builder newBuilderForType()
Type | Description |
PipelineJob.Builder |
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected PipelineJob.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Name | Description |
parent | BuilderParent |
Type | Description |
PipelineJob.Builder |
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Name | Description |
unused | UnusedPrivateParameter |
Type | Description |
Object |
toBuilder()
public PipelineJob.Builder toBuilder()
Type | Description |
PipelineJob.Builder |
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Name | Description |
output | CodedOutputStream |
Type | Description |
IOException |