Class: Google::Cloud::Orchestration::Airflow::Service::V1::ListWorkloadsResponse

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/orchestration/airflow/service/v1/environments.rb

Overview

Response to ListWorkloadsRequest.

Defined Under Namespace

Modules: ComposerWorkloadState, ComposerWorkloadType Classes: ComposerWorkload, ComposerWorkloadStatus

Instance Attribute Summary collapse

Instance Attribute Details

#next_page_token ⇒ ::String

Returns The page token used to query for the next page if one exists.

Returns:

  • (::String) —

    The page token used to query for the next page if one exists.



588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
 
# File 'proto_docs/google/cloud/orchestration/airflow/service/v1/environments.rb', line 588

class ListWorkloadsResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Information about a single workload.
  # @!attribute [rw] name
  #   @return [::String]
  #     Name of a workload.
  # @!attribute [rw] type
  #   @return [::Google::Cloud::Orchestration::Airflow::Service::V1::ListWorkloadsResponse::ComposerWorkloadType]
  #     Type of a workload.
  # @!attribute [r] status
  #   @return [::Google::Cloud::Orchestration::Airflow::Service::V1::ListWorkloadsResponse::ComposerWorkloadStatus]
  #     Output only. Status of a workload.
  class ComposerWorkload
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Workload status.
  # @!attribute [r] state
  #   @return [::Google::Cloud::Orchestration::Airflow::Service::V1::ListWorkloadsResponse::ComposerWorkloadState]
  #     Output only. Workload state.
  # @!attribute [r] status_message
  #   @return [::String]
  #     Output only. Text to provide more descriptive status.
  # @!attribute [r] detailed_status_message
  #   @return [::String]
  #     Output only. Detailed message of the status.
  class ComposerWorkloadStatus
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Supported workload types.
  module ComposerWorkloadType
    # Not able to determine the type of the workload.
    COMPOSER_WORKLOAD_TYPE_UNSPECIFIED = 0

    # Celery worker.
    CELERY_WORKER = 1

    # Kubernetes worker.
    KUBERNETES_WORKER = 2

    # Workload created by Kubernetes Pod Operator.
    KUBERNETES_OPERATOR_POD = 3

    # Airflow scheduler.
    SCHEDULER = 4

    # Airflow Dag processor.
    DAG_PROCESSOR = 5

    # Airflow triggerer.
    TRIGGERER = 6

    # Airflow web server UI.
    WEB_SERVER = 7

    # Redis.
    REDIS = 8
  end

  # Workload states.
  module ComposerWorkloadState
    # Not able to determine the status of the workload.
    COMPOSER_WORKLOAD_STATE_UNSPECIFIED = 0

    # Workload is in pending state and has not yet started.
    PENDING = 1

    # Workload is running fine.
    OK = 2

    # Workload is running but there are some non-critical problems.
    WARNING = 3

    # Workload is not running due to an error.
    ERROR = 4

    # Workload has finished execution with success.
    SUCCEEDED = 5

    # Workload has finished execution with failure.
    FAILED = 6
  end
end

#workloads ⇒ ::Array<::Google::Cloud::Orchestration::Airflow::Service::V1::ListWorkloadsResponse::ComposerWorkload>

Returns The list of environment workloads.

Returns:



588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
 
# File 'proto_docs/google/cloud/orchestration/airflow/service/v1/environments.rb', line 588

class ListWorkloadsResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Information about a single workload.
  # @!attribute [rw] name
  #   @return [::String]
  #     Name of a workload.
  # @!attribute [rw] type
  #   @return [::Google::Cloud::Orchestration::Airflow::Service::V1::ListWorkloadsResponse::ComposerWorkloadType]
  #     Type of a workload.
  # @!attribute [r] status
  #   @return [::Google::Cloud::Orchestration::Airflow::Service::V1::ListWorkloadsResponse::ComposerWorkloadStatus]
  #     Output only. Status of a workload.
  class ComposerWorkload
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Workload status.
  # @!attribute [r] state
  #   @return [::Google::Cloud::Orchestration::Airflow::Service::V1::ListWorkloadsResponse::ComposerWorkloadState]
  #     Output only. Workload state.
  # @!attribute [r] status_message
  #   @return [::String]
  #     Output only. Text to provide more descriptive status.
  # @!attribute [r] detailed_status_message
  #   @return [::String]
  #     Output only. Detailed message of the status.
  class ComposerWorkloadStatus
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Supported workload types.
  module ComposerWorkloadType
    # Not able to determine the type of the workload.
    COMPOSER_WORKLOAD_TYPE_UNSPECIFIED = 0

    # Celery worker.
    CELERY_WORKER = 1

    # Kubernetes worker.
    KUBERNETES_WORKER = 2

    # Workload created by Kubernetes Pod Operator.
    KUBERNETES_OPERATOR_POD = 3

    # Airflow scheduler.
    SCHEDULER = 4

    # Airflow Dag processor.
    DAG_PROCESSOR = 5

    # Airflow triggerer.
    TRIGGERER = 6

    # Airflow web server UI.
    WEB_SERVER = 7

    # Redis.
    REDIS = 8
  end

  # Workload states.
  module ComposerWorkloadState
    # Not able to determine the status of the workload.
    COMPOSER_WORKLOAD_STATE_UNSPECIFIED = 0

    # Workload is in pending state and has not yet started.
    PENDING = 1

    # Workload is running fine.
    OK = 2

    # Workload is running but there are some non-critical problems.
    WARNING = 3

    # Workload is not running due to an error.
    ERROR = 4

    # Workload has finished execution with success.
    SUCCEEDED = 5

    # Workload has finished execution with failure.
    FAILED = 6
  end
end