public final class Container extends GeneratedMessageV3 implements ContainerOrBuilder
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.
Protobuf type google.cloud.run.v2.Container
Static Fields
ARGS_FIELD_NUMBER
public static final int ARGS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
COMMAND_FIELD_NUMBER
public static final int COMMAND_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
ENV_FIELD_NUMBER
public static final int ENV_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
IMAGE_FIELD_NUMBER
public static final int IMAGE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
LIVENESS_PROBE_FIELD_NUMBER
public static final int LIVENESS_PROBE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
PORTS_FIELD_NUMBER
public static final int PORTS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
RESOURCES_FIELD_NUMBER
public static final int RESOURCES_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
STARTUP_PROBE_FIELD_NUMBER
public static final int STARTUP_PROBE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
VOLUME_MOUNTS_FIELD_NUMBER
public static final int VOLUME_MOUNTS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
WORKING_DIR_FIELD_NUMBER
public static final int WORKING_DIR_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
getDefaultInstance()
public static Container getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static Container.Builder newBuilder()
newBuilder(Container prototype)
public static Container.Builder newBuilder(Container prototype)
public static Container parseDelimitedFrom(InputStream input)
public static Container parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static Container parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Container parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static Container parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Container parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Container parseFrom(CodedInputStream input)
public static Container parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static Container parseFrom(InputStream input)
public static Container parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static Container parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Container parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<Container> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
getArgs(int index)
public String getArgs(int index)
Arguments to the entrypoint.
The docker image's CMD is used if this is not provided.
repeated string args = 4;
| Parameter |
|---|
| Name | Description |
index | int
The index of the element to return.
|
| Returns |
|---|
| Type | Description |
String | The args at the given index.
|
getArgsBytes(int index)
public ByteString getArgsBytes(int index)
Arguments to the entrypoint.
The docker image's CMD is used if this is not provided.
repeated string args = 4;
| Parameter |
|---|
| Name | Description |
index | int
The index of the value to return.
|
| Returns |
|---|
| Type | Description |
ByteString | The bytes of the args at the given index.
|
getArgsCount()
public int getArgsCount()
Arguments to the entrypoint.
The docker image's CMD is used if this is not provided.
repeated string args = 4;
| Returns |
|---|
| Type | Description |
int | The count of args.
|
getArgsList()
public ProtocolStringList getArgsList()
Arguments to the entrypoint.
The docker image's CMD is used if this is not provided.
repeated string args = 4;
getCommand(int index)
public String getCommand(int index)
Entrypoint array. Not executed within a shell.
The docker image's ENTRYPOINT is used if this is not provided.
repeated string command = 3;
| Parameter |
|---|
| Name | Description |
index | int
The index of the element to return.
|
| Returns |
|---|
| Type | Description |
String | The command at the given index.
|
getCommandBytes(int index)
public ByteString getCommandBytes(int index)
Entrypoint array. Not executed within a shell.
The docker image's ENTRYPOINT is used if this is not provided.
repeated string command = 3;
| Parameter |
|---|
| Name | Description |
index | int
The index of the value to return.
|
| Returns |
|---|
| Type | Description |
ByteString | The bytes of the command at the given index.
|
getCommandCount()
public int getCommandCount()
Entrypoint array. Not executed within a shell.
The docker image's ENTRYPOINT is used if this is not provided.
repeated string command = 3;
| Returns |
|---|
| Type | Description |
int | The count of command.
|
getCommandList()
public ProtocolStringList getCommandList()
Entrypoint array. Not executed within a shell.
The docker image's ENTRYPOINT is used if this is not provided.
repeated string command = 3;
getDefaultInstanceForType()
public Container getDefaultInstanceForType()
getEnv(int index)
public EnvVar getEnv(int index)
List of environment variables to set in the container.
repeated .google.cloud.run.v2.EnvVar env = 5;
| Parameter |
|---|
| Name | Description |
index | int
|
getEnvCount()
List of environment variables to set in the container.
repeated .google.cloud.run.v2.EnvVar env = 5;
| Returns |
|---|
| Type | Description |
int | |
getEnvList()
public List<EnvVar> getEnvList()
List of environment variables to set in the container.
repeated .google.cloud.run.v2.EnvVar env = 5;
getEnvOrBuilder(int index)
public EnvVarOrBuilder getEnvOrBuilder(int index)
List of environment variables to set in the container.
repeated .google.cloud.run.v2.EnvVar env = 5;
| Parameter |
|---|
| Name | Description |
index | int
|
getEnvOrBuilderList()
public List<? extends EnvVarOrBuilder> getEnvOrBuilderList()
List of environment variables to set in the container.
repeated .google.cloud.run.v2.EnvVar env = 5;
| Returns |
|---|
| Type | Description |
List<? extends com.google.cloud.run.v2.EnvVarOrBuilder> | |
getImage()
Required. Name of the container image in Dockerhub, Google Artifact
Registry, or Google Container Registry. If the host is not provided,
Dockerhub is assumed.
string image = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns |
|---|
| Type | Description |
String | The image.
|
getImageBytes()
public ByteString getImageBytes()
Required. Name of the container image in Dockerhub, Google Artifact
Registry, or Google Container Registry. If the host is not provided,
Dockerhub is assumed.
string image = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns |
|---|
| Type | Description |
ByteString | The bytes for image.
|
getLivenessProbe()
public Probe getLivenessProbe()
Periodic probe of container liveness.
Container will be restarted if the probe fails.
.google.cloud.run.v2.Probe liveness_probe = 10;
| Returns |
|---|
| Type | Description |
Probe | The livenessProbe.
|
getLivenessProbeOrBuilder()
public ProbeOrBuilder getLivenessProbeOrBuilder()
Periodic probe of container liveness.
Container will be restarted if the probe fails.
.google.cloud.run.v2.Probe liveness_probe = 10;
getName()
Name of the container specified as a DNS_LABEL (RFC 1123).
string name = 1;
| Returns |
|---|
| Type | Description |
String | The name.
|
getNameBytes()
public ByteString getNameBytes()
Name of the container specified as a DNS_LABEL (RFC 1123).
string name = 1;
| Returns |
|---|
| Type | Description |
ByteString | The bytes for name.
|
getParserForType()
public Parser<Container> getParserForType()
Overrides
getPorts(int index)
public ContainerPort getPorts(int index)
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.
repeated .google.cloud.run.v2.ContainerPort ports = 7;
| Parameter |
|---|
| Name | Description |
index | int
|
getPortsCount()
public int getPortsCount()
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.
repeated .google.cloud.run.v2.ContainerPort ports = 7;
| Returns |
|---|
| Type | Description |
int | |
getPortsList()
public List<ContainerPort> getPortsList()
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.
repeated .google.cloud.run.v2.ContainerPort ports = 7;
getPortsOrBuilder(int index)
public ContainerPortOrBuilder getPortsOrBuilder(int index)
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.
repeated .google.cloud.run.v2.ContainerPort ports = 7;
| Parameter |
|---|
| Name | Description |
index | int
|
getPortsOrBuilderList()
public List<? extends ContainerPortOrBuilder> getPortsOrBuilderList()
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.
repeated .google.cloud.run.v2.ContainerPort ports = 7;
| Returns |
|---|
| Type | Description |
List<? extends com.google.cloud.run.v2.ContainerPortOrBuilder> | |
getResources()
public ResourceRequirements getResources()
Compute Resource requirements by this container.
.google.cloud.run.v2.ResourceRequirements resources = 6;
getResourcesOrBuilder()
public ResourceRequirementsOrBuilder getResourcesOrBuilder()
Compute Resource requirements by this container.
.google.cloud.run.v2.ResourceRequirements resources = 6;
getSerializedSize()
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
getStartupProbe()
public Probe getStartupProbe()
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.
.google.cloud.run.v2.Probe startup_probe = 11;
| Returns |
|---|
| Type | Description |
Probe | The startupProbe.
|
getStartupProbeOrBuilder()
public ProbeOrBuilder getStartupProbeOrBuilder()
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.
.google.cloud.run.v2.Probe startup_probe = 11;
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Overrides
getVolumeMounts(int index)
public VolumeMount getVolumeMounts(int index)
Volume to mount into the container's filesystem.
repeated .google.cloud.run.v2.VolumeMount volume_mounts = 8;
| Parameter |
|---|
| Name | Description |
index | int
|
getVolumeMountsCount()
public int getVolumeMountsCount()
Volume to mount into the container's filesystem.
repeated .google.cloud.run.v2.VolumeMount volume_mounts = 8;
| Returns |
|---|
| Type | Description |
int | |
getVolumeMountsList()
public List<VolumeMount> getVolumeMountsList()
Volume to mount into the container's filesystem.
repeated .google.cloud.run.v2.VolumeMount volume_mounts = 8;
getVolumeMountsOrBuilder(int index)
public VolumeMountOrBuilder getVolumeMountsOrBuilder(int index)
Volume to mount into the container's filesystem.
repeated .google.cloud.run.v2.VolumeMount volume_mounts = 8;
| Parameter |
|---|
| Name | Description |
index | int
|
getVolumeMountsOrBuilderList()
public List<? extends VolumeMountOrBuilder> getVolumeMountsOrBuilderList()
Volume to mount into the container's filesystem.
repeated .google.cloud.run.v2.VolumeMount volume_mounts = 8;
| Returns |
|---|
| Type | Description |
List<? extends com.google.cloud.run.v2.VolumeMountOrBuilder> | |
getWorkingDir()
public String getWorkingDir()
Container's working directory.
If not specified, the container runtime's default will be used, which
might be configured in the container image.
string working_dir = 9;
| Returns |
|---|
| Type | Description |
String | The workingDir.
|
getWorkingDirBytes()
public ByteString getWorkingDirBytes()
Container's working directory.
If not specified, the container runtime's default will be used, which
might be configured in the container image.
string working_dir = 9;
| Returns |
|---|
| Type | Description |
ByteString | The bytes for workingDir.
|
hasLivenessProbe()
public boolean hasLivenessProbe()
Periodic probe of container liveness.
Container will be restarted if the probe fails.
.google.cloud.run.v2.Probe liveness_probe = 10;
| Returns |
|---|
| Type | Description |
boolean | Whether the livenessProbe field is set.
|
hasResources()
public boolean hasResources()
Compute Resource requirements by this container.
.google.cloud.run.v2.ResourceRequirements resources = 6;
| Returns |
|---|
| Type | Description |
boolean | Whether the resources field is set.
|
hasStartupProbe()
public boolean hasStartupProbe()
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.
.google.cloud.run.v2.Probe startup_probe = 11;
| Returns |
|---|
| Type | Description |
boolean | Whether the startupProbe field is set.
|
hashCode()
| Returns |
|---|
| Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public Container.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Container.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public Container.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
