Class: Google::Cloud::OsConfig::V1::ExecStepConfig

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

Overview

Common configurations for an ExecStep.

Defined Under Namespace

Modules: Interpreter

Instance Attribute Summary collapse

Instance Attribute Details

#allowed_success_codes ⇒ ::Array<::Integer>

Returns Defaults to [0]. A list of possible return values that the execution can return to indicate a success.

Returns:

  • (::Array<::Integer>) —

    Defaults to [0]. A list of possible return values that the execution can return to indicate a success.



630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
 
# File 'proto_docs/google/cloud/osconfig/v1/patch_jobs.rb', line 630

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

  # The interpreter used to execute the a file.
  module Interpreter
    # Invalid for a Windows ExecStepConfig. For a Linux ExecStepConfig, the
    # interpreter will be parsed from the shebang line of the script if
    # unspecified.
    INTERPRETER_UNSPECIFIED = 0

    # Indicates that the script is run with `/bin/sh` on Linux and `cmd`
    # on Windows.
    SHELL = 1

    # Indicates that the file is run with PowerShell flags
    # `-NonInteractive`, `-NoProfile`, and `-ExecutionPolicy Bypass`.
    POWERSHELL = 2
  end
end

#gcs_object ⇒ ::Google::Cloud::OsConfig::V1::GcsObject

Returns A Cloud Storage object containing the executable.

Note: The following fields are mutually exclusive: gcs_object, local_path. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::OsConfig::V1::GcsObject) —

    A Cloud Storage object containing the executable.

    Note: The following fields are mutually exclusive: gcs_object, local_path. If a field in that set is populated, all other fields in the set will automatically be cleared.



630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
 
# File 'proto_docs/google/cloud/osconfig/v1/patch_jobs.rb', line 630

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

  # The interpreter used to execute the a file.
  module Interpreter
    # Invalid for a Windows ExecStepConfig. For a Linux ExecStepConfig, the
    # interpreter will be parsed from the shebang line of the script if
    # unspecified.
    INTERPRETER_UNSPECIFIED = 0

    # Indicates that the script is run with `/bin/sh` on Linux and `cmd`
    # on Windows.
    SHELL = 1

    # Indicates that the file is run with PowerShell flags
    # `-NonInteractive`, `-NoProfile`, and `-ExecutionPolicy Bypass`.
    POWERSHELL = 2
  end
end

#interpreter ⇒ ::Google::Cloud::OsConfig::V1::ExecStepConfig::Interpreter

Returns The script interpreter to use to run the script. If no interpreter is specified the script will be executed directly, which will likely only succeed for scripts with [shebang lines] (https://en.wikipedia.org/wiki/Shebang_(Unix)).

Returns:

  • (::Google::Cloud::OsConfig::V1::ExecStepConfig::Interpreter) —

    The script interpreter to use to run the script. If no interpreter is specified the script will be executed directly, which will likely only succeed for scripts with [shebang lines] (https://en.wikipedia.org/wiki/Shebang_(Unix)).



630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
 
# File 'proto_docs/google/cloud/osconfig/v1/patch_jobs.rb', line 630

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

  # The interpreter used to execute the a file.
  module Interpreter
    # Invalid for a Windows ExecStepConfig. For a Linux ExecStepConfig, the
    # interpreter will be parsed from the shebang line of the script if
    # unspecified.
    INTERPRETER_UNSPECIFIED = 0

    # Indicates that the script is run with `/bin/sh` on Linux and `cmd`
    # on Windows.
    SHELL = 1

    # Indicates that the file is run with PowerShell flags
    # `-NonInteractive`, `-NoProfile`, and `-ExecutionPolicy Bypass`.
    POWERSHELL = 2
  end
end

#local_path ⇒ ::String

Returns An absolute path to the executable on the VM.

Note: The following fields are mutually exclusive: local_path, gcs_object. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::String) —

    An absolute path to the executable on the VM.

    Note: The following fields are mutually exclusive: local_path, gcs_object. If a field in that set is populated, all other fields in the set will automatically be cleared.



630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
 
# File 'proto_docs/google/cloud/osconfig/v1/patch_jobs.rb', line 630

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

  # The interpreter used to execute the a file.
  module Interpreter
    # Invalid for a Windows ExecStepConfig. For a Linux ExecStepConfig, the
    # interpreter will be parsed from the shebang line of the script if
    # unspecified.
    INTERPRETER_UNSPECIFIED = 0

    # Indicates that the script is run with `/bin/sh` on Linux and `cmd`
    # on Windows.
    SHELL = 1

    # Indicates that the file is run with PowerShell flags
    # `-NonInteractive`, `-NoProfile`, and `-ExecutionPolicy Bypass`.
    POWERSHELL = 2
  end
end