Class PipelineJob.Builder (3.4.1)

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

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public PipelineJob.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
PipelineJob.Builder
Overrides

build()

public PipelineJob build()
Returns
TypeDescription
PipelineJob

buildPartial()

public PipelineJob buildPartial()
Returns
TypeDescription
PipelineJob

clear()

public PipelineJob.Builder clear()
Returns
TypeDescription
PipelineJob.Builder
Overrides

clearCreateTime()

public PipelineJob.Builder clearCreateTime()

Output only. Pipeline creation time.

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

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

clearField(Descriptors.FieldDescriptor field)

public PipelineJob.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
PipelineJob.Builder
Overrides

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

clearLabels()

public PipelineJob.Builder clearLabels()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
PipelineJob.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public PipelineJob.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
PipelineJob.Builder
Overrides

clearPipelineSpec()

public PipelineJob.Builder clearPipelineSpec()

The spec of the pipeline.

.google.protobuf.Struct pipeline_spec = 7;

Returns
TypeDescription
PipelineJob.Builder

clearRuntimeConfig()

public PipelineJob.Builder clearRuntimeConfig()

Runtime config of the pipeline.

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

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

This builder for chaining.

clearTemplateMetadata()

public PipelineJob.Builder clearTemplateMetadata()

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

Returns
TypeDescription
PipelineJob.Builder

clearTemplateUri()

public PipelineJob.Builder clearTemplateUri()

A template uri from where the PipelineJob.pipeline_spec, if empty, will be downloaded.

string template_uri = 19;

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

clone()

public PipelineJob.Builder clone()
Returns
TypeDescription
PipelineJob.Builder
Overrides

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
NameDescription
keyString
Returns
TypeDescription
boolean

getCreateTime()

public Timestamp getCreateTime()

Output only. Pipeline creation time.

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

Returns
TypeDescription
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
TypeDescription
Builder

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Pipeline creation time.

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

Returns
TypeDescription
TimestampOrBuilder

getDefaultInstanceForType()

public PipelineJob getDefaultInstanceForType()
Returns
TypeDescription
PipelineJob

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
EncryptionSpecOrBuilder

getEndTime()

public Timestamp getEndTime()

Output only. Pipeline end time.

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

Returns
TypeDescription
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
TypeDescription
Builder

getEndTimeOrBuilder()

public TimestampOrBuilder getEndTimeOrBuilder()

Output only. Pipeline end time.

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

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
PipelineJobDetailOrBuilder

getLabels()

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
keyString
defaultValueString
Returns
TypeDescription
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
NameDescription
keyString
Returns
TypeDescription
String

getMutableLabels()

public Map<String,String> getMutableLabels()

Use alternate mutation accessors instead.

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for network.

getPipelineSpec()

public Struct getPipelineSpec()

The spec of the pipeline.

.google.protobuf.Struct pipeline_spec = 7;

Returns
TypeDescription
Struct

The pipelineSpec.

getPipelineSpecBuilder()

public Struct.Builder getPipelineSpecBuilder()

The spec of the pipeline.

.google.protobuf.Struct pipeline_spec = 7;

Returns
TypeDescription
Builder

getPipelineSpecOrBuilder()

public StructOrBuilder getPipelineSpecOrBuilder()

The spec of the pipeline.

.google.protobuf.Struct pipeline_spec = 7;

Returns
TypeDescription
StructOrBuilder

getRuntimeConfig()

public PipelineJob.RuntimeConfig getRuntimeConfig()

Runtime config of the pipeline.

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

Returns
TypeDescription
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
TypeDescription
PipelineJob.RuntimeConfig.Builder

getRuntimeConfigOrBuilder()

public PipelineJob.RuntimeConfigOrBuilder getRuntimeConfigOrBuilder()

Runtime config of the pipeline.

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

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
Builder

getStartTimeOrBuilder()

public TimestampOrBuilder getStartTimeOrBuilder()

Output only. Pipeline start time.

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

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

Returns
TypeDescription
PipelineTemplateMetadata

The templateMetadata.

getTemplateMetadataBuilder()

public PipelineTemplateMetadata.Builder getTemplateMetadataBuilder()

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

Returns
TypeDescription
PipelineTemplateMetadata.Builder

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

Returns
TypeDescription
PipelineTemplateMetadataOrBuilder

getTemplateUri()

public String getTemplateUri()

A template uri from where the PipelineJob.pipeline_spec, if empty, will be downloaded.

string template_uri = 19;

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

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
TimestampOrBuilder

hasCreateTime()

public boolean hasCreateTime()

Output only. Pipeline creation time.

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

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

Whether the jobDetail field is set.

hasPipelineSpec()

public boolean hasPipelineSpec()

The spec of the pipeline.

.google.protobuf.Struct pipeline_spec = 7;

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

Returns
TypeDescription
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
TypeDescription
boolean

Whether the updateTime field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

internalGetMutableMapField(int number)

protected MapField internalGetMutableMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

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
NameDescription
valueTimestamp
Returns
TypeDescription
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
NameDescription
valueEncryptionSpec
Returns
TypeDescription
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
NameDescription
valueTimestamp
Returns
TypeDescription
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
NameDescription
valuecom.google.rpc.Status
Returns
TypeDescription
PipelineJob.Builder

mergeFrom(PipelineJob other)

