com.google.cloud.aiplatform.v1beta1

Interface PipelineJobOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

PipelineJob, PipelineJob.Builder

public interface PipelineJobOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
boolean	containsLabels(String key) The labels with user-defined metadata to organize PipelineJob.
com.google.protobuf.Timestamp	getCreateTime() Output only.
com.google.protobuf.TimestampOrBuilder	getCreateTimeOrBuilder() Output only.
String	getDisplayName() The display name of the Pipeline.
com.google.protobuf.ByteString	getDisplayNameBytes() The display name of the Pipeline.
EncryptionSpec	getEncryptionSpec() Customer-managed encryption key spec for a pipelineJob.
EncryptionSpecOrBuilder	getEncryptionSpecOrBuilder() Customer-managed encryption key spec for a pipelineJob.
com.google.protobuf.Timestamp	getEndTime() Output only.
com.google.protobuf.TimestampOrBuilder	getEndTimeOrBuilder() Output only.
com.google.rpc.Status	getError() Output only.
com.google.rpc.StatusOrBuilder	getErrorOrBuilder() Output only.
PipelineJobDetail	getJobDetail() Output only.
PipelineJobDetailOrBuilder	getJobDetailOrBuilder() Output only.
Map<String,String>	getLabels() Deprecated.
int	getLabelsCount() The labels with user-defined metadata to organize PipelineJob.
Map<String,String>	getLabelsMap() The labels with user-defined metadata to organize PipelineJob.
String	getLabelsOrDefault(String key, String defaultValue) The labels with user-defined metadata to organize PipelineJob.
String	getLabelsOrThrow(String key) The labels with user-defined metadata to organize PipelineJob.
String	getName() Output only.
com.google.protobuf.ByteString	getNameBytes() Output only.
String	getNetwork() The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to which the Pipeline Job's workload should be peered.
com.google.protobuf.ByteString	getNetworkBytes() The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to which the Pipeline Job's workload should be peered.
com.google.protobuf.Struct	getPipelineSpec() The spec of the pipeline.
com.google.protobuf.StructOrBuilder	getPipelineSpecOrBuilder() The spec of the pipeline.
PipelineJob.RuntimeConfig	getRuntimeConfig() Runtime config of the pipeline.
PipelineJob.RuntimeConfigOrBuilder	getRuntimeConfigOrBuilder() Runtime config of the pipeline.
String	getServiceAccount() The service account that the pipeline workload runs as.
com.google.protobuf.ByteString	getServiceAccountBytes() The service account that the pipeline workload runs as.
com.google.protobuf.Timestamp	getStartTime() Output only.
com.google.protobuf.TimestampOrBuilder	getStartTimeOrBuilder() Output only.
PipelineState	getState() Output only.
int	getStateValue() Output only.
PipelineTemplateMetadata	getTemplateMetadata() Output only.
PipelineTemplateMetadataOrBuilder	getTemplateMetadataOrBuilder() Output only.
String	getTemplateUri() A template uri from where the [PipelineJob.pipeline_spec][google.cloud.aiplatform.v1beta1.PipelineJob.pipeline_spec], if empty, will be downloaded.
com.google.protobuf.ByteString	getTemplateUriBytes() A template uri from where the [PipelineJob.pipeline_spec][google.cloud.aiplatform.v1beta1.PipelineJob.pipeline_spec], if empty, will be downloaded.
com.google.protobuf.Timestamp	getUpdateTime() Output only.
com.google.protobuf.TimestampOrBuilder	getUpdateTimeOrBuilder() Output only.
boolean	hasCreateTime() Output only.
boolean	hasEncryptionSpec() Customer-managed encryption key spec for a pipelineJob.
boolean	hasEndTime() Output only.
boolean	hasError() Output only.
boolean	hasJobDetail() Output only.
boolean	hasPipelineSpec() The spec of the pipeline.
boolean	hasRuntimeConfig() Runtime config of the pipeline.
boolean	hasStartTime() Output only.
boolean	hasTemplateMetadata() Output only.
boolean	hasUpdateTime() Output only.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getName

String getName()

 Output only. The resource name of the PipelineJob.
 

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

Returns:

The name.

getNameBytes

com.google.protobuf.ByteString getNameBytes()

 Output only. The resource name of the PipelineJob.
 

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

Returns:

The bytes for name.

getDisplayName

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:

The displayName.

getDisplayNameBytes

com.google.protobuf.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:

The bytes for displayName.

hasCreateTime

boolean hasCreateTime()

 Output only. Pipeline creation time.
 

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

Returns:

Whether the createTime field is set.

getCreateTime

com.google.protobuf.Timestamp getCreateTime()

 Output only. Pipeline creation time.
 

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

Returns:

The createTime.

getCreateTimeOrBuilder

com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()

 Output only. Pipeline creation time.
 

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

hasStartTime

boolean hasStartTime()

 Output only. Pipeline start time.
 

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

Returns:

Whether the startTime field is set.

getStartTime

com.google.protobuf.Timestamp getStartTime()

 Output only. Pipeline start time.
 

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

Returns:

The startTime.

getStartTimeOrBuilder

com.google.protobuf.TimestampOrBuilder getStartTimeOrBuilder()

 Output only. Pipeline start time.
 

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

hasEndTime

boolean hasEndTime()

 Output only. Pipeline end time.
 

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

Returns:

Whether the endTime field is set.

getEndTime

com.google.protobuf.Timestamp getEndTime()

 Output only. Pipeline end time.
 

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

Returns:

The endTime.

getEndTimeOrBuilder

com.google.protobuf.TimestampOrBuilder getEndTimeOrBuilder()

 Output only. Pipeline end time.
 

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

hasUpdateTime

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:

Whether the updateTime field is set.

getUpdateTime

com.google.protobuf.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:

The updateTime.

getUpdateTimeOrBuilder

com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()

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

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

hasPipelineSpec

boolean hasPipelineSpec()

 The spec of the pipeline.
 

.google.protobuf.Struct pipeline_spec = 7;

Returns:

Whether the pipelineSpec field is set.

getPipelineSpec

com.google.protobuf.Struct getPipelineSpec()

 The spec of the pipeline.
 

.google.protobuf.Struct pipeline_spec = 7;

Returns:

The pipelineSpec.

getPipelineSpecOrBuilder

com.google.protobuf.StructOrBuilder getPipelineSpecOrBuilder()

 The spec of the pipeline.
 

.google.protobuf.Struct pipeline_spec = 7;

getStateValue

int getStateValue()

 Output only. The detailed state of the job.
 

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

Returns:

The enum numeric value on the wire for state.

getState

PipelineState getState()

 Output only. The detailed state of the job.
 

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

Returns:

The state.

hasJobDetail

boolean hasJobDetail()

 Output only. The details of pipeline run. Not available in the list view.
 

.google.cloud.aiplatform.v1beta1.PipelineJobDetail job_detail = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

Whether the jobDetail field is set.

getJobDetail

PipelineJobDetail getJobDetail()

 Output only. The details of pipeline run. Not available in the list view.
 

.google.cloud.aiplatform.v1beta1.PipelineJobDetail job_detail = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The jobDetail.

getJobDetailOrBuilder

PipelineJobDetailOrBuilder getJobDetailOrBuilder()

 Output only. The details of pipeline run. Not available in the list view.
 

.google.cloud.aiplatform.v1beta1.PipelineJobDetail job_detail = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

hasError

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:

Whether the error field is set.

getError

com.google.rpc.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:

The error.

getErrorOrBuilder

com.google.rpc.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];

getLabelsCount

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;

containsLabels

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;

getLabels

@Deprecated
Map<String,String> getLabels()

Deprecated.

Use getLabelsMap() instead.

getLabelsMap

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;

getLabelsOrDefault

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;

getLabelsOrThrow

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;

hasRuntimeConfig

boolean hasRuntimeConfig()

 Runtime config of the pipeline.
 

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

Returns:

Whether the runtimeConfig field is set.

getRuntimeConfig

PipelineJob.RuntimeConfig getRuntimeConfig()

 Runtime config of the pipeline.
 

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

Returns:

The runtimeConfig.

getRuntimeConfigOrBuilder

PipelineJob.RuntimeConfigOrBuilder getRuntimeConfigOrBuilder()

 Runtime config of the pipeline.
 

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

hasEncryptionSpec

boolean hasEncryptionSpec()

 Customer-managed encryption key spec for a pipelineJob. If set, this
 PipelineJob and all of its sub-resources will be secured by this key.
 

.google.cloud.aiplatform.v1beta1.EncryptionSpec encryption_spec = 16;

Returns:

Whether the encryptionSpec field is set.

getEncryptionSpec

EncryptionSpec getEncryptionSpec()

 Customer-managed encryption key spec for a pipelineJob. If set, this
 PipelineJob and all of its sub-resources will be secured by this key.
 

.google.cloud.aiplatform.v1beta1.EncryptionSpec encryption_spec = 16;

Returns:

The encryptionSpec.

getEncryptionSpecOrBuilder

EncryptionSpecOrBuilder getEncryptionSpecOrBuilder()

 Customer-managed encryption key spec for a pipelineJob. If set, this
 PipelineJob and all of its sub-resources will be secured by this key.
 

.google.cloud.aiplatform.v1beta1.EncryptionSpec encryption_spec = 16;

getServiceAccount

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:

The serviceAccount.

getServiceAccountBytes

com.google.protobuf.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:

The bytes for serviceAccount.

getNetwork

String getNetwork()

 The full name of the Compute Engine
 [network](/compute/docs/networks-and-firewalls#networks) to which the
 Pipeline Job's workload should be peered. For example,
 `projects/12345/global/networks/myVPC`.
 [Format](/compute/docs/reference/rest/v1/networks/insert)
 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:

The network.

getNetworkBytes

com.google.protobuf.ByteString getNetworkBytes()

 The full name of the Compute Engine
 [network](/compute/docs/networks-and-firewalls#networks) to which the
 Pipeline Job's workload should be peered. For example,
 `projects/12345/global/networks/myVPC`.
 [Format](/compute/docs/reference/rest/v1/networks/insert)
 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:

The bytes for network.

getTemplateUri

String getTemplateUri()

 A template uri from where the [PipelineJob.pipeline_spec][google.cloud.aiplatform.v1beta1.PipelineJob.pipeline_spec], if empty, will
 be downloaded.
 

string template_uri = 19;

Returns:

The templateUri.

getTemplateUriBytes

com.google.protobuf.ByteString getTemplateUriBytes()

 A template uri from where the [PipelineJob.pipeline_spec][google.cloud.aiplatform.v1beta1.PipelineJob.pipeline_spec], if empty, will
 be downloaded.
 

string template_uri = 19;

Returns:

The bytes for templateUri.

hasTemplateMetadata

boolean hasTemplateMetadata()

 Output only. Pipeline template metadata. Will fill up fields if
 [PipelineJob.template_uri][google.cloud.aiplatform.v1beta1.PipelineJob.template_uri] is from supported template registry.
 

.google.cloud.aiplatform.v1beta1.PipelineTemplateMetadata template_metadata = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

Whether the templateMetadata field is set.

getTemplateMetadata

PipelineTemplateMetadata getTemplateMetadata()

 Output only. Pipeline template metadata. Will fill up fields if
 [PipelineJob.template_uri][google.cloud.aiplatform.v1beta1.PipelineJob.template_uri] is from supported template registry.
 

.google.cloud.aiplatform.v1beta1.PipelineTemplateMetadata template_metadata = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The templateMetadata.

getTemplateMetadataOrBuilder

PipelineTemplateMetadataOrBuilder getTemplateMetadataOrBuilder()

 Output only. Pipeline template metadata. Will fill up fields if
 [PipelineJob.template_uri][google.cloud.aiplatform.v1beta1.PipelineJob.template_uri] is from supported template registry.
 

.google.cloud.aiplatform.v1beta1.PipelineTemplateMetadata template_metadata = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];