Class: Google::Cloud::Batch::V1::Environment

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/batch/v1/task.rb

Overview

An Environment describes a collection of environment variables to set when executing Tasks.

Defined Under Namespace

Classes: KMSEnvMap, SecretVariablesEntry, VariablesEntry

Instance Attribute Summary collapse

Instance Attribute Details

#encrypted_variables ⇒ ::Google::Cloud::Batch::V1::Environment::KMSEnvMap

Returns An encrypted JSON dictionary where the key/value pairs correspond to environment variable names and their values.

Returns:



511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
 
# File 'proto_docs/google/cloud/batch/v1/task.rb', line 511

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

  # @!attribute [rw] key_name
  #   @return [::String]
  #     The name of the KMS key that will be used to decrypt the cipher text.
  # @!attribute [rw] cipher_text
  #   @return [::String]
  #     The value of the cipherText response from the `encrypt` method.
  class KMSEnvMap
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

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

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

Returns A map of environment variable names to Secret Manager secret names. The VM will access the named secrets to set the value of each environment variable.

Returns:

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

    A map of environment variable names to Secret Manager secret names. The VM will access the named secrets to set the value of each environment variable.



511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
 
# File 'proto_docs/google/cloud/batch/v1/task.rb', line 511

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

  # @!attribute [rw] key_name
  #   @return [::String]
  #     The name of the KMS key that will be used to decrypt the cipher text.
  # @!attribute [rw] cipher_text
  #   @return [::String]
  #     The value of the cipherText response from the `encrypt` method.
  class KMSEnvMap
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

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

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

Returns A map of environment variable names to values.

Returns:

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

    A map of environment variable names to values.



511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
 
# File 'proto_docs/google/cloud/batch/v1/task.rb', line 511

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

  # @!attribute [rw] key_name
  #   @return [::String]
  #     The name of the KMS key that will be used to decrypt the cipher text.
  # @!attribute [rw] cipher_text
  #   @return [::String]
  #     The value of the cipherText response from the `encrypt` method.
  class KMSEnvMap
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

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