class_docstr: Hook for Google Cloud Vertex AI Custom Job APIs.
docstr: Lists PipelineJobs in a Location.
  
  This method is deprecated, please use `PipelineJobHook.list_pipeline_jobs` method.
  
  :param project_id: Required. The ID of the Google Cloud project that the service belongs to.
  :param region: Required. The ID of the Google Cloud region that the service belongs to.
  :param filter: Optional. Lists the PipelineJobs that match the filter expression. The
      following fields are supported:
  
      -  ``pipeline_name``: Supports ``=`` and ``!=`` comparisons.
      -  ``display_name``: Supports ``=``, ``!=`` comparisons, and
         ``:`` wildcard.
      -  ``pipeline_job_user_id``: Supports ``=``, ``!=``
         comparisons, and ``:`` wildcard. for example, can check
         if pipeline's display_name contains *step* by doing
         display_name:"*step*"
      -  ``create_time``: Supports ``=``, ``!=``, ``<``, ``>``,
         ``<=``, and ``>=`` comparisons. Values must be in RFC
         3339 format.
      -  ``update_time``: Supports ``=``, ``!=``, ``<``, ``>``,
         ``<=``, and ``>=`` comparisons. Values must be in RFC
         3339 format.
      -  ``end_time``: Supports ``=``, ``!=``, ``<``, ``>``,
         ``<=``, and ``>=`` comparisons. Values must be in RFC
         3339 format.
      -  ``labels``: Supports key-value equality and key presence.
  
      Filter expressions can be combined together using logical
      operators (``AND`` & ``OR``). For example:
      ``pipeline_name="test" AND create_time>"2020-05-18T13:30:00Z"``.
  
      The syntax to define filter expression is based on
      https://google.aip.dev/160.
  :param page_size: Optional. The standard list page size.
  :param page_token: Optional. The standard list page token. Typically obtained via
      [ListPipelineJobsResponse.next_page_token][google.cloud.aiplatform.v1.ListPipelineJobsResponse.next_page_token]
      of the previous
      [PipelineService.ListPipelineJobs][google.cloud.aiplatform.v1.PipelineService.ListPipelineJobs]
      call.
  :param order_by: Optional. A comma-separated list of fields to order by. The default
      sort order is in ascending order. Use "desc" after a field
      name for descending. You can have multiple order_by fields
      provided e.g. "create_time desc, end_time", "end_time,
      start_time, update_time" For example, using "create_time
      desc, end_time" will order results by create time in
      descending order, and if there are multiple jobs having the
      same create time, order them by the end time in ascending
      order. if order_by is not specified, it will order by
      default order is create time in descending order. Supported
      fields:
  
      -  ``create_time``
      -  ``update_time``
      -  ``end_time``
      -  ``start_time``
  :param retry: Designation of what errors, if any, should be retried.
  :param timeout: The timeout for this request.
  :param metadata: Strings which should be sent along with the request as metadata.