public PipelineJob.Builder mergeFrom(PipelineJob other)
Parameter
NameDescription
otherPipelineJob
Returns
TypeDescription
PipelineJob.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public PipelineJob.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PipelineJob.Builder
Overrides Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public PipelineJob.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
PipelineJob.Builder
Overrides

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
NameDescription
valuePipelineJobDetail
Returns
TypeDescription
PipelineJob.Builder

mergePipelineSpec(Struct value)

public PipelineJob.Builder mergePipelineSpec(Struct value)

The spec of the pipeline.

.google.protobuf.Struct pipeline_spec = 7;

Parameter
NameDescription
valueStruct
Returns
TypeDescription
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
NameDescription
valuePipelineJob.RuntimeConfig
Returns
TypeDescription
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
NameDescription
valueTimestamp
Returns
TypeDescription
PipelineJob.Builder

mergeTemplateMetadata(PipelineTemplateMetadata value)

public PipelineJob.Builder mergeTemplateMetadata(PipelineTemplateMetadata value)

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

Parameter
NameDescription
valuePipelineTemplateMetadata
Returns
TypeDescription
PipelineJob.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final PipelineJob.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
PipelineJob.Builder
Overrides

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
NameDescription
valueTimestamp
Returns
TypeDescription
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
NameDescription
valuesMap<String,String>
Returns
TypeDescription
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
NameDescription
keyString
valueString
Returns
TypeDescription
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
NameDescription
keyString
Returns
TypeDescription
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
NameDescription
valueTimestamp
Returns
TypeDescription
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
NameDescription
builderForValueBuilder
Returns
TypeDescription
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
NameDescription
valueString

The displayName to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for displayName to set.

Returns
TypeDescription
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
NameDescription
valueEncryptionSpec
Returns
TypeDescription
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
NameDescription
builderForValueEncryptionSpec.Builder
Returns
TypeDescription
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
NameDescription
valueTimestamp
Returns
TypeDescription
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
NameDescription
builderForValueBuilder
Returns
TypeDescription
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
NameDescription
valuecom.google.rpc.Status
Returns
TypeDescription
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
NameDescription
builderForValuecom.google.rpc.Status.Builder
Returns
TypeDescription
PipelineJob.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public PipelineJob.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
PipelineJob.Builder
Overrides

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
NameDescription
valuePipelineJobDetail
Returns
TypeDescription
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
NameDescription
builderForValuePipelineJobDetail.Builder
Returns
TypeDescription
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
NameDescription
valueString

The name to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for name to set.

Returns
TypeDescription
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
NameDescription
valueString

The network to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for network to set.

Returns
TypeDescription
PipelineJob.Builder

This builder for chaining.

setPipelineSpec(Struct value)

public PipelineJob.Builder setPipelineSpec(Struct value)

The spec of the pipeline.

.google.protobuf.Struct pipeline_spec = 7;

Parameter
NameDescription
valueStruct
Returns
TypeDescription
PipelineJob.Builder

setPipelineSpec(Struct.Builder builderForValue)

public PipelineJob.Builder setPipelineSpec(Struct.Builder builderForValue)

The spec of the pipeline.

.google.protobuf.Struct pipeline_spec = 7;

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
PipelineJob.Builder

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

public PipelineJob.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
PipelineJob.Builder
Overrides

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
NameDescription
valuePipelineJob.RuntimeConfig
Returns
TypeDescription
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
NameDescription
builderForValuePipelineJob.RuntimeConfig.Builder
Returns
TypeDescription
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
NameDescription
valueString

The serviceAccount to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for serviceAccount to set.

Returns
TypeDescription
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
NameDescription
valueTimestamp
Returns
TypeDescription
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
NameDescription
builderForValueBuilder
Returns
TypeDescription
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
NameDescription
valuePipelineState

The state to set.

Returns
TypeDescription
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
NameDescription
valueint

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

Returns
TypeDescription
PipelineJob.Builder

This builder for chaining.

setTemplateMetadata(PipelineTemplateMetadata value)

public PipelineJob.Builder setTemplateMetadata(PipelineTemplateMetadata value)

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

Parameter
NameDescription
valuePipelineTemplateMetadata
Returns
TypeDescription
PipelineJob.Builder

setTemplateMetadata(PipelineTemplateMetadata.Builder builderForValue)

public PipelineJob.Builder setTemplateMetadata(PipelineTemplateMetadata.Builder builderForValue)

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

Parameter
NameDescription
builderForValuePipelineTemplateMetadata.Builder
Returns
TypeDescription
PipelineJob.Builder

setTemplateUri(String value)

public PipelineJob.Builder setTemplateUri(String value)

A template uri from where the PipelineJob.pipeline_spec, if empty, will be downloaded.

string template_uri = 19;

Parameter
NameDescription
valueString

The templateUri to set.

Returns
TypeDescription
PipelineJob.Builder

This builder for chaining.

setTemplateUriBytes(ByteString value)

public PipelineJob.Builder setTemplateUriBytes(ByteString value)

A template uri from where the PipelineJob.pipeline_spec, if empty, will be downloaded.

string template_uri = 19;

Parameter
NameDescription
valueByteString

The bytes for templateUri to set.

Returns
TypeDescription
PipelineJob.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final PipelineJob.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
PipelineJob.Builder
Overrides

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
NameDescription
valueTimestamp
Returns
TypeDescription
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
NameDescription
builderForValueBuilder
Returns
TypeDescription
PipelineJob.Builder