publicfinalclass ContainerextendsGeneratedMessageV3implementsContainerOrBuilder
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
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
Static Fields
ARGS_FIELD_NUMBER
publicstaticfinalintARGS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
COMMAND_FIELD_NUMBER
publicstaticfinalintCOMMAND_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
ENV_FIELD_NUMBER
publicstaticfinalintENV_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
IMAGE_FIELD_NUMBER
publicstaticfinalintIMAGE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
LIVENESS_PROBE_FIELD_NUMBER
publicstaticfinalintLIVENESS_PROBE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
NAME_FIELD_NUMBER
publicstaticfinalintNAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
PORTS_FIELD_NUMBER
publicstaticfinalintPORTS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
RESOURCES_FIELD_NUMBER
publicstaticfinalintRESOURCES_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
STARTUP_PROBE_FIELD_NUMBER
publicstaticfinalintSTARTUP_PROBE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
VOLUME_MOUNTS_FIELD_NUMBER
publicstaticfinalintVOLUME_MOUNTS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
WORKING_DIR_FIELD_NUMBER
publicstaticfinalintWORKING_DIR_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
Static Methods
getDefaultInstance()
publicstaticContainergetDefaultInstance()
getDescriptor()
publicstaticfinalDescriptors.DescriptorgetDescriptor()
newBuilder()
publicstaticContainer.BuildernewBuilder()
newBuilder(Container prototype)
publicstaticContainer.BuildernewBuilder(Containerprototype)
| Parameter |
| Name |
Description |
prototype |
Container
|
publicstaticContainerparseDelimitedFrom(InputStreaminput)
publicstaticContainerparseDelimitedFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
parseFrom(byte[] data)
publicstaticContainerparseFrom(byte[]data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
publicstaticContainerparseFrom(byte[]data,ExtensionRegistryLiteextensionRegistry)
parseFrom(ByteString data)
publicstaticContainerparseFrom(ByteStringdata)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
publicstaticContainerparseFrom(ByteStringdata,ExtensionRegistryLiteextensionRegistry)
publicstaticContainerparseFrom(CodedInputStreaminput)
publicstaticContainerparseFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)
publicstaticContainerparseFrom(InputStreaminput)
publicstaticContainerparseFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
parseFrom(ByteBuffer data)
publicstaticContainerparseFrom(ByteBufferdata)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
publicstaticContainerparseFrom(ByteBufferdata,ExtensionRegistryLiteextensionRegistry)
parser()
publicstaticParser<Container>parser()
Methods
equals(Object obj)
publicbooleanequals(Objectobj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getArgs(int index)
publicStringgetArgs(intindex)
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)
publicByteStringgetArgsBytes(intindex)
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()
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()
publicProtocolStringListgetArgsList()
Arguments to the entrypoint.
The docker image's CMD is used if this is not provided.
repeated string args = 4;
getCommand(int index)
publicStringgetCommand(intindex)
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)
publicByteStringgetCommandBytes(intindex)
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()
publicintgetCommandCount()
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()
publicProtocolStringListgetCommandList()
Entrypoint array. Not executed within a shell.
The docker image's ENTRYPOINT is used if this is not provided.
repeated string command = 3;
getDefaultInstanceForType()
publicContainergetDefaultInstanceForType()
getEnv(int index)
publicEnvVargetEnv(intindex)
List of environment variables to set in the container.
repeated .google.cloud.run.v2.EnvVar env = 5;
| Parameter |
| Name |
Description |
index |
int
|
| Returns |
| Type |
Description |
EnvVar |
getEnvCount()
List of environment variables to set in the container.
repeated .google.cloud.run.v2.EnvVar env = 5;
| Returns |
| Type |
Description |
int |
getEnvList()
publicList<EnvVar>getEnvList()
List of environment variables to set in the container.
repeated .google.cloud.run.v2.EnvVar env = 5;
getEnvOrBuilder(int index)
publicEnvVarOrBuildergetEnvOrBuilder(intindex)
List of environment variables to set in the container.
repeated .google.cloud.run.v2.EnvVar env = 5;
| Parameter |
| Name |
Description |
index |
int
|
getEnvOrBuilderList()
publicList<?extendsEnvVarOrBuilder>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()
publicByteStringgetImageBytes()
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()
publicProbegetLivenessProbe()
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()
publicProbeOrBuildergetLivenessProbeOrBuilder()
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()
publicByteStringgetNameBytes()
Name of the container specified as a DNS_LABEL (RFC 1123).
string name = 1;
| Returns |
| Type |
Description |
ByteString |
The bytes for name.
|
getParserForType()
publicParser<Container>getParserForType()
Overrides
getPorts(int index)
publicContainerPortgetPorts(intindex)
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()
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()
publicList<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)
publicContainerPortOrBuildergetPortsOrBuilder(intindex)
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()
publicList<?extendsContainerPortOrBuilder>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()
publicResourceRequirementsgetResources()
Compute Resource requirements by this container.
.google.cloud.run.v2.ResourceRequirements resources = 6;
getResourcesOrBuilder()
publicResourceRequirementsOrBuildergetResourcesOrBuilder()
Compute Resource requirements by this container.
.google.cloud.run.v2.ResourceRequirements resources = 6;
getSerializedSize()
publicintgetSerializedSize()
| Returns |
| Type |
Description |
int |
Overrides
getStartupProbe()
publicProbegetStartupProbe()
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()
publicProbeOrBuildergetStartupProbeOrBuilder()
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;
getVolumeMounts(int index)
publicVolumeMountgetVolumeMounts(intindex)
Volume to mount into the container's filesystem.
repeated .google.cloud.run.v2.VolumeMount volume_mounts = 8;
| Parameter |
| Name |
Description |
index |
int
|
getVolumeMountsCount()
publicintgetVolumeMountsCount()
Volume to mount into the container's filesystem.
repeated .google.cloud.run.v2.VolumeMount volume_mounts = 8;
| Returns |
| Type |
Description |
int |
getVolumeMountsList()
publicList<VolumeMount>getVolumeMountsList()
Volume to mount into the container's filesystem.
repeated .google.cloud.run.v2.VolumeMount volume_mounts = 8;
getVolumeMountsOrBuilder(int index)
publicVolumeMountOrBuildergetVolumeMountsOrBuilder(intindex)
Volume to mount into the container's filesystem.
repeated .google.cloud.run.v2.VolumeMount volume_mounts = 8;
| Parameter |
| Name |
Description |
index |
int
|
getVolumeMountsOrBuilderList()
publicList<?extendsVolumeMountOrBuilder>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()
publicStringgetWorkingDir()
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()
publicByteStringgetWorkingDirBytes()
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()
publicbooleanhasLivenessProbe()
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()
publicbooleanhasResources()
Compute Resource requirements by this container.
.google.cloud.run.v2.ResourceRequirements resources = 6;
| Returns |
| Type |
Description |
boolean |
Whether the resources field is set.
|
hasStartupProbe()
publicbooleanhasStartupProbe()
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()
protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()
Overrides
isInitialized()
publicfinalbooleanisInitialized()
Overrides
newBuilderForType()
publicContainer.BuildernewBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protectedContainer.BuildernewBuilderForType(GeneratedMessageV3.BuilderParentparent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protectedObjectnewInstance(GeneratedMessageV3.UnusedPrivateParameterunused)
| Returns |
| Type |
Description |
Object |
Overrides
toBuilder()
publicContainer.BuildertoBuilder()
writeTo(CodedOutputStream output)
publicvoidwriteTo(CodedOutputStreamoutput)
Overrides