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

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

An environment for running orchestration tasks.

Defined Under Namespace

Modules: State Classes: LabelsEntry

Instance Attribute Summary collapse

Instance Attribute Details

#config ⇒ ::Google::Cloud::Orchestration::Airflow::Service::V1::EnvironmentConfig

Returns Configuration parameters for this environment.

Returns:



677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
 
# File 'proto_docs/google/cloud/orchestration/airflow/service/v1/environments.rb', line 677

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # State of the environment.
  module State
    # The state of the environment is unknown.
    STATE_UNSPECIFIED = 0

    # The environment is in the process of being created.
    CREATING = 1

    # The environment is currently running and healthy. It is ready for use.
    RUNNING = 2

    # The environment is being updated. It remains usable but cannot receive
    # additional update requests or be deleted at this time.
    UPDATING = 3

    # The environment is undergoing deletion. It cannot be used.
    DELETING = 4

    # The environment has encountered an error and cannot be used.
    ERROR = 5
  end
end

#create_time ⇒ ::Google::Protobuf::Timestamp

Returns Output only. The time at which this environment was created.

Returns:



677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
 
# File 'proto_docs/google/cloud/orchestration/airflow/service/v1/environments.rb', line 677

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # State of the environment.
  module State
    # The state of the environment is unknown.
    STATE_UNSPECIFIED = 0

    # The environment is in the process of being created.
    CREATING = 1

    # The environment is currently running and healthy. It is ready for use.
    RUNNING = 2

    # The environment is being updated. It remains usable but cannot receive
    # additional update requests or be deleted at this time.
    UPDATING = 3

    # The environment is undergoing deletion. It cannot be used.
    DELETING = 4

    # The environment has encountered an error and cannot be used.
    ERROR = 5
  end
end

#labels ⇒ ::Google::Protobuf::Map{::String => ::String}

Returns Optional. User-defined labels for this environment. The labels map can contain no more than 64 entries. Entries of the labels map are UTF8 strings that comply with the following restrictions:

  • Keys must conform to regexp: [\p{Ll}\p{Lo}][\p{Ll}\p{Lo}\p{N}_-]{0,62}
  • Values must conform to regexp: [\p{Ll}\p{Lo}\p{N}_-]{0,63}
  • Both keys and values are additionally constrained to be <= 128 bytes in size.

Returns:

  • (::Google::Protobuf::Map{::String => ::String}) —

    Optional. User-defined labels for this environment. The labels map can contain no more than 64 entries. Entries of the labels map are UTF8 strings that comply with the following restrictions:

    • Keys must conform to regexp: [\p{Ll}\p{Lo}][\p{Ll}\p{Lo}\p{N}_-]{0,62}
    • Values must conform to regexp: [\p{Ll}\p{Lo}\p{N}_-]{0,63}
    • Both keys and values are additionally constrained to be <= 128 bytes in size.


677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
 
# File 'proto_docs/google/cloud/orchestration/airflow/service/v1/environments.rb', line 677

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # State of the environment.
  module State
    # The state of the environment is unknown.
    STATE_UNSPECIFIED = 0

    # The environment is in the process of being created.
    CREATING = 1

    # The environment is currently running and healthy. It is ready for use.
    RUNNING = 2

    # The environment is being updated. It remains usable but cannot receive
    # additional update requests or be deleted at this time.
    UPDATING = 3

    # The environment is undergoing deletion. It cannot be used.
    DELETING = 4

    # The environment has encountered an error and cannot be used.
    ERROR = 5
  end
end

#name ⇒ ::String

Returns The resource name of the environment, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}"

EnvironmentId must start with a lowercase letter followed by up to 63 lowercase letters, numbers, or hyphens, and cannot end with a hyphen.

Returns:

  • (::String) —

    The resource name of the environment, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}"

    EnvironmentId must start with a lowercase letter followed by up to 63 lowercase letters, numbers, or hyphens, and cannot end with a hyphen.



677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
 
# File 'proto_docs/google/cloud/orchestration/airflow/service/v1/environments.rb', line 677

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # State of the environment.
  module State
    # The state of the environment is unknown.
    STATE_UNSPECIFIED = 0

    # The environment is in the process of being created.
    CREATING = 1

    # The environment is currently running and healthy. It is ready for use.
    RUNNING = 2

    # The environment is being updated. It remains usable but cannot receive
    # additional update requests or be deleted at this time.
    UPDATING = 3

    # The environment is undergoing deletion. It cannot be used.
    DELETING = 4

    # The environment has encountered an error and cannot be used.
    ERROR = 5
  end
end

#state ⇒ ::Google::Cloud::Orchestration::Airflow::Service::V1::Environment::State

Returns The current state of the environment.

Returns:



677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
 
# File 'proto_docs/google/cloud/orchestration/airflow/service/v1/environments.rb', line 677

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # State of the environment.
  module State
    # The state of the environment is unknown.
    STATE_UNSPECIFIED = 0

    # The environment is in the process of being created.
    CREATING = 1

    # The environment is currently running and healthy. It is ready for use.
    RUNNING = 2

    # The environment is being updated. It remains usable but cannot receive
    # additional update requests or be deleted at this time.
    UPDATING = 3

    # The environment is undergoing deletion. It cannot be used.
    DELETING = 4

    # The environment has encountered an error and cannot be used.
    ERROR = 5
  end
end

#update_time ⇒ ::Google::Protobuf::Timestamp

Returns Output only. The time at which this environment was last modified.

Returns:



677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
 
# File 'proto_docs/google/cloud/orchestration/airflow/service/v1/environments.rb', line 677

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # State of the environment.
  module State
    # The state of the environment is unknown.
    STATE_UNSPECIFIED = 0

    # The environment is in the process of being created.
    CREATING = 1

    # The environment is currently running and healthy. It is ready for use.
    RUNNING = 2

    # The environment is being updated. It remains usable but cannot receive
    # additional update requests or be deleted at this time.
    UPDATING = 3

    # The environment is undergoing deletion. It cannot be used.
    DELETING = 4

    # The environment has encountered an error and cannot be used.
    ERROR = 5
  end
end

#uuid ⇒ ::String

Returns Output only. The UUID (Universally Unique IDentifier) associated with this environment. This value is generated when the environment is created.

Returns:

  • (::String) —

    Output only. The UUID (Universally Unique IDentifier) associated with this environment. This value is generated when the environment is created.



677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
 
# File 'proto_docs/google/cloud/orchestration/airflow/service/v1/environments.rb', line 677

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # State of the environment.
  module State
    # The state of the environment is unknown.
    STATE_UNSPECIFIED = 0

    # The environment is in the process of being created.
    CREATING = 1

    # The environment is currently running and healthy. It is ready for use.
    RUNNING = 2

    # The environment is being updated. It remains usable but cannot receive
    # additional update requests or be deleted at this time.
    UPDATING = 3

    # The environment is undergoing deletion. It cannot be used.
    DELETING = 4

    # The environment has encountered an error and cannot be used.
    ERROR = 5
  end
end