Reference documentation and code samples for the Google Cloud Batch V1 Client class Container.
Container runnable.
Generated from protobuf message google.cloud.batch.v1.Runnable.Container
Namespace
Google \ Cloud \ Batch \ V1 \ RunnableMethods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ image_uri
string
The URI to pull the container image from.
↳ commands
array
Overrides the CMD
specified in the container. If there is an ENTRYPOINT (either in the container image or with the entrypoint field below) then commands are appended as arguments to the ENTRYPOINT.
↳ entrypoint
string
Overrides the ENTRYPOINT
specified in the container.
↳ volumes
array
Volumes to mount (bind mount) from the host machine files or directories into the container, formatted to match docker run's --volume option, e.g. /foo:/bar, or /foo:/bar:ro If the TaskSpec.Volumes
field is specified but this field is not, Batch will mount each volume from the host machine to the container with the same mount path by default. In this case, the default mount option for containers will be read-only (ro) for existing persistent disks and read-write (rw) for other volume types, regardless of the original mount options specified in TaskSpec.Volumes
. If you need different mount settings, you can explicitly configure them in this field.
↳ options
string
Arbitrary additional options to include in the "docker run" command when running this container, e.g. "--network host".
↳ block_external_network
bool
If set to true, external network access to and from container will be blocked, containers that are with block_external_network as true can still communicate with each other, network cannot be specified in the container.options
field.
↳ username
string
Optional username for logging in to a docker registry. If username matches projects/*/secrets/*/versions/*
then Batch will read the username from the Secret Manager.
↳ password
string
Optional password for logging in to a docker registry. If password matches projects/*/secrets/*/versions/*
then Batch will read the password from the Secret Manager;
getImageUri
The URI to pull the container image from.
string
setImageUri
The URI to pull the container image from.
var
string
$this
getCommands
Overrides the CMD
specified in the container. If there is an ENTRYPOINT
(either in the container image or with the entrypoint field below) then
commands are appended as arguments to the ENTRYPOINT.
setCommands
Overrides the CMD
specified in the container. If there is an ENTRYPOINT
(either in the container image or with the entrypoint field below) then
commands are appended as arguments to the ENTRYPOINT.
var
string[]
$this
getEntrypoint
Overrides the ENTRYPOINT
specified in the container.
string
setEntrypoint
Overrides the ENTRYPOINT
specified in the container.
var
string
$this
getVolumes
Volumes to mount (bind mount) from the host machine files or directories
into the container, formatted to match docker run's --volume option,
e.g. /foo:/bar, or /foo:/bar:ro
If the TaskSpec.Volumes
field is specified but this field is not, Batch
will mount each volume from the host machine to the container with the
same mount path by default. In this case, the default mount option for
containers will be read-only (ro) for existing persistent disks and
read-write (rw) for other volume types, regardless of the original mount
options specified in TaskSpec.Volumes
. If you need different mount
settings, you can explicitly configure them in this field.
setVolumes
Volumes to mount (bind mount) from the host machine files or directories
into the container, formatted to match docker run's --volume option,
e.g. /foo:/bar, or /foo:/bar:ro
If the TaskSpec.Volumes
field is specified but this field is not, Batch
will mount each volume from the host machine to the container with the
same mount path by default. In this case, the default mount option for
containers will be read-only (ro) for existing persistent disks and
read-write (rw) for other volume types, regardless of the original mount
options specified in TaskSpec.Volumes
. If you need different mount
settings, you can explicitly configure them in this field.
var
string[]
$this
getOptions
Arbitrary additional options to include in the "docker run" command when running this container, e.g. "--network host".
string
setOptions
Arbitrary additional options to include in the "docker run" command when running this container, e.g. "--network host".
var
string
$this
getBlockExternalNetwork
If set to true, external network access to and from container will be
blocked, containers that are with block_external_network as true can
still communicate with each other, network cannot be specified in the container.options
field.
bool
setBlockExternalNetwork
If set to true, external network access to and from container will be
blocked, containers that are with block_external_network as true can
still communicate with each other, network cannot be specified in the container.options
field.
var
bool
$this
getUsername
Optional username for logging in to a docker registry. If username
matches projects/*/secrets/*/versions/*
then Batch will read the
username from the Secret Manager.
string
setUsername
Optional username for logging in to a docker registry. If username
matches projects/*/secrets/*/versions/*
then Batch will read the
username from the Secret Manager.
var
string
$this
getPassword
Optional password for logging in to a docker registry. If password
matches projects/*/secrets/*/versions/*
then Batch will read the
password from the Secret Manager;
string
setPassword
Optional password for logging in to a docker registry. If password
matches projects/*/secrets/*/versions/*
then Batch will read the
password from the Secret Manager;
var
string
$this
