Class: Google::Apis::BatchV1::Container

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/batch_v1/classes.rb,
lib/google/apis/batch_v1/representations.rb,
lib/google/apis/batch_v1/representations.rb

Overview

Container runnable.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Container

Returns a new instance of Container.



859
860
861
 
# File 'lib/google/apis/batch_v1/classes.rb', line 859

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#block_external_network ⇒ Boolean Also known as: block_external_network?

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. Corresponds to the JSON property blockExternalNetwork

Returns:

  • (Boolean) 


795
796
797
 
# File 'lib/google/apis/batch_v1/classes.rb', line 795

def block_external_network
  @block_external_network
end

#commands ⇒ Array<String>

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. Corresponds to the JSON property commands

Returns:

  • (Array<String>) 


803
804
805
 
# File 'lib/google/apis/batch_v1/classes.rb', line 803

def commands
  @commands
end

#enable_image_streaming ⇒ Boolean Also known as: enable_image_streaming?

Optional. If set to true, container will run with Image streaming. The container runtime will be changed to containerd instead of docker. Currently, only imageUri, commands, entrypoint and volumes are supported and any other fields will be ignored. Please refer here for the feature requirements and limitations. Corresponds to the JSON property enableImageStreaming

Returns:

  • (Boolean) 


813
814
815
 
# File 'lib/google/apis/batch_v1/classes.rb', line 813

def enable_image_streaming
  @enable_image_streaming
end

#entrypoint ⇒ String

Overrides the ENTRYPOINT specified in the container. Corresponds to the JSON property entrypoint

Returns:

  • (String) 


819
820
821
 
# File 'lib/google/apis/batch_v1/classes.rb', line 819

def entrypoint
  @entrypoint
end

#image_uri ⇒ String

The URI to pull the container image from. Corresponds to the JSON property imageUri

Returns:

  • (String) 


824
825
826
 
# File 'lib/google/apis/batch_v1/classes.rb', line 824

def image_uri
  @image_uri
end

#options ⇒ String

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

Returns:

  • (String) 


830
831
832
 
# File 'lib/google/apis/batch_v1/classes.rb', line 830

def options
  @options
end

#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; Corresponds to the JSON property password

Returns:

  • (String) 


837
838
839
 
# File 'lib/google/apis/batch_v1/classes.rb', line 837

def password
  @password
end

#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. Corresponds to the JSON property username

Returns:

  • (String) 


844
845
846
 
# File 'lib/google/apis/batch_v1/classes.rb', line 844

def username
  @username
end

#volumes ⇒ Array<String>

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. Corresponds to the JSON property volumes

Returns:

  • (Array<String>) 


857
858
859
 
# File 'lib/google/apis/batch_v1/classes.rb', line 857

def volumes
  @volumes
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



864
865
866
867
868
869
870
871
872
873
874
 
# File 'lib/google/apis/batch_v1/classes.rb', line 864

def update!(**args)
  @block_external_network = args[:block_external_network] if args.key?(:block_external_network)
  @commands = args[:commands] if args.key?(:commands)
  @enable_image_streaming = args[:enable_image_streaming] if args.key?(:enable_image_streaming)
  @entrypoint = args[:entrypoint] if args.key?(:entrypoint)
  @image_uri = args[:image_uri] if args.key?(:image_uri)
  @options = args[:options] if args.key?(:options)
  @password = args[:password] if args.key?(:password)
  @username = args[:username] if args.key?(:username)
  @volumes = args[:volumes] if args.key?(:volumes)
end