Class PipelineJob.Builder (2.4.0)

Version 2.4.0

• 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 static final class PipelineJob.Builder extends GeneratedMessageV3.Builder<PipelineJob.Builder> implements PipelineJobOrBuilder

An instance of a machine learning PipelineJob.

Protobuf type google.cloud.aiplatform.v1.PipelineJob

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > PipelineJob.Builder

Implements

PipelineJobOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeDelimitedFrom(InputStream)

AbstractMessage.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public PipelineJob.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters

Name	Description
field	FieldDescriptor
value	Object

Returns

Type	Description
PipelineJob.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public PipelineJob build()

Returns

Type	Description
PipelineJob

buildPartial()

public PipelineJob buildPartial()

Returns

Type	Description
PipelineJob

clear()

public PipelineJob.Builder clear()

Returns

Type	Description
PipelineJob.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearCreateTime()

public PipelineJob.Builder clearCreateTime()

Output only. Pipeline creation time.

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

Returns

Type	Description
PipelineJob.Builder

clearDisplayName()

public PipelineJob.Builder clearDisplayName()

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;

Returns

Type	Description
PipelineJob.Builder	This builder for chaining.

clearEncryptionSpec()

public PipelineJob.Builder clearEncryptionSpec()

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;

Returns

Type	Description
PipelineJob.Builder

clearEndTime()

public PipelineJob.Builder clearEndTime()

Output only. Pipeline end time.

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

Returns

Type	Description
PipelineJob.Builder

clearError()

public PipelineJob.Builder clearError()

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
PipelineJob.Builder

clearField(Descriptors.FieldDescriptor field)

public PipelineJob.Builder clearField(Descriptors.FieldDescriptor field)

Parameter

Name	Description
field	FieldDescriptor

Returns

Type	Description
PipelineJob.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearJobDetail()

public PipelineJob.Builder clearJobDetail()

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

Returns

Type	Description
PipelineJob.Builder

clearLabels()

public PipelineJob.Builder clearLabels()

Returns

Type	Description
PipelineJob.Builder

clearName()

public PipelineJob.Builder clearName()

Output only. The resource name of the PipelineJob.

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

Returns

Type	Description
PipelineJob.Builder	This builder for chaining.

clearNetwork()

public PipelineJob.Builder clearNetwork()

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

Returns

Type	Description
PipelineJob.Builder	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public PipelineJob.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter

Name	Description
oneof	OneofDescriptor

Returns

Type	Description
PipelineJob.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearPipelineSpec()

public PipelineJob.Builder clearPipelineSpec()

Required. The spec of the pipeline.

.google.protobuf.Struct pipeline_spec = 7 [(.google.api.field_behavior) = REQUIRED];

Returns

Type	Description
PipelineJob.Builder

clearRuntimeConfig()

public PipelineJob.Builder clearRuntimeConfig()

Runtime config of the pipeline.

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

Returns

Type	Description
PipelineJob.Builder

clearServiceAccount()

public PipelineJob.Builder clearServiceAccount()

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
PipelineJob.Builder	This builder for chaining.

clearStartTime()

public PipelineJob.Builder clearStartTime()

Output only. Pipeline start time.

.google.protobuf.Timestamp start_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
PipelineJob.Builder

clearState()

public PipelineJob.Builder clearState()

Output only. The detailed state of the job.

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

Returns

Type	Description
PipelineJob.Builder	This builder for chaining.

clearUpdateTime()

public PipelineJob.Builder clearUpdateTime()

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
PipelineJob.Builder

clone()

public PipelineJob.Builder clone()

Returns

Type	Description
PipelineJob.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

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;

Parameter

Name	Description
key	String

Returns

Type	Description
boolean

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.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

Output only. Pipeline creation time.

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

Returns

Type	Description
Builder

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

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns

Type	Description
Descriptor

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns

Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getDisplayName()

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;

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 be 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.v1.EncryptionSpec encryption_spec = 16;

