Cloud Run V2 API - Class Google::Cloud::Run::V2::Container (v0.6.0)

Reference documentation and code samples for the Cloud Run V2 API class Google::Cloud::Run::V2::Container.

A single application container. This specifies both the container to run, the command to run in the container and the arguments to supply to it. Note that additional arguments may be supplied by the system to the container at runtime.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#args

def args() -> ::Array<::String>
Returns
  • (::Array<::String>) — Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell

#args=

def args=(value) -> ::Array<::String>
Parameter
  • value (::Array<::String>) — Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
Returns
  • (::Array<::String>) — Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell

#command

def command() -> ::Array<::String>
Returns
  • (::Array<::String>) — Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell

#command=

def command=(value) -> ::Array<::String>
Parameter
  • value (::Array<::String>) — Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
Returns
  • (::Array<::String>) — Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell

#env

def env() -> ::Array<::Google::Cloud::Run::V2::EnvVar>
Returns

#env=

def env=(value) -> ::Array<::Google::Cloud::Run::V2::EnvVar>
Parameter
Returns

#image

def image() -> ::String
Returns
  • (::String) — Required. Name of the container image in Dockerhub, Google Artifact Registry, or Google Container Registry. If the host is not provided, Dockerhub is assumed. More info: https://kubernetes.io/docs/concepts/containers/images

#image=

def image=(value) -> ::String
Parameter
  • value (::String) — Required. Name of the container image in Dockerhub, Google Artifact Registry, or Google Container Registry. If the host is not provided, Dockerhub is assumed. More info: https://kubernetes.io/docs/concepts/containers/images
Returns
  • (::String) — Required. Name of the container image in Dockerhub, Google Artifact Registry, or Google Container Registry. If the host is not provided, Dockerhub is assumed. More info: https://kubernetes.io/docs/concepts/containers/images

#liveness_probe

def liveness_probe() -> ::Google::Cloud::Run::V2::Probe
Returns
  • (::Google::Cloud::Run::V2::Probe) — Periodic probe of container liveness. Container will be restarted if the probe fails. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

#liveness_probe=

def liveness_probe=(value) -> ::Google::Cloud::Run::V2::Probe
Parameter
  • value (::Google::Cloud::Run::V2::Probe) — Periodic probe of container liveness. Container will be restarted if the probe fails. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
Returns
  • (::Google::Cloud::Run::V2::Probe) — Periodic probe of container liveness. Container will be restarted if the probe fails. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

#name

def name() -> ::String
Returns
  • (::String) — Name of the container specified as a DNS_LABEL (RFC 1123).

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — Name of the container specified as a DNS_LABEL (RFC 1123).
Returns
  • (::String) — Name of the container specified as a DNS_LABEL (RFC 1123).

#ports

def ports() -> ::Array<::Google::Cloud::Run::V2::ContainerPort>
Returns
  • (::Array<::Google::Cloud::Run::V2::ContainerPort>) — List of ports to expose from the container. Only a single port can be specified. The specified ports must be listening on all interfaces (0.0.0.0) within the container to be accessible.

    If omitted, a port number will be chosen and passed to the container through the PORT environment variable for the container to listen on.

#ports=

def ports=(value) -> ::Array<::Google::Cloud::Run::V2::ContainerPort>
Parameter
  • value (::Array<::Google::Cloud::Run::V2::ContainerPort>) — List of ports to expose from the container. Only a single port can be specified. The specified ports must be listening on all interfaces (0.0.0.0) within the container to be accessible.

    If omitted, a port number will be chosen and passed to the container through the PORT environment variable for the container to listen on.

Returns
  • (::Array<::Google::Cloud::Run::V2::ContainerPort>) — List of ports to expose from the container. Only a single port can be specified. The specified ports must be listening on all interfaces (0.0.0.0) within the container to be accessible.

    If omitted, a port number will be chosen and passed to the container through the PORT environment variable for the container to listen on.

#resources

def resources() -> ::Google::Cloud::Run::V2::ResourceRequirements
Returns

#resources=

def resources=(value) -> ::Google::Cloud::Run::V2::ResourceRequirements
Parameter
Returns

#startup_probe

def startup_probe() -> ::Google::Cloud::Run::V2::Probe
Returns
  • (::Google::Cloud::Run::V2::Probe) — Startup probe of application within the container. All other probes are disabled if a startup probe is provided, until it succeeds. Container will not be added to service endpoints if the probe fails. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

#startup_probe=

def startup_probe=(value) -> ::Google::Cloud::Run::V2::Probe
Parameter
  • value (::Google::Cloud::Run::V2::Probe) — Startup probe of application within the container. All other probes are disabled if a startup probe is provided, until it succeeds. Container will not be added to service endpoints if the probe fails. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
Returns
  • (::Google::Cloud::Run::V2::Probe) — Startup probe of application within the container. All other probes are disabled if a startup probe is provided, until it succeeds. Container will not be added to service endpoints if the probe fails. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

#volume_mounts

def volume_mounts() -> ::Array<::Google::Cloud::Run::V2::VolumeMount>
Returns

#volume_mounts=

def volume_mounts=(value) -> ::Array<::Google::Cloud::Run::V2::VolumeMount>
Parameter
Returns

#working_dir

def working_dir() -> ::String
Returns
  • (::String) — Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image.

#working_dir=

def working_dir=(value) -> ::String
Parameter
  • value (::String) — Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image.
Returns
  • (::String) — Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image.