Class PipelineJob (3.49.0)

public final class PipelineJob extends GeneratedMessageV3 implements PipelineJobOrBuilder

An instance of a machine learning PipelineJob.

Protobuf type google.cloud.aiplatform.v1beta1.PipelineJob

Static Fields

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int

ENCRYPTION_SPEC_FIELD_NUMBER

public static final int ENCRYPTION_SPEC_FIELD_NUMBER
Field Value
Type Description
int

END_TIME_FIELD_NUMBER

public static final int END_TIME_FIELD_NUMBER
Field Value
Type Description
int

ERROR_FIELD_NUMBER

public static final int ERROR_FIELD_NUMBER
Field Value
Type Description
int

JOB_DETAIL_FIELD_NUMBER

public static final int JOB_DETAIL_FIELD_NUMBER
Field Value
Type Description
int

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

NETWORK_FIELD_NUMBER

public static final int NETWORK_FIELD_NUMBER
Field Value
Type Description
int

PIPELINE_SPEC_FIELD_NUMBER

public static final int PIPELINE_SPEC_FIELD_NUMBER
Field Value
Type Description
int

PREFLIGHT_VALIDATIONS_FIELD_NUMBER

public static final int PREFLIGHT_VALIDATIONS_FIELD_NUMBER
Field Value
Type Description
int

RESERVED_IP_RANGES_FIELD_NUMBER

public static final int RESERVED_IP_RANGES_FIELD_NUMBER
Field Value
Type Description
int

RUNTIME_CONFIG_FIELD_NUMBER

public static final int RUNTIME_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

SATISFIES_PZI_FIELD_NUMBER

public static final int SATISFIES_PZI_FIELD_NUMBER
Field Value
Type Description
int

SATISFIES_PZS_FIELD_NUMBER

public static final int SATISFIES_PZS_FIELD_NUMBER
Field Value
Type Description
int

SCHEDULE_NAME_FIELD_NUMBER

public static final int SCHEDULE_NAME_FIELD_NUMBER
Field Value
Type Description
int

SERVICE_ACCOUNT_FIELD_NUMBER

public static final int SERVICE_ACCOUNT_FIELD_NUMBER
Field Value
Type Description
int

START_TIME_FIELD_NUMBER

public static final int START_TIME_FIELD_NUMBER
Field Value
Type Description
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
Type Description
int

TEMPLATE_METADATA_FIELD_NUMBER

public static final int TEMPLATE_METADATA_FIELD_NUMBER
Field Value
Type Description
int

TEMPLATE_URI_FIELD_NUMBER

public static final int TEMPLATE_URI_FIELD_NUMBER
Field Value
Type Description
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static PipelineJob getDefaultInstance()
Returns
Type Description
PipelineJob

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static PipelineJob.Builder newBuilder()
Returns
Type Description
PipelineJob.Builder

newBuilder(PipelineJob prototype)

public static PipelineJob.Builder newBuilder(PipelineJob prototype)
Parameter
Name Description
prototype PipelineJob
Returns
Type Description
PipelineJob.Builder

parseDelimitedFrom(InputStream input)

public static PipelineJob parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
PipelineJob
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PipelineJob parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PipelineJob
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static PipelineJob parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
PipelineJob
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static PipelineJob parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PipelineJob
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static PipelineJob parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
PipelineJob
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static PipelineJob parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PipelineJob
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static PipelineJob parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
PipelineJob
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static PipelineJob parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PipelineJob
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static PipelineJob parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
PipelineJob
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PipelineJob parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PipelineJob
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static PipelineJob parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
PipelineJob
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static PipelineJob parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PipelineJob
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<PipelineJob> parser()
Returns
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.

Note there is some reserved label key for Vertex AI Pipelines.

  • vertex-ai-pipelines-run-billing-id, user set value will get overrided.

map<string, string> labels = 11;

Parameter
Name Description
key String
Returns
Type Description
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getCreateTime()

public Timestamp getCreateTime()

Output only. Pipeline creation time.

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

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

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public PipelineJob getDefaultInstanceForType()
Returns
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;

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