Returns

Type	Description
EncryptionSpec	The encryptionSpec.

getEncryptionSpecBuilder()

public EncryptionSpec.Builder getEncryptionSpecBuilder()

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;

Returns

Type	Description
EncryptionSpec.Builder

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;

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.

getEndTimeBuilder()

public Timestamp.Builder getEndTimeBuilder()

Output only. Pipeline end time.

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

Returns

Type	Description
Builder

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.

getErrorBuilder()

public Status.Builder getErrorBuilder()

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

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

Returns

Type	Description
PipelineJobDetail	The jobDetail.

getJobDetailBuilder()

public PipelineJobDetail.Builder getJobDetailBuilder()

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

Returns

Type	Description
PipelineJobDetail.Builder

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

Returns

Type	Description
PipelineJobDetailOrBuilder

getLabels()

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.

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.

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.

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.

map<string, string> labels = 11;

Parameter

Name	Description
key	String

Returns

Type	Description
String

getMutableLabels()

public Map<String,String> getMutableLabels()

Use alternate mutation accessors instead.

Returns

Type	Description
Map<String,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 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) = { ... }

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

Returns

Type	Description
ByteString	The bytes for network.

getPipelineSpec()

public Struct getPipelineSpec()

Required. The spec of the pipeline.

.google.protobuf.Struct pipeline_spec = 7 [(.google.api.field_behavior) = REQUIRED];

Returns

Type	Description
Struct	The pipelineSpec.

getPipelineSpecBuilder()

public Struct.Builder getPipelineSpecBuilder()

Required. The spec of the pipeline.

.google.protobuf.Struct pipeline_spec = 7 [(.google.api.field_behavior) = REQUIRED];

Returns

Type	Description
Builder

getPipelineSpecOrBuilder()

public StructOrBuilder getPipelineSpecOrBuilder()

Required. The spec of the pipeline.

.google.protobuf.Struct pipeline_spec = 7 [(.google.api.field_behavior) = REQUIRED];

Returns

Type	Description
StructOrBuilder

getRuntimeConfig()

public PipelineJob.RuntimeConfig getRuntimeConfig()

Runtime config of the pipeline.

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

Returns

Type	Description
PipelineJob.RuntimeConfig	The runtimeConfig.

getRuntimeConfigBuilder()

public PipelineJob.RuntimeConfig.Builder getRuntimeConfigBuilder()

Runtime config of the pipeline.

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

Returns

Type	Description
PipelineJob.RuntimeConfig.Builder

getRuntimeConfigOrBuilder()

public PipelineJob.RuntimeConfigOrBuilder getRuntimeConfigOrBuilder()

Runtime config of the pipeline.

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

Returns

Type	Description
PipelineJob.RuntimeConfigOrBuilder

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.

getStartTimeBuilder()

public Timestamp.Builder getStartTimeBuilder()

Output only. Pipeline start time.

.google.protobuf.Timestamp start_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
Builder

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.v1.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.v1.PipelineState state = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
int	The enum numeric value on the wire for state.

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.

getUpdateTimeBuilder()

public Timestamp.Builder getUpdateTimeBuilder()

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
Builder

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

Returns

Type	Description
boolean	Whether the jobDetail field is set.

hasPipelineSpec()

public boolean hasPipelineSpec()

Required. The spec of the pipeline.

.google.protobuf.Struct pipeline_spec = 7 [(.google.api.field_behavior) = REQUIRED];

Returns

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;

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.

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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns

Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

internalGetMapField(int number)

protected MapField internalGetMapField(int number)

Parameter

Name	Description
number	int

Returns

Type	Description
MapField

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetMapField(int fieldNumber)

internalGetMutableMapField(int number)

protected MapField internalGetMutableMapField(int number)

Parameter

Name	Description
number	int

Returns

Type	Description
MapField

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetMutableMapField(int fieldNumber)

isInitialized()

public final boolean isInitialized()

Returns

Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeCreateTime(Timestamp value)

public PipelineJob.Builder mergeCreateTime(Timestamp value)

Output only. Pipeline creation time.

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

Parameter

Name	Description
value	Timestamp

Returns

Type	Description
PipelineJob.Builder

mergeEncryptionSpec(EncryptionSpec value)

public PipelineJob.Builder mergeEncryptionSpec(EncryptionSpec value)

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;

Parameter

Name	Description
value	EncryptionSpec

Returns

Type	Description
PipelineJob.Builder

mergeEndTime(Timestamp value)

public PipelineJob.Builder mergeEndTime(Timestamp value)

Output only. Pipeline end time.

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

Parameter

Name	Description
value	Timestamp

Returns

Type	Description
PipelineJob.Builder

mergeError(Status value)

public PipelineJob.Builder mergeError(Status value)

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

Parameter

Name	Description
value	com.google.rpc.Status

Returns

Type	Description
PipelineJob.Builder

mergeFrom(PipelineJob other)

public PipelineJob.Builder mergeFrom(PipelineJob other)

Parameter

Name	Description
other	PipelineJob

Returns

Type	Description
PipelineJob.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public PipelineJob.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
PipelineJob.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions

Type	Description
IOException

mergeFrom(Message other)

public PipelineJob.Builder mergeFrom(Message other)

Parameter

Name	Description
other	Message

Returns

Type	Description
PipelineJob.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeJobDetail(PipelineJobDetail value)

public PipelineJob.Builder mergeJobDetail(PipelineJobDetail value)

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

Parameter

Name	Description
value	PipelineJobDetail

Returns

Type	Description
PipelineJob.Builder

mergePipelineSpec(Struct value)

public PipelineJob.Builder mergePipelineSpec(Struct value)

Required. The spec of the pipeline.

.google.protobuf.Struct pipeline_spec = 7 [(.google.api.field_behavior) = REQUIRED];

Parameter

Name	Description
value	Struct

Returns

Type	Description
PipelineJob.Builder

mergeRuntimeConfig(PipelineJob.RuntimeConfig value)

public PipelineJob.Builder mergeRuntimeConfig(PipelineJob.RuntimeConfig value)

Runtime config of the pipeline.

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

Parameter

Name	Description
value	PipelineJob.RuntimeConfig

Returns

Type	Description
PipelineJob.Builder

mergeStartTime(Timestamp value)

public PipelineJob.Builder mergeStartTime(Timestamp value)

Output only. Pipeline start time.

.google.protobuf.Timestamp start_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter

Name	Description
value	Timestamp

Returns

Type	Description
PipelineJob.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final PipelineJob.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	UnknownFieldSet

Returns

Type	Description
PipelineJob.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

mergeUpdateTime(Timestamp value)

public PipelineJob.Builder mergeUpdateTime(Timestamp value)

Output only. Timestamp when this PipelineJob was most recently updated.

.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter

Name	Description
value	Timestamp

Returns

Type	Description
PipelineJob.Builder

putAllLabels(Map<String,String> values)

public PipelineJob.Builder putAllLabels(Map<String,String> values)

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;

Parameter

Name	Description
values	Map<String,String>

Returns

Type	Description
PipelineJob.Builder

putLabels(String key, String value)

public PipelineJob.Builder putLabels(String key, String value)

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;

Parameters

Name	Description
key	String
value	String

Returns

Type	Description
PipelineJob.Builder

removeLabels(String key)

