Google Cloud Batch V1 Client - Class Container (0.11.3)

Version 0.11.3

• 1.1.3 (latest)
• 1.1.2
• 1.0.3
• 0.17.0
• 0.16.10
• 0.15.0
• 0.14.0
• 0.13.1
• 0.12.1
• 0.11.3
• 0.10.0
• 0.9.0
• 0.8.0
• 0.7.0
• 0.6.0
• 0.5.2
• 0.4.0
• 0.3.0
• 0.2.2

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 \ Runnable

Methods

__construct

Constructor.

Parameters
Name	Description
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
↳ 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.

Returns
Type	Description
string

setImageUri

The URI to pull the container image from.

Parameter
Name	Description
var	string

Returns
Type	Description
$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.

Returns
Type	Description
Google\Protobuf\Internal\RepeatedField

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.

Parameter
Name	Description
var	string[]

Returns
Type	Description
$this

getEntrypoint

Overrides the ENTRYPOINT specified in the container.

Returns
Type	Description
string

setEntrypoint

Overrides the ENTRYPOINT specified in the container.

Parameter
Name	Description
var	string

Returns
Type	Description
$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

Returns
Type	Description
Google\Protobuf\Internal\RepeatedField

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

Parameter
Name	Description
var	string[]

Returns
Type	Description
$this

getOptions

Arbitrary additional options to include in the "docker run" command when running this container, e.g. "--network host".

Returns
Type	Description
string

setOptions

Arbitrary additional options to include in the "docker run" command when running this container, e.g. "--network host".

Parameter
Name	Description
var	string

Returns
Type	Description
$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.

Returns
Type	Description
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.

Parameter
Name	Description
var	bool

Returns
Type	Description
$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.

Returns
Type	Description
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.

Parameter
Name	Description
var	string

Returns
Type	Description
$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;

Returns
Type	Description
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;

Parameter
Name	Description
var	string

Returns
Type	Description
$this