docstr_tok: ["Lists","PipelineJobs","in","a","Location",".","This","method","is","deprecated",",","please","use","`","PipelineJobHook.list_pipeline_jobs","`","method",".",":","param","project_id",":","Required",".","The","ID","of","the","Google","Cloud","project","that","the","service","belongs","to",".",":","param","region",":","Required",".","The","ID","of","the","Google","Cloud","region","that","the","service","belongs","to",".",":","param","filter",":","Optional",".","Lists","the","PipelineJobs","that","match","the","filter","expression",".","The","following","fields","are","supported",":","-","``","pipeline_name","``",":","Supports","``","=","``","and","``","!","=","``","comparisons",".","-","``","display_name","``",":","Supports","``","=","``",",","``","!","=","``","comparisons",",","and","``",":","``","wildcard",".","-","``","pipeline_job_user_id","``",":","Supports","``","=","``",",","``","!","=","``","comparisons",",","and","``",":","``","wildcard",".","for","example",",","can","check","if","pipeline","'s","display_name","contains","*","step","*","by","doing","display_name",":","''","*","step","*","''","-","``","create_time","``",":","Supports","``","=","``",",","``","!","=","``",",","``","<","``",",","``",">","``",",","``","<","=","``",",","and","``",">","=","``","comparisons",".","Values","must","be","in","RFC","3339","format",".","-","``","update_time","``",":","Supports","``","=","``",",","``","!","=","``",",","``","<","``",",","``",">","``",",","``","<","=","``",",","and","``",">","=","``","comparisons",".","Values","must","be","in","RFC","3339","format",".","-","``","end_time","``",":","Supports","``","=","``",",","``","!","=","``",",","``","<","``",",","``",">","``",",","``","<","=","``",",","and","``",">","=","``","comparisons",".","Values","must","be","in","RFC","3339","format",".","-","``","labels","``",":","Supports","key-value","equality","and","key","presence",".","Filter","expressions","can","be","combined","together","using","logical","operators","(","``","AND","``","&","``","OR","``",")",".","For","example",":","``","pipeline_name=","''","test","''","AND","create_time",">","''","2020-05-18T13:30:00Z","''","``",".","The","syntax","to","define","filter","expression","is","based","on","https",":","\/\/google.aip.dev\/160",".",":","param","page_size",":","Optional",".","The","standard","list","page","size",".",":","param","page_token",":","Optional",".","The","standard","list","page","token",".","Typically","obtained","via","[","ListPipelineJobsResponse.next_page_token","]","[","google.cloud.aiplatform.v1.ListPipelineJobsResponse.next_page_token","]","of","the","previous","[","PipelineService.ListPipelineJobs","]","[","google.cloud.aiplatform.v1.PipelineService.ListPipelineJobs","]","call",".",":","param","order_by",":","Optional",".","A","comma-separated","list","of","fields","to","order","by",".","The","default","sort","order","is","in","ascending","order",".","Use","``","desc","''","after","a","field","name","for","descending",".","You","can","have","multiple","order_by","fields","provided","e.g",".","``","create_time","desc",",","end_time","''",",","``","end_time",",","start_time",",","update_time","''","For","example",",","using","``","create_time","desc",",","end_time","''","will","order","results","by","create","time","in","descending","order",",","and","if","there","are","multiple","jobs","having","the","same","create","time",",","order","them","by","the","end","time","in","ascending","order",".","if","order_by","is","not","specified",",","it","will","order","by","default","order","is","create","time","in","descending","order",".","Supported","fields",":","-","``","create_time","``","-","``","update_time","``","-","``","end_time","``","-","``","start_time","``",":","param","retry",":","Designation","of","what","errors",",","if","any",",","should","be","retried",".",":","param","timeout",":","The","timeout","for","this","request",".",":","param","metadata",":","Strings","which","should","be","sent","along","with","the","request","as","metadata","."]
code: def list_pipeline_jobs(
      self,
      project_id: str,
      region: str,
      page_size: int | None = None,
      page_token: str | None = None,
      filter: str | None = None,
      order_by: str | None = None,
      retry: Retry | _MethodDefault = DEFAULT,
      timeout: float | None = None,
      metadata: Sequence[tuple[str, str]] = (),
  ) -> ListPipelineJobsPager:
      """
      Lists PipelineJobs in a Location.
  
      This method is deprecated, please use `PipelineJobHook.list_pipeline_jobs` method.
  
      :param project_id: Required. The ID of the Google Cloud project that the service belongs to.
      :param region: Required. The ID of the Google Cloud region that the service belongs to.
      :param filter: Optional. Lists the PipelineJobs that match the filter expression. The
          following fields are supported:
  
          -  ``pipeline_name``: Supports ``=`` and ``!=`` comparisons.
          -  ``display_name``: Supports ``=``, ``!=`` comparisons, and
             ``:`` wildcard.
          -  ``pipeline_job_user_id``: Supports ``=``, ``!=``
             comparisons, and ``:`` wildcard. for example, can check
             if pipeline's display_name contains *step* by doing
             display_name:"*step*"
          -  ``create_time``: Supports ``=``, ``!=``, ``<``, ``>``,
             ``<=``, and ``>=`` comparisons. Values must be in RFC
             3339 format.
          -  ``update_time``: Supports ``=``, ``!=``, ``<``, ``>``,
             ``<=``, and ``>=`` comparisons. Values must be in RFC
             3339 format.
          -  ``end_time``: Supports ``=``, ``!=``, ``<``, ``>``,
             ``<=``, and ``>=`` comparisons. Values must be in RFC
             3339 format.
          -  ``labels``: Supports key-value equality and key presence.
  
          Filter expressions can be combined together using logical
          operators (``AND`` & ``OR``). For example:
          ``pipeline_name="test" AND create_time>"2020-05-18T13:30:00Z"``.
  
          The syntax to define filter expression is based on
          https://google.aip.dev/160.
      :param page_size: Optional. The standard list page size.
      :param page_token: Optional. The standard list page token. Typically obtained via
          [ListPipelineJobsResponse.next_page_token][google.cloud.aiplatform.v1.ListPipelineJobsResponse.next_page_token]
          of the previous
          [PipelineService.ListPipelineJobs][google.cloud.aiplatform.v1.PipelineService.ListPipelineJobs]
          call.
      :param order_by: Optional. A comma-separated list of fields to order by. The default
          sort order is in ascending order. Use "desc" after a field
          name for descending. You can have multiple order_by fields
          provided e.g. "create_time desc, end_time", "end_time,
          start_time, update_time" For example, using "create_time
          desc, end_time" will order results by create time in
          descending order, and if there are multiple jobs having the
          same create time, order them by the end time in ascending
          order. if order_by is not specified, it will order by
          default order is create time in descending order. Supported
          fields:
  
          -  ``create_time``
          -  ``update_time``
          -  ``end_time``
          -  ``start_time``
      :param retry: Designation of what errors, if any, should be retried.
      :param timeout: The timeout for this request.
      :param metadata: Strings which should be sent along with the request as metadata.
      """
      warnings.warn(
          "This method is deprecated, please use `PipelineJobHook.list_pipeline_jobs` method.",
          AirflowProviderDeprecationWarning,
      )
      client = self.get_pipeline_service_client(region)
      parent = client.common_location_path(project_id, region)
  
      result = client.list_pipeline_jobs(
          request={
              "parent": parent,
              "page_size": page_size,
              "page_token": page_token,
              "filter": filter,
              "order_by": order_by,
          },
          retry=retry,
          timeout=timeout,
          metadata=metadata,
      )
      return result
  
imports: from __future__ import annotations
  import warnings
  from typing import TYPE_CHECKING, Sequence
  from google.api_core.client_options import ClientOptions
  from google.api_core.gapic_v1.method import DEFAULT, _MethodDefault
  from google.cloud.aiplatform import CustomContainerTrainingJob, CustomPythonPackageTrainingJob, CustomTrainingJob, datasets, models
  from google.cloud.aiplatform_v1 import JobServiceClient, PipelineServiceClient
  from airflow.exceptions import AirflowException, AirflowProviderDeprecationWarning
  from airflow.providers.google.common.consts import CLIENT_INFO
  from airflow.providers.google.common.hooks.base_google import GoogleBaseHook
label_desc: Use image node_id 28 for calling the CustomJobHook obj's underlying member method code with example usage: obj.list_pipeline_jobs(project_id, region, page_size, page_token, filter, order_by, retry, timeout, metadata) and returns: result