- 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 interface PipelineJobOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
containsLabels(String key)
public abstract 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 abstract Timestamp getCreateTime()Output only. Pipeline creation time.
.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Timestamp | The createTime. |
getCreateTimeOrBuilder()
public abstract TimestampOrBuilder getCreateTimeOrBuilder()Output only. Pipeline creation time.
.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder | |
getDisplayName()
public abstract String getDisplayName()The display name of the Pipeline. The name can be up to 128 characters long and can consist of any UTF-8 characters.
string display_name = 2;
| Returns | |
|---|---|
| Type | Description |
String | The displayName. |
getDisplayNameBytes()
public abstract ByteString getDisplayNameBytes()The display name of the Pipeline. The name can be up to 128 characters long and can consist of any UTF-8 characters.
string display_name = 2;
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for displayName. |
getEncryptionSpec()
public abstract EncryptionSpec getEncryptionSpec()Customer-managed encryption key spec for a pipelineJob. If set, this PipelineJob and all of its sub-resources will be secured by this key.
.google.cloud.aiplatform.v1beta1.EncryptionSpec encryption_spec = 16;
| Returns | |
|---|---|
| Type | Description |
EncryptionSpec | The encryptionSpec. |
getEncryptionSpecOrBuilder()
public abstract EncryptionSpecOrBuilder getEncryptionSpecOrBuilder()Customer-managed encryption key spec for a pipelineJob. If set, this PipelineJob and all of its sub-resources will be secured by this key.
.google.cloud.aiplatform.v1beta1.EncryptionSpec encryption_spec = 16;
| Returns | |
|---|---|
| Type | Description |
EncryptionSpecOrBuilder | |
getEndTime()
public abstract Timestamp getEndTime()Output only. Pipeline end time.
.google.protobuf.Timestamp end_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Timestamp | The endTime. |
getEndTimeOrBuilder()
public abstract 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 abstract Status getError()Output only. The error that occurred during pipeline execution. Only populated when the pipeline's state is FAILED or CANCELLED.
.google.rpc.Status error = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
com.google.rpc.Status | The error. |
getErrorOrBuilder()
public abstract 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 abstract PipelineJobDetail getJobDetail()Output only. The details of pipeline run. Not available in the list view.
.google.cloud.aiplatform.v1beta1.PipelineJobDetail job_detail = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
PipelineJobDetail | The jobDetail. |
getJobDetailOrBuilder()
public abstract PipelineJobDetailOrBuilder getJobDetailOrBuilder()Output only. The details of pipeline run. Not available in the list view.
.google.cloud.aiplatform.v1beta1.PipelineJobDetail job_detail = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
PipelineJobDetailOrBuilder | |
getLabels()
public abstract Map<String,String> getLabels()Use #getLabelsMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> | |
getLabelsCount()
public abstract 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 abstract 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 abstract 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 abstract 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 | |
getName()
public abstract 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 abstract 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 abstract String getNetwork() The full name of the Compute Engine
network to which the
Pipeline Job's workload should be peered. For example,
projects/12345/global/networks/myVPC.
Format
is of the form projects/{project}/global/networks/{network}.
Where {project} is a project number, as in 12345, and {network} is a
network name.
Private services access must already be configured for the network. Pipeline job will apply the network configuration to the Google Cloud resources being launched, if applied, such as Vertex AI Training or Dataflow job. If left unspecified, the workload is not peered with any network.
string network = 18 [(.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
String | The network. |
getNetworkBytes()
public abstract ByteString getNetworkBytes() The full name of the Compute Engine
network to which the
Pipeline Job's workload should be peered. For example,
projects/12345/global/networks/myVPC.
Format
is of the form projects/{project}/global/networks/{network}.
Where {project} is a project number, as in 12345, and {network} is a
network name.
Private services access must already be configured for the network. Pipeline job will apply the network configuration to the Google Cloud resources being launched, if applied, such as Vertex AI Training or Dataflow job. If left unspecified, the workload is not peered with any network.
string network = 18 [(.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for network. |
getPipelineSpec()
public abstract Struct getPipelineSpec()The spec of the pipeline.
.google.protobuf.Struct pipeline_spec = 7;
| Returns | |
|---|---|
| Type | Description |
Struct | The pipelineSpec. |
getPipelineSpecOrBuilder()
public abstract StructOrBuilder getPipelineSpecOrBuilder()The spec of the pipeline.
.google.protobuf.Struct pipeline_spec = 7;
| Returns | |
|---|---|
| Type | Description |
StructOrBuilder | |
getRuntimeConfig()
public abstract PipelineJob.RuntimeConfig getRuntimeConfig()Runtime config of the pipeline.
.google.cloud.aiplatform.v1beta1.PipelineJob.RuntimeConfig runtime_config = 12;
| Returns | |
|---|---|
| Type | Description |
PipelineJob.RuntimeConfig | The runtimeConfig. |
getRuntimeConfigOrBuilder()
public abstract PipelineJob.RuntimeConfigOrBuilder getRuntimeConfigOrBuilder()Runtime config of the pipeline.
.google.cloud.aiplatform.v1beta1.PipelineJob.RuntimeConfig runtime_config = 12;
| Returns | |
|---|---|
| Type | Description |
PipelineJob.RuntimeConfigOrBuilder | |
getServiceAccount()
public abstract 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 abstract 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 abstract Timestamp getStartTime()Output only. Pipeline start time.
.google.protobuf.Timestamp start_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Timestamp | The startTime. |
getStartTimeOrBuilder()
public abstract 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 abstract PipelineState getState()Output only. The detailed state of the job.
.google.cloud.aiplatform.v1beta1.PipelineState state = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
PipelineState | The state. |
getStateValue()
public abstract int getStateValue()Output only. The detailed state of the job.
.google.cloud.aiplatform.v1beta1.PipelineState state = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
int | The enum numeric value on the wire for state. |
getTemplateMetadata()
public abstract PipelineTemplateMetadata getTemplateMetadata()Output only. Pipeline template metadata. Will fill up fields if PipelineJob.template_uri is from supported template registry.
.google.cloud.aiplatform.v1beta1.PipelineTemplateMetadata template_metadata = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
PipelineTemplateMetadata | The templateMetadata. |
getTemplateMetadataOrBuilder()
public abstract PipelineTemplateMetadataOrBuilder getTemplateMetadataOrBuilder()Output only. Pipeline template metadata. Will fill up fields if PipelineJob.template_uri is from supported template registry.
.google.cloud.aiplatform.v1beta1.PipelineTemplateMetadata template_metadata = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
PipelineTemplateMetadataOrBuilder | |
getTemplateUri()
public abstract String getTemplateUri()A template uri from where the PipelineJob.pipeline_spec, if empty, will be downloaded.
string template_uri = 19;
| Returns | |
|---|---|
| Type | Description |
String | The templateUri. |
getTemplateUriBytes()
public abstract ByteString getTemplateUriBytes()A template uri from where the PipelineJob.pipeline_spec, if empty, will be downloaded.
string template_uri = 19;
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for templateUri. |
getUpdateTime()
public abstract Timestamp getUpdateTime()Output only. Timestamp when this PipelineJob was most recently updated.
.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Timestamp | The updateTime. |
getUpdateTimeOrBuilder()
public abstract 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 abstract 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 abstract boolean hasEncryptionSpec()Customer-managed encryption key spec for a pipelineJob. If set, this PipelineJob and all of its sub-resources will be secured by this key.
.google.cloud.aiplatform.v1beta1.EncryptionSpec encryption_spec = 16;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the encryptionSpec field is set. |
hasEndTime()
public abstract 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 abstract 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 abstract boolean hasJobDetail()Output only. The details of pipeline run. Not available in the list view.
.google.cloud.aiplatform.v1beta1.PipelineJobDetail job_detail = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the jobDetail field is set. |
hasPipelineSpec()
public abstract boolean hasPipelineSpec()The spec of the pipeline.
.google.protobuf.Struct pipeline_spec = 7;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the pipelineSpec field is set. |
hasRuntimeConfig()
public abstract boolean hasRuntimeConfig()Runtime config of the pipeline.
.google.cloud.aiplatform.v1beta1.PipelineJob.RuntimeConfig runtime_config = 12;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the runtimeConfig field is set. |
hasStartTime()
public abstract boolean hasStartTime()Output only. Pipeline start time.
.google.protobuf.Timestamp start_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the startTime field is set. |
hasTemplateMetadata()
public abstract boolean hasTemplateMetadata()Output only. Pipeline template metadata. Will fill up fields if PipelineJob.template_uri is from supported template registry.
.google.cloud.aiplatform.v1beta1.PipelineTemplateMetadata template_metadata = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the templateMetadata field is set. |
hasUpdateTime()
public abstract 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. |