Reference documentation and code samples for the Batch V1 API class Google::Cloud::Batch::V1::Runnable::Script.
Script runnable.
Inherits
Object
Extended By
Google::Protobuf::MessageExts::ClassMethods
Includes
Google::Protobuf::MessageExts
Methods
#path
defpath()->::String
Returns
(::String) — The path to a script file that is accessible from the host VM(s).
Unless the script file supports the default #!/bin/sh shell
interpreter, you must specify an interpreter by including a
[shebang line](https://en.wikipedia.org/wiki/Shebang_(Unix) as the
first line of the file. For example, to execute the script using bash,
include #!/bin/bash as the first line of the file. Alternatively,
to execute the script using Python3, include #!/usr/bin/env python3
as the first line of the file.
Note: The following fields are mutually exclusive: path, text. If a field in that set is populated, all other fields in the set will automatically be cleared.
#path=
defpath=(value)->::String
Parameter
value (::String) — The path to a script file that is accessible from the host VM(s).
Unless the script file supports the default #!/bin/sh shell
interpreter, you must specify an interpreter by including a
[shebang line](https://en.wikipedia.org/wiki/Shebang_(Unix) as the
first line of the file. For example, to execute the script using bash,
include #!/bin/bash as the first line of the file. Alternatively,
to execute the script using Python3, include #!/usr/bin/env python3
as the first line of the file.
Note: The following fields are mutually exclusive: path, text. If a field in that set is populated, all other fields in the set will automatically be cleared.
Returns
(::String) — The path to a script file that is accessible from the host VM(s).
Unless the script file supports the default #!/bin/sh shell
interpreter, you must specify an interpreter by including a
[shebang line](https://en.wikipedia.org/wiki/Shebang_(Unix) as the
first line of the file. For example, to execute the script using bash,
include #!/bin/bash as the first line of the file. Alternatively,
to execute the script using Python3, include #!/usr/bin/env python3
as the first line of the file.
Note: The following fields are mutually exclusive: path, text. If a field in that set is populated, all other fields in the set will automatically be cleared.
#text
deftext()->::String
Returns
(::String) — The text for a script.
Unless the script text supports the default #!/bin/sh shell
interpreter, you must specify an interpreter by including a
[shebang line](https://en.wikipedia.org/wiki/Shebang_(Unix) at the
beginning of the text. For example, to execute the script using bash,
include #!/bin/bash\n at the beginning of the text. Alternatively,
to execute the script using Python3, include #!/usr/bin/env python3\n
at the beginning of the text.
Note: The following fields are mutually exclusive: text, path. If a field in that set is populated, all other fields in the set will automatically be cleared.
#text=
deftext=(value)->::String
Parameter
value (::String) — The text for a script.
Unless the script text supports the default #!/bin/sh shell
interpreter, you must specify an interpreter by including a
[shebang line](https://en.wikipedia.org/wiki/Shebang_(Unix) at the
beginning of the text. For example, to execute the script using bash,
include #!/bin/bash\n at the beginning of the text. Alternatively,
to execute the script using Python3, include #!/usr/bin/env python3\n
at the beginning of the text.
Note: The following fields are mutually exclusive: text, path. If a field in that set is populated, all other fields in the set will automatically be cleared.
Returns
(::String) — The text for a script.
Unless the script text supports the default #!/bin/sh shell
interpreter, you must specify an interpreter by including a
[shebang line](https://en.wikipedia.org/wiki/Shebang_(Unix) at the
beginning of the text. For example, to execute the script using bash,
include #!/bin/bash\n at the beginning of the text. Alternatively,
to execute the script using Python3, include #!/usr/bin/env python3\n
at the beginning of the text.
Note: The following fields are mutually exclusive: text, path. If a field in that set is populated, all other fields in the set will automatically be cleared.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-09 UTC."],[],[],null,["# Batch V1 API - Class Google::Cloud::Batch::V1::Runnable::Script (v1.2.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.2.0 (latest)](/ruby/docs/reference/google-cloud-batch-v1/latest/Google-Cloud-Batch-V1-Runnable-Script)\n- [1.1.1](/ruby/docs/reference/google-cloud-batch-v1/1.1.1/Google-Cloud-Batch-V1-Runnable-Script)\n- [1.0.0](/ruby/docs/reference/google-cloud-batch-v1/1.0.0/Google-Cloud-Batch-V1-Runnable-Script)\n- [0.21.0](/ruby/docs/reference/google-cloud-batch-v1/0.21.0/Google-Cloud-Batch-V1-Runnable-Script)\n- [0.20.1](/ruby/docs/reference/google-cloud-batch-v1/0.20.1/Google-Cloud-Batch-V1-Runnable-Script)\n- [0.19.2](/ruby/docs/reference/google-cloud-batch-v1/0.19.2/Google-Cloud-Batch-V1-Runnable-Script)\n- [0.18.3](/ruby/docs/reference/google-cloud-batch-v1/0.18.3/Google-Cloud-Batch-V1-Runnable-Script)\n- [0.17.4](/ruby/docs/reference/google-cloud-batch-v1/0.17.4/Google-Cloud-Batch-V1-Runnable-Script)\n- [0.16.2](/ruby/docs/reference/google-cloud-batch-v1/0.16.2/Google-Cloud-Batch-V1-Runnable-Script)\n- [0.15.1](/ruby/docs/reference/google-cloud-batch-v1/0.15.1/Google-Cloud-Batch-V1-Runnable-Script)\n- [0.14.0](/ruby/docs/reference/google-cloud-batch-v1/0.14.0/Google-Cloud-Batch-V1-Runnable-Script)\n- [0.13.1](/ruby/docs/reference/google-cloud-batch-v1/0.13.1/Google-Cloud-Batch-V1-Runnable-Script)\n- [0.12.0](/ruby/docs/reference/google-cloud-batch-v1/0.12.0/Google-Cloud-Batch-V1-Runnable-Script)\n- [0.11.1](/ruby/docs/reference/google-cloud-batch-v1/0.11.1/Google-Cloud-Batch-V1-Runnable-Script)\n- [0.10.5](/ruby/docs/reference/google-cloud-batch-v1/0.10.5/Google-Cloud-Batch-V1-Runnable-Script)\n- [0.9.0](/ruby/docs/reference/google-cloud-batch-v1/0.9.0/Google-Cloud-Batch-V1-Runnable-Script)\n- [0.8.0](/ruby/docs/reference/google-cloud-batch-v1/0.8.0/Google-Cloud-Batch-V1-Runnable-Script)\n- [0.7.0](/ruby/docs/reference/google-cloud-batch-v1/0.7.0/Google-Cloud-Batch-V1-Runnable-Script)\n- [0.6.0](/ruby/docs/reference/google-cloud-batch-v1/0.6.0/Google-Cloud-Batch-V1-Runnable-Script)\n- [0.5.0](/ruby/docs/reference/google-cloud-batch-v1/0.5.0/Google-Cloud-Batch-V1-Runnable-Script)\n- [0.4.3](/ruby/docs/reference/google-cloud-batch-v1/0.4.3/Google-Cloud-Batch-V1-Runnable-Script)\n- [0.3.0](/ruby/docs/reference/google-cloud-batch-v1/0.3.0/Google-Cloud-Batch-V1-Runnable-Script)\n- [0.2.0](/ruby/docs/reference/google-cloud-batch-v1/0.2.0/Google-Cloud-Batch-V1-Runnable-Script)\n- [0.1.0](/ruby/docs/reference/google-cloud-batch-v1/0.1.0/Google-Cloud-Batch-V1-Runnable-Script) \nReference documentation and code samples for the Batch V1 API class Google::Cloud::Batch::V1::Runnable::Script.\n\nScript runnable. \n\nInherits\n--------\n\n- Object \n\nExtended By\n-----------\n\n- Google::Protobuf::MessageExts::ClassMethods \n\nIncludes\n--------\n\n- Google::Protobuf::MessageExts\n\nMethods\n-------\n\n### #path\n\n def path() -\u003e ::String\n\n**Returns**\n\n- (::String) --- The path to a script file that is accessible from the host VM(s).\n\n Unless the script file supports the default `#!/bin/sh` shell\n interpreter, you must specify an interpreter by including a\n \\[shebang line\\](https://en.wikipedia.org/wiki/Shebang_(Unix) as the\n first line of the file. For example, to execute the script using bash,\n include `#!/bin/bash` as the first line of the file. Alternatively,\n to execute the script using Python3, include `#!/usr/bin/env python3`\n as the first line of the file.\n\n Note: The following fields are mutually exclusive: `path`, `text`. If a field in that set is populated, all other fields in the set will automatically be cleared.\n\n### #path=\n\n def path=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- The path to a script file that is accessible from the host VM(s).\n\n\n Unless the script file supports the default `#!/bin/sh` shell\n interpreter, you must specify an interpreter by including a\n \\[shebang line\\](https://en.wikipedia.org/wiki/Shebang_(Unix) as the\n first line of the file. For example, to execute the script using bash,\n include `#!/bin/bash` as the first line of the file. Alternatively,\n to execute the script using Python3, include `#!/usr/bin/env python3`\n as the first line of the file.\n\nNote: The following fields are mutually exclusive: `path`, `text`. If a field in that set is populated, all other fields in the set will automatically be cleared. \n**Returns**\n\n- (::String) --- The path to a script file that is accessible from the host VM(s).\n\n Unless the script file supports the default `#!/bin/sh` shell\n interpreter, you must specify an interpreter by including a\n \\[shebang line\\](https://en.wikipedia.org/wiki/Shebang_(Unix) as the\n first line of the file. For example, to execute the script using bash,\n include `#!/bin/bash` as the first line of the file. Alternatively,\n to execute the script using Python3, include `#!/usr/bin/env python3`\n as the first line of the file.\n\n Note: The following fields are mutually exclusive: `path`, `text`. If a field in that set is populated, all other fields in the set will automatically be cleared.\n\n### #text\n\n def text() -\u003e ::String\n\n**Returns**\n\n- (::String) --- The text for a script.\n\n Unless the script text supports the default `#!/bin/sh` shell\n interpreter, you must specify an interpreter by including a\n \\[shebang line\\](https://en.wikipedia.org/wiki/Shebang_(Unix) at the\n beginning of the text. For example, to execute the script using bash,\n include `#!/bin/bash\\n` at the beginning of the text. Alternatively,\n to execute the script using Python3, include `#!/usr/bin/env python3\\n`\n at the beginning of the text.\n\n Note: The following fields are mutually exclusive: `text`, `path`. If a field in that set is populated, all other fields in the set will automatically be cleared.\n\n### #text=\n\n def text=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- The text for a script.\n\n\n Unless the script text supports the default `#!/bin/sh` shell\n interpreter, you must specify an interpreter by including a\n \\[shebang line\\](https://en.wikipedia.org/wiki/Shebang_(Unix) at the\n beginning of the text. For example, to execute the script using bash,\n include `#!/bin/bash\\n` at the beginning of the text. Alternatively,\n to execute the script using Python3, include `#!/usr/bin/env python3\\n`\n at the beginning of the text.\n\nNote: The following fields are mutually exclusive: `text`, `path`. If a field in that set is populated, all other fields in the set will automatically be cleared. \n**Returns**\n\n- (::String) --- The text for a script.\n\n Unless the script text supports the default `#!/bin/sh` shell\n interpreter, you must specify an interpreter by including a\n \\[shebang line\\](https://en.wikipedia.org/wiki/Shebang_(Unix) at the\n beginning of the text. For example, to execute the script using bash,\n include `#!/bin/bash\\n` at the beginning of the text. Alternatively,\n to execute the script using Python3, include `#!/usr/bin/env python3\\n`\n at the beginning of the text.\n\n Note: The following fields are mutually exclusive: `text`, `path`. If a field in that set is populated, all other fields in the set will automatically be cleared."]]