public PipelineJob.Builder removeLabels(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;

Parameter

Name	Description
key	String

Returns

Type	Description
PipelineJob.Builder

setCreateTime(Timestamp value)

public PipelineJob.Builder setCreateTime(Timestamp value)

Output only. Pipeline creation time.

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

Parameter

Name	Description
value	Timestamp

Returns

Type	Description
PipelineJob.Builder

setCreateTime(Timestamp.Builder builderForValue)

public PipelineJob.Builder setCreateTime(Timestamp.Builder builderForValue)

Output only. Pipeline creation time.

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

Parameter

Name	Description
builderForValue	Builder

Returns

Type	Description
PipelineJob.Builder

setDisplayName(String value)

public PipelineJob.Builder setDisplayName(String value)

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;

Parameter

Name	Description
value	String The displayName to set.

Returns

Type	Description
PipelineJob.Builder	This builder for chaining.

setDisplayNameBytes(ByteString value)

public PipelineJob.Builder setDisplayNameBytes(ByteString value)

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;

Parameter

Name	Description
value	ByteString The bytes for displayName to set.

Returns

Type	Description
PipelineJob.Builder	This builder for chaining.

setEncryptionSpec(EncryptionSpec value)

public PipelineJob.Builder setEncryptionSpec(EncryptionSpec value)

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;

Parameter

Name	Description
value	EncryptionSpec

Returns

Type	Description
PipelineJob.Builder

setEncryptionSpec(EncryptionSpec.Builder builderForValue)

public PipelineJob.Builder setEncryptionSpec(EncryptionSpec.Builder builderForValue)

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;

Parameter

Name	Description
builderForValue	EncryptionSpec.Builder

Returns

Type	Description
PipelineJob.Builder

setEndTime(Timestamp value)

public PipelineJob.Builder setEndTime(Timestamp value)

Output only. Pipeline end time.

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

Parameter

Name	Description
value	Timestamp

Returns

Type	Description
PipelineJob.Builder

setEndTime(Timestamp.Builder builderForValue)

public PipelineJob.Builder setEndTime(Timestamp.Builder builderForValue)

Output only. Pipeline end time.

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

Parameter

Name	Description
builderForValue	Builder

Returns

Type	Description
PipelineJob.Builder

setError(Status value)

public PipelineJob.Builder setError(Status value)

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

Parameter

Name	Description
value	com.google.rpc.Status

Returns

Type	Description
PipelineJob.Builder

setError(Status.Builder builderForValue)

public PipelineJob.Builder setError(Status.Builder builderForValue)

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

Parameter

Name	Description
builderForValue	com.google.rpc.Status.Builder

Returns

Type	Description
PipelineJob.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public PipelineJob.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters

Name	Description
field	FieldDescriptor
value	Object

Returns

Type	Description
PipelineJob.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setJobDetail(PipelineJobDetail value)

public PipelineJob.Builder setJobDetail(PipelineJobDetail value)

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

Parameter

Name	Description
value	PipelineJobDetail

Returns

Type	Description
PipelineJob.Builder

setJobDetail(PipelineJobDetail.Builder builderForValue)

public PipelineJob.Builder setJobDetail(PipelineJobDetail.Builder builderForValue)

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

Parameter

Name	Description
builderForValue	PipelineJobDetail.Builder

Returns

Type	Description
PipelineJob.Builder

setName(String value)

public PipelineJob.Builder setName(String value)

Output only. The resource name of the PipelineJob.

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

Parameter

Name	Description
value	String The name to set.

Returns

Type	Description
PipelineJob.Builder	This builder for chaining.

setNameBytes(ByteString value)

public PipelineJob.Builder setNameBytes(ByteString value)

Output only. The resource name of the PipelineJob.

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

Parameter

Name	Description
value	ByteString The bytes for name to set.

Returns

Type	Description
PipelineJob.Builder	This builder for chaining.

setNetwork(String value)

public PipelineJob.Builder setNetwork(String value)

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

Parameter

Name	Description
value	String The network to set.

Returns

Type	Description
PipelineJob.Builder	This builder for chaining.

setNetworkBytes(ByteString value)

public PipelineJob.Builder setNetworkBytes(ByteString value)

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

Parameter

Name	Description
value	ByteString The bytes for network to set.

Returns

Type	Description
PipelineJob.Builder	This builder for chaining.

setPipelineSpec(Struct value)

public PipelineJob.Builder setPipelineSpec(Struct value)

Required. The spec of the pipeline.

.google.protobuf.Struct pipeline_spec = 7 [(.google.api.field_behavior) = REQUIRED];

Parameter

Name	Description
value	Struct

Returns

Type	Description
PipelineJob.Builder

setPipelineSpec(Struct.Builder builderForValue)

public PipelineJob.Builder setPipelineSpec(Struct.Builder builderForValue)

Required. The spec of the pipeline.

.google.protobuf.Struct pipeline_spec = 7 [(.google.api.field_behavior) = REQUIRED];

Parameter

Name	Description
builderForValue	Builder

Returns

Type	Description
PipelineJob.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public PipelineJob.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters

Name	Description
field	FieldDescriptor
index	int
value	Object

Returns

Type	Description
PipelineJob.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setRuntimeConfig(PipelineJob.RuntimeConfig value)

public PipelineJob.Builder setRuntimeConfig(PipelineJob.RuntimeConfig value)

Runtime config of the pipeline.

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

Parameter

Name	Description
value	PipelineJob.RuntimeConfig

Returns

Type	Description
PipelineJob.Builder

setRuntimeConfig(PipelineJob.RuntimeConfig.Builder builderForValue)

public PipelineJob.Builder setRuntimeConfig(PipelineJob.RuntimeConfig.Builder builderForValue)

Runtime config of the pipeline.

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

Parameter

Name	Description
builderForValue	PipelineJob.RuntimeConfig.Builder

Returns

Type	Description
PipelineJob.Builder

setServiceAccount(String value)

public PipelineJob.Builder setServiceAccount(String value)

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;

Parameter

Name	Description
value	String The serviceAccount to set.

Returns

Type	Description
PipelineJob.Builder	This builder for chaining.

setServiceAccountBytes(ByteString value)

public PipelineJob.Builder setServiceAccountBytes(ByteString value)

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;

Parameter

Name	Description
value	ByteString The bytes for serviceAccount to set.

Returns

Type	Description
PipelineJob.Builder	This builder for chaining.

setStartTime(Timestamp value)

public PipelineJob.Builder setStartTime(Timestamp value)

Output only. Pipeline start time.

.google.protobuf.Timestamp start_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter

Name	Description
value	Timestamp

Returns

Type	Description
PipelineJob.Builder

setStartTime(Timestamp.Builder builderForValue)

public PipelineJob.Builder setStartTime(Timestamp.Builder builderForValue)

Output only. Pipeline start time.

.google.protobuf.Timestamp start_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter

Name	Description
builderForValue	Builder

Returns

Type	Description
PipelineJob.Builder

setState(PipelineState value)

public PipelineJob.Builder setState(PipelineState value)

Output only. The detailed state of the job.

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

Parameter

Name	Description
value	PipelineState The state to set.

Returns

Type	Description
PipelineJob.Builder	This builder for chaining.

setStateValue(int value)

public PipelineJob.Builder setStateValue(int value)

Output only. The detailed state of the job.

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

Parameter

Name	Description
value	int The enum numeric value on the wire for state to set.

Returns

Type	Description
PipelineJob.Builder	This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final PipelineJob.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	UnknownFieldSet

Returns

Type	Description
PipelineJob.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)

setUpdateTime(Timestamp value)

public PipelineJob.Builder setUpdateTime(Timestamp value)

Output only. Timestamp when this PipelineJob was most recently updated.

.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter

Name	Description
value	Timestamp

Returns

Type	Description
PipelineJob.Builder

setUpdateTime(Timestamp.Builder builderForValue)

public PipelineJob.Builder setUpdateTime(Timestamp.Builder builderForValue)

Output only. Timestamp when this PipelineJob was most recently updated.

.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter

Name	Description
builderForValue	Builder

Returns

Type	Description
PipelineJob.Builder