Returns
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.v1beta1.EncryptionSpec encryption_spec = 16;

Returns
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.v1beta1.EncryptionSpec encryption_spec = 16;

Returns
Type Description
EncryptionSpecOrBuilder

getEndTime()

public Timestamp getEndTime()

Output only. Pipeline end time.

.google.protobuf.Timestamp end_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

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

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

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

Returns
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.v1beta1.PipelineJobDetail job_detail = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
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.v1beta1.PipelineJobDetail job_detail = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
PipelineJobDetailOrBuilder

getLabels() (deprecated)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
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.

Note there is some reserved label key for Vertex AI Pipelines.

  • vertex-ai-pipelines-run-billing-id, user set value will get overrided.

map<string, string> labels = 11;

Returns
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.

Note there is some reserved label key for Vertex AI Pipelines.

  • vertex-ai-pipelines-run-billing-id, user set value will get overrided.

map<string, string> labels = 11;

Returns
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.

Note there is some reserved label key for Vertex AI Pipelines.

  • vertex-ai-pipelines-run-billing-id, user set value will get overrided.

map<string, string> labels = 11;

Parameters
Name Description
key String
defaultValue String
Returns
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.

Note there is some reserved label key for Vertex AI Pipelines.

  • vertex-ai-pipelines-run-billing-id, user set value will get overrided.

map<string, string> labels = 11;

Parameter
Name Description
key String
Returns
Type Description
String

getName()

public String getName()

Output only. The resource name of the PipelineJob.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

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

Returns
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) = { ... }

Returns
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) = { ... }

Returns
Type Description
ByteString

The bytes for network.

getParserForType()

public Parser<PipelineJob> getParserForType()
Returns
Type Description
Parser<PipelineJob>
Overrides

getPipelineSpec()

public Struct getPipelineSpec()

The spec of the pipeline.

.google.protobuf.Struct pipeline_spec = 7;

Returns
Type Description
Struct

The pipelineSpec.

getPipelineSpecOrBuilder()

public StructOrBuilder getPipelineSpecOrBuilder()

The spec of the pipeline.

.google.protobuf.Struct pipeline_spec = 7;

Returns
Type Description
StructOrBuilder

getPreflightValidations()

public boolean getPreflightValidations()

Optional. Whether to do component level validations before job creation.

bool preflight_validations = 26 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The preflightValidations.

getReservedIpRanges(int index)

public String getReservedIpRanges(int index)

A list of names for the reserved ip ranges under the VPC network that can be used for this Pipeline Job's workload.

If set, we will deploy the Pipeline Job's workload within the provided ip ranges. Otherwise, the job will be deployed to any ip ranges under the provided VPC network.

Example: ['vertex-ai-ip-range'].

repeated string reserved_ip_ranges = 25;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The reservedIpRanges at the given index.

getReservedIpRangesBytes(int index)

public ByteString getReservedIpRangesBytes(int index)

A list of names for the reserved ip ranges under the VPC network that can be used for this Pipeline Job's workload.

If set, we will deploy the Pipeline Job's workload within the provided ip ranges. Otherwise, the job will be deployed to any ip ranges under the provided VPC network.

Example: ['vertex-ai-ip-range'].

repeated string reserved_ip_ranges = 25;

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the reservedIpRanges at the given index.

getReservedIpRangesCount()

public int getReservedIpRangesCount()

A list of names for the reserved ip ranges under the VPC network that can be used for this Pipeline Job's workload.

If set, we will deploy the Pipeline Job's workload within the provided ip ranges. Otherwise, the job will be deployed to any ip ranges under the provided VPC network.

Example: ['vertex-ai-ip-range'].

repeated string reserved_ip_ranges = 25;

Returns
Type Description
int

The count of reservedIpRanges.

getReservedIpRangesList()

public ProtocolStringList getReservedIpRangesList()

A list of names for the reserved ip ranges under the VPC network that can be used for this Pipeline Job's workload.

If set, we will deploy the Pipeline Job's workload within the provided ip ranges. Otherwise, the job will be deployed to any ip ranges under the provided VPC network.

Example: ['vertex-ai-ip-range'].

repeated string reserved_ip_ranges = 25;

Returns
Type Description
ProtocolStringList

A list containing the reservedIpRanges.

getRuntimeConfig()

public PipelineJob.RuntimeConfig getRuntimeConfig()

Runtime config of the pipeline.

.google.cloud.aiplatform.v1beta1.PipelineJob.RuntimeConfig runtime_config = 12;

Returns
Type Description
PipelineJob.RuntimeConfig

The runtimeConfig.

getRuntimeConfigOrBuilder()

public PipelineJob.RuntimeConfigOrBuilder getRuntimeConfigOrBuilder()

Runtime config of the pipeline.

.google.cloud.aiplatform.v1beta1.PipelineJob.RuntimeConfig runtime_config = 12;

Returns
Type Description
PipelineJob.RuntimeConfigOrBuilder

getSatisfiesPzi()

public boolean getSatisfiesPzi()

Output only. Reserved for future use.

bool satisfies_pzi = 28 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

The satisfiesPzi.

getSatisfiesPzs()

public boolean getSatisfiesPzs()

Output only. Reserved for future use.

bool satisfies_pzs = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

The satisfiesPzs.

getScheduleName()

public String getScheduleName()

Output only. The schedule resource name. Only returned if the Pipeline is created by Schedule API.

string schedule_name = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The scheduleName.

getScheduleNameBytes()

public ByteString getScheduleNameBytes()

Output only. The schedule resource name. Only returned if the Pipeline is created by Schedule API.

string schedule_name = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for scheduleName.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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;

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

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

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

Returns
Type Description
TimestampOrBuilder

getState()

public PipelineState getState()

Output only. The detailed state of the job.

.google.cloud.aiplatform.v1beta1.PipelineState state = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
PipelineState

The state.

getStateValue()

public int getStateValue()

Output only. The detailed state of the job.

.google.cloud.aiplatform.v1beta1.PipelineState state = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
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.v1beta1.PipelineTemplateMetadata template_metadata = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
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.v1beta1.PipelineTemplateMetadata template_metadata = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
PipelineTemplateMetadataOrBuilder

getTemplateUri()

public String getTemplateUri()

A template uri from where the PipelineJob.pipeline_spec, if empty, will be downloaded. Currently, only uri from Vertex Template Registry & Gallery is supported. Reference to https://cloud.google.com/vertex-ai/docs/pipelines/create-pipeline-template.

string template_uri = 19;

Returns
Type Description
String

The templateUri.

getTemplateUriBytes()

public ByteString getTemplateUriBytes()

A template uri from where the PipelineJob.pipeline_spec, if empty, will be downloaded. Currently, only uri from Vertex Template Registry & Gallery is supported. Reference to https://cloud.google.com/vertex-ai/docs/pipelines/create-pipeline-template.

string template_uri = 19;

Returns
Type Description
ByteString

The bytes for templateUri.

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

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

Returns
Type Description
TimestampOrBuilder

hasCreateTime()

public boolean hasCreateTime()

Output only. Pipeline creation time.

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
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.v1beta1.EncryptionSpec encryption_spec = 16;

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

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

Returns
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.v1beta1.PipelineJobDetail job_detail = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the jobDetail field is set.

hasPipelineSpec()

public boolean hasPipelineSpec()

The spec of the pipeline.

.google.protobuf.Struct pipeline_spec = 7;

Returns
Type Description
boolean

Whether the pipelineSpec field is set.

hasRuntimeConfig()

public boolean hasRuntimeConfig()

Runtime config of the pipeline.

.google.cloud.aiplatform.v1beta1.PipelineJob.RuntimeConfig runtime_config = 12;

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

Returns
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.v1beta1.PipelineTemplateMetadata template_metadata = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];

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

Returns
Type Description
boolean

Whether the updateTime field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public PipelineJob.Builder newBuilderForType()
Returns
Type Description
PipelineJob.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected PipelineJob.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
PipelineJob.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public PipelineJob.Builder toBuilder()
Returns
Type Description
PipelineJob.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException