Package com.google.cloud.aiplatform.v1

Class PipelineJob

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.aiplatform.v1.PipelineJob
All Implemented Interfaces:
PipelineJobOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class PipelineJob extends com.google.protobuf.GeneratedMessage implements PipelineJobOrBuilder
 An instance of a machine learning PipelineJob.
Protobuf type google.cloud.aiplatform.v1.PipelineJob
See Also:

  • Field Details

    • NAME_FIELD_NUMBER

      public static final int NAME_FIELD_NUMBER
      See Also:

    • DISPLAY_NAME_FIELD_NUMBER

      public static final int DISPLAY_NAME_FIELD_NUMBER
      See Also:

    • CREATE_TIME_FIELD_NUMBER

      public static final int CREATE_TIME_FIELD_NUMBER
      See Also:

    • START_TIME_FIELD_NUMBER

      public static final int START_TIME_FIELD_NUMBER
      See Also:

    • END_TIME_FIELD_NUMBER

      public static final int END_TIME_FIELD_NUMBER
      See Also:

    • UPDATE_TIME_FIELD_NUMBER

      public static final int UPDATE_TIME_FIELD_NUMBER
      See Also:

    • PIPELINE_SPEC_FIELD_NUMBER

      public static final int PIPELINE_SPEC_FIELD_NUMBER
      See Also:

    • STATE_FIELD_NUMBER

      public static final int STATE_FIELD_NUMBER
      See Also:

    • JOB_DETAIL_FIELD_NUMBER

      public static final int JOB_DETAIL_FIELD_NUMBER
      See Also:

    • ERROR_FIELD_NUMBER

      public static final int ERROR_FIELD_NUMBER
      See Also:

    • LABELS_FIELD_NUMBER

      public static final int LABELS_FIELD_NUMBER
      See Also:

    • RUNTIME_CONFIG_FIELD_NUMBER

      public static final int RUNTIME_CONFIG_FIELD_NUMBER
      See Also:

    • ENCRYPTION_SPEC_FIELD_NUMBER

      public static final int ENCRYPTION_SPEC_FIELD_NUMBER
      See Also:

    • SERVICE_ACCOUNT_FIELD_NUMBER

      public static final int SERVICE_ACCOUNT_FIELD_NUMBER
      See Also:

    • NETWORK_FIELD_NUMBER

      public static final int NETWORK_FIELD_NUMBER
      See Also:

    • RESERVED_IP_RANGES_FIELD_NUMBER

      public static final int RESERVED_IP_RANGES_FIELD_NUMBER
      See Also:

    • PSC_INTERFACE_CONFIG_FIELD_NUMBER

      public static final int PSC_INTERFACE_CONFIG_FIELD_NUMBER
      See Also:

    • TEMPLATE_URI_FIELD_NUMBER

      public static final int TEMPLATE_URI_FIELD_NUMBER
      See Also:

    • TEMPLATE_METADATA_FIELD_NUMBER

      public static final int TEMPLATE_METADATA_FIELD_NUMBER
      See Also:

    • SCHEDULE_NAME_FIELD_NUMBER

      public static final int SCHEDULE_NAME_FIELD_NUMBER
      See Also:

    • PREFLIGHT_VALIDATIONS_FIELD_NUMBER

      public static final int PREFLIGHT_VALIDATIONS_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
      Overrides:
      internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessage

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getName

      public String getName()
       Output only. The resource name of the PipelineJob.
      string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getName in interface PipelineJobOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       Output only. The resource name of the PipelineJob.
      string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getNameBytes in interface PipelineJobOrBuilder
      Returns:
      The bytes for name.

    • getDisplayName

      public String getDisplayName()
       The display name of the Pipeline.
 The name can be up to 128 characters long and can consist of any UTF-8
 characters.
      string display_name = 2;
      Specified by:
      getDisplayName in interface PipelineJobOrBuilder
      Returns:
      The displayName.

    • getDisplayNameBytes

      public com.google.protobuf.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;
      Specified by:
      getDisplayNameBytes in interface PipelineJobOrBuilder
      Returns:
      The bytes for displayName.

    • hasCreateTime

      public boolean hasCreateTime()
       Output only. Pipeline creation time.
      .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasCreateTime in interface PipelineJobOrBuilder
      Returns:
      Whether the createTime field is set.

    • getCreateTime

      public com.google.protobuf.Timestamp getCreateTime()
       Output only. Pipeline creation time.
      .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getCreateTime in interface PipelineJobOrBuilder
      Returns:
      The createTime.

    • getCreateTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
       Output only. Pipeline creation time.
      .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getCreateTimeOrBuilder in interface PipelineJobOrBuilder

    • hasStartTime

      public boolean hasStartTime()
       Output only. Pipeline start time.
      .google.protobuf.Timestamp start_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasStartTime in interface PipelineJobOrBuilder
      Returns:
      Whether the startTime field is set.

    • getStartTime

      public com.google.protobuf.Timestamp getStartTime()
       Output only. Pipeline start time.
      .google.protobuf.Timestamp start_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getStartTime in interface PipelineJobOrBuilder
      Returns:
      The startTime.

    • getStartTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getStartTimeOrBuilder()
       Output only. Pipeline start time.
      .google.protobuf.Timestamp start_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getStartTimeOrBuilder in interface PipelineJobOrBuilder

    • hasEndTime

      public boolean hasEndTime()
       Output only. Pipeline end time.
      .google.protobuf.Timestamp end_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasEndTime in interface PipelineJobOrBuilder
      Returns:
      Whether the endTime field is set.

    • getEndTime

      public com.google.protobuf.Timestamp getEndTime()
       Output only. Pipeline end time.
      .google.protobuf.Timestamp end_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getEndTime in interface PipelineJobOrBuilder
      Returns:
      The endTime.

    • getEndTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getEndTimeOrBuilder()
       Output only. Pipeline end time.
      .google.protobuf.Timestamp end_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getEndTimeOrBuilder in interface PipelineJobOrBuilder

    • 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];
      Specified by:
      hasUpdateTime in interface PipelineJobOrBuilder
      Returns:
      Whether the updateTime field is set.

    • getUpdateTime

      public 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];
      Specified by:
      getUpdateTime in interface PipelineJobOrBuilder
      Returns:
      The updateTime.

    • getUpdateTimeOrBuilder

      public 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];
      Specified by:
      getUpdateTimeOrBuilder in interface PipelineJobOrBuilder

    • hasPipelineSpec

      public boolean hasPipelineSpec()
       The spec of the pipeline.
      .google.protobuf.Struct pipeline_spec = 7;
      Specified by:
      hasPipelineSpec in interface PipelineJobOrBuilder
      Returns:
      Whether the pipelineSpec field is set.

    • getPipelineSpec

      public com.google.protobuf.Struct getPipelineSpec()
       The spec of the pipeline.
      .google.protobuf.Struct pipeline_spec = 7;
      Specified by:
      getPipelineSpec in interface PipelineJobOrBuilder
      Returns:
      The pipelineSpec.

    • getPipelineSpecOrBuilder

      public com.google.protobuf.StructOrBuilder getPipelineSpecOrBuilder()
       The spec of the pipeline.
      .google.protobuf.Struct pipeline_spec = 7;
      Specified by:
      getPipelineSpecOrBuilder in interface PipelineJobOrBuilder

    • 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];
      Specified by:
      getStateValue in interface PipelineJobOrBuilder
      Returns:
      The enum numeric value on the wire for state.

    • 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];
      Specified by:
      getState in interface PipelineJobOrBuilder
      Returns:
      The state.

    • 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];
      Specified by:
      hasJobDetail in interface PipelineJobOrBuilder
      Returns:
      Whether the jobDetail field is set.

    • 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];
      Specified by:
      getJobDetail in interface PipelineJobOrBuilder
      Returns:
      The jobDetail.

    • 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];
      Specified by:
      getJobDetailOrBuilder in interface PipelineJobOrBuilder

    • 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];
      Specified by:
      hasError in interface PipelineJobOrBuilder
      Returns:
      Whether the error field is set.

    • 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];
      Specified by:
      getError in interface PipelineJobOrBuilder
      Returns:
      The error.

    • getErrorOrBuilder

      public StatusOrBuilder getErrorOrBuilder()
       Output only. The error that occurred during pipeline execution.
 Only populated when the pipeline's state is FAILED or CANCELLED.
      .google.rpc.Status error = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getErrorOrBuilder in interface PipelineJobOrBuilder

    • getLabelsCount

      public int getLabelsCount()
      Description copied from interface: PipelineJobOrBuilder
       The labels with user-defined metadata to organize PipelineJob.

 Label keys and values can be no longer than 64 characters
 (Unicode codepoints), can only contain lowercase letters, numeric
 characters, underscores and dashes. International characters are allowed.

 See https://goo.gl/xmQnxf for more information and examples of labels.

 Note there is some reserved label key for Vertex AI Pipelines.
 - `vertex-ai-pipelines-run-billing-id`, user set value will get overrided.
      map<string, string> labels = 11;
      Specified by:
      getLabelsCount in interface PipelineJobOrBuilder

    • containsLabels

      public boolean containsLabels(String key)
       The labels with user-defined metadata to organize PipelineJob.

 Label keys and values can be no longer than 64 characters
 (Unicode codepoints), can only contain lowercase letters, numeric
 characters, underscores and dashes. International characters are allowed.

 See https://goo.gl/xmQnxf for more information and examples of labels.

 Note there is some reserved label key for Vertex AI Pipelines.
 - `vertex-ai-pipelines-run-billing-id`, user set value will get overrided.
      map<string, string> labels = 11;
      Specified by:
      containsLabels in interface PipelineJobOrBuilder

    • getLabels

      @Deprecated public Map<String,String> getLabels()
      Deprecated.
      Use getLabelsMap() instead.
      Specified by:
      getLabels in interface PipelineJobOrBuilder

    • getLabelsMap

      public Map<String,String> getLabelsMap()
       The labels with user-defined metadata to organize PipelineJob.

 Label keys and values can be no longer than 64 characters
 (Unicode codepoints), can only contain lowercase letters, numeric
 characters, underscores and dashes. International characters are allowed.

 See https://goo.gl/xmQnxf for more information and examples of labels.

 Note there is some reserved label key for Vertex AI Pipelines.
 - `vertex-ai-pipelines-run-billing-id`, user set value will get overrided.
      map<string, string> labels = 11;
      Specified by:
      getLabelsMap in interface PipelineJobOrBuilder

    • getLabelsOrDefault

      public String getLabelsOrDefault(String key, String defaultValue)
       The labels with user-defined metadata to organize PipelineJob.

 Label keys and values can be no longer than 64 characters
 (Unicode codepoints), can only contain lowercase letters, numeric
 characters, underscores and dashes. International characters are allowed.

 See https://goo.gl/xmQnxf for more information and examples of labels.

 Note there is some reserved label key for Vertex AI Pipelines.
 - `vertex-ai-pipelines-run-billing-id`, user set value will get overrided.
      map<string, string> labels = 11;
      Specified by:
      getLabelsOrDefault in interface PipelineJobOrBuilder

    • getLabelsOrThrow

      public String getLabelsOrThrow(String key)
       The labels with user-defined metadata to organize PipelineJob.

 Label keys and values can be no longer than 64 characters
 (Unicode codepoints), can only contain lowercase letters, numeric
 characters, underscores and dashes. International characters are allowed.

 See https://goo.gl/xmQnxf for more information and examples of labels.

 Note there is some reserved label key for Vertex AI Pipelines.
 - `vertex-ai-pipelines-run-billing-id`, user set value will get overrided.
      map<string, string> labels = 11;
      Specified by:
      getLabelsOrThrow in interface PipelineJobOrBuilder

    • hasRuntimeConfig

      public boolean hasRuntimeConfig()
       Runtime config of the pipeline.
      .google.cloud.aiplatform.v1.PipelineJob.RuntimeConfig runtime_config = 12;
      Specified by:
      hasRuntimeConfig in interface PipelineJobOrBuilder
      Returns:
      Whether the runtimeConfig field is set.

    • getRuntimeConfig

      public PipelineJob.RuntimeConfig getRuntimeConfig()
       Runtime config of the pipeline.
      .google.cloud.aiplatform.v1.PipelineJob.RuntimeConfig runtime_config = 12;
      Specified by:
      getRuntimeConfig in interface PipelineJobOrBuilder
      Returns:
      The runtimeConfig.

    • getRuntimeConfigOrBuilder

      public PipelineJob.RuntimeConfigOrBuilder getRuntimeConfigOrBuilder()
       Runtime config of the pipeline.
      .google.cloud.aiplatform.v1.PipelineJob.RuntimeConfig runtime_config = 12;
      Specified by:
      getRuntimeConfigOrBuilder in interface PipelineJobOrBuilder

    • 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;
      Specified by:
      hasEncryptionSpec in interface PipelineJobOrBuilder
      Returns:
      Whether the encryptionSpec field is set.

    • 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;
      Specified by:
      getEncryptionSpec in interface PipelineJobOrBuilder
      Returns:
      The encryptionSpec.

    • getEncryptionSpecOrBuilder

      public EncryptionSpecOrBuilder getEncryptionSpecOrBuilder()
       Customer-managed encryption key spec for a pipelineJob. If set, this
 PipelineJob and all of its sub-resources will be secured by this key.
      .google.cloud.aiplatform.v1.EncryptionSpec encryption_spec = 16;
      Specified by:
      getEncryptionSpecOrBuilder in interface PipelineJobOrBuilder

    • 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;
      Specified by:
      getServiceAccount in interface PipelineJobOrBuilder
      Returns:
      The serviceAccount.

    • getServiceAccountBytes

      public 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;
      Specified by:
      getServiceAccountBytes in interface PipelineJobOrBuilder
      Returns:
      The bytes for serviceAccount.

    • getNetwork

      public 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 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) = { ... }
      Specified by:
      getNetwork in interface PipelineJobOrBuilder
      Returns:
      The network.

    • getNetworkBytes

      public 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 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) = { ... }
      Specified by:
      getNetworkBytes in interface PipelineJobOrBuilder
      Returns:
      The bytes for network.

    • getReservedIpRangesList

      public com.google.protobuf.ProtocolStringList getReservedIpRangesList()
       A list of names for the reserved ip ranges under the VPC network
 that can be used for this Pipeline Job's workload.

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

 Example: ['vertex-ai-ip-range'].
      repeated string reserved_ip_ranges = 25;
      Specified by:
      getReservedIpRangesList in interface PipelineJobOrBuilder
      Returns:
      A list containing the reservedIpRanges.

    • getReservedIpRangesCount

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

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

 Example: ['vertex-ai-ip-range'].
      repeated string reserved_ip_ranges = 25;
      Specified by:
      getReservedIpRangesCount in interface PipelineJobOrBuilder
      Returns:
      The count of reservedIpRanges.

    • getReservedIpRanges

      public String getReservedIpRanges(int index)
       A list of names for the reserved ip ranges under the VPC network
 that can be used for this Pipeline Job's workload.

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

 Example: ['vertex-ai-ip-range'].
      repeated string reserved_ip_ranges = 25;
      Specified by:
      getReservedIpRanges in interface PipelineJobOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The reservedIpRanges at the given index.

    • getReservedIpRangesBytes

      public com.google.protobuf.ByteString getReservedIpRangesBytes(int index)
       A list of names for the reserved ip ranges under the VPC network
 that can be used for this Pipeline Job's workload.

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

 Example: ['vertex-ai-ip-range'].
      repeated string reserved_ip_ranges = 25;
      Specified by:
      getReservedIpRangesBytes in interface PipelineJobOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the reservedIpRanges at the given index.

    • hasPscInterfaceConfig

      public boolean hasPscInterfaceConfig()
       Optional. Configuration for PSC-I for PipelineJob.
      .google.cloud.aiplatform.v1.PscInterfaceConfig psc_interface_config = 31 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasPscInterfaceConfig in interface PipelineJobOrBuilder
      Returns:
      Whether the pscInterfaceConfig field is set.

    • getPscInterfaceConfig

      public PscInterfaceConfig getPscInterfaceConfig()
       Optional. Configuration for PSC-I for PipelineJob.
      .google.cloud.aiplatform.v1.PscInterfaceConfig psc_interface_config = 31 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getPscInterfaceConfig in interface PipelineJobOrBuilder
      Returns:
      The pscInterfaceConfig.

    • getPscInterfaceConfigOrBuilder

      public PscInterfaceConfigOrBuilder getPscInterfaceConfigOrBuilder()
       Optional. Configuration for PSC-I for PipelineJob.
      .google.cloud.aiplatform.v1.PscInterfaceConfig psc_interface_config = 31 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getPscInterfaceConfigOrBuilder in interface PipelineJobOrBuilder

    • getTemplateUri

      public String getTemplateUri()
       A template uri from where the
 [PipelineJob.pipeline_spec][google.cloud.aiplatform.v1.PipelineJob.pipeline_spec],
 if empty, will be downloaded. Currently, only uri from Vertex Template
 Registry & Gallery is supported. Reference to
 https://cloud.google.com/vertex-ai/docs/pipelines/create-pipeline-template.
      string template_uri = 19;
      Specified by:
      getTemplateUri in interface PipelineJobOrBuilder
      Returns:
      The templateUri.

    • getTemplateUriBytes

      public com.google.protobuf.ByteString getTemplateUriBytes()
       A template uri from where the
 [PipelineJob.pipeline_spec][google.cloud.aiplatform.v1.PipelineJob.pipeline_spec],
 if empty, will be downloaded. Currently, only uri from Vertex Template
 Registry & Gallery is supported. Reference to
 https://cloud.google.com/vertex-ai/docs/pipelines/create-pipeline-template.
      string template_uri = 19;
      Specified by:
      getTemplateUriBytes in interface PipelineJobOrBuilder
      Returns:
      The bytes for templateUri.

    • hasTemplateMetadata

      public boolean hasTemplateMetadata()
       Output only. Pipeline template metadata. Will fill up fields if
 [PipelineJob.template_uri][google.cloud.aiplatform.v1.PipelineJob.template_uri]
 is from supported template registry.
      .google.cloud.aiplatform.v1.PipelineTemplateMetadata template_metadata = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasTemplateMetadata in interface PipelineJobOrBuilder
      Returns:
      Whether the templateMetadata field is set.

    • getTemplateMetadata

      public PipelineTemplateMetadata getTemplateMetadata()
       Output only. Pipeline template metadata. Will fill up fields if
 [PipelineJob.template_uri][google.cloud.aiplatform.v1.PipelineJob.template_uri]
 is from supported template registry.
      .google.cloud.aiplatform.v1.PipelineTemplateMetadata template_metadata = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getTemplateMetadata in interface PipelineJobOrBuilder
      Returns:
      The templateMetadata.

    • getTemplateMetadataOrBuilder

      public PipelineTemplateMetadataOrBuilder getTemplateMetadataOrBuilder()
       Output only. Pipeline template metadata. Will fill up fields if
 [PipelineJob.template_uri][google.cloud.aiplatform.v1.PipelineJob.template_uri]
 is from supported template registry.
      .google.cloud.aiplatform.v1.PipelineTemplateMetadata template_metadata = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getTemplateMetadataOrBuilder in interface PipelineJobOrBuilder

    • getScheduleName

      public String getScheduleName()
       Output only. The schedule resource name.
 Only returned if the Pipeline is created by Schedule API.
      string schedule_name = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getScheduleName in interface PipelineJobOrBuilder
      Returns:
      The scheduleName.

    • getScheduleNameBytes

      public com.google.protobuf.ByteString getScheduleNameBytes()
       Output only. The schedule resource name.
 Only returned if the Pipeline is created by Schedule API.
      string schedule_name = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getScheduleNameBytes in interface PipelineJobOrBuilder
      Returns:
      The bytes for scheduleName.

    • getPreflightValidations

      public boolean getPreflightValidations()
       Optional. Whether to do component level validations before job creation.
      bool preflight_validations = 26 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getPreflightValidations in interface PipelineJobOrBuilder
      Returns:
      The preflightValidations.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static PipelineJob parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static PipelineJob parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static PipelineJob parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static PipelineJob parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static PipelineJob parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static PipelineJob parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static PipelineJob parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static PipelineJob parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static PipelineJob parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static PipelineJob parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static PipelineJob parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static PipelineJob parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public PipelineJob.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static PipelineJob.Builder newBuilder()

    • newBuilder

      public static PipelineJob.Builder newBuilder(PipelineJob prototype)

    • toBuilder

      public PipelineJob.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected PipelineJob.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static PipelineJob getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<PipelineJob> parser()

    • getParserForType

      public com.google.protobuf.Parser<PipelineJob> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public PipelineJob getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder