com.google.cloud.run.v2

Interface ContainerOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

Container, Container.Builder

public interface ContainerOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
String	getArgs(int index) Arguments to the entrypoint.
com.google.protobuf.ByteString	getArgsBytes(int index) Arguments to the entrypoint.
int	getArgsCount() Arguments to the entrypoint.
List<String>	getArgsList() Arguments to the entrypoint.
String	getBaseImageUri() Base image for this container.
com.google.protobuf.ByteString	getBaseImageUriBytes() Base image for this container.
BuildInfo	getBuildInfo() Output only.
BuildInfoOrBuilder	getBuildInfoOrBuilder() Output only.
String	getCommand(int index) Entrypoint array.
com.google.protobuf.ByteString	getCommandBytes(int index) Entrypoint array.
int	getCommandCount() Entrypoint array.
List<String>	getCommandList() Entrypoint array.
String	getDependsOn(int index) Names of the containers that must start before this container.
com.google.protobuf.ByteString	getDependsOnBytes(int index) Names of the containers that must start before this container.
int	getDependsOnCount() Names of the containers that must start before this container.
List<String>	getDependsOnList() Names of the containers that must start before this container.
EnvVar	getEnv(int index) List of environment variables to set in the container.
int	getEnvCount() List of environment variables to set in the container.
List<EnvVar>	getEnvList() List of environment variables to set in the container.
EnvVarOrBuilder	getEnvOrBuilder(int index) List of environment variables to set in the container.
List<? extends EnvVarOrBuilder>	getEnvOrBuilderList() List of environment variables to set in the container.
String	getImage() Required.
com.google.protobuf.ByteString	getImageBytes() Required.
Probe	getLivenessProbe() Periodic probe of container liveness.
ProbeOrBuilder	getLivenessProbeOrBuilder() Periodic probe of container liveness.
String	getName() Name of the container specified as a DNS_LABEL (RFC 1123).
com.google.protobuf.ByteString	getNameBytes() Name of the container specified as a DNS_LABEL (RFC 1123).
ContainerPort	getPorts(int index) List of ports to expose from the container.
int	getPortsCount() List of ports to expose from the container.
List<ContainerPort>	getPortsList() List of ports to expose from the container.
ContainerPortOrBuilder	getPortsOrBuilder(int index) List of ports to expose from the container.
List<? extends ContainerPortOrBuilder>	getPortsOrBuilderList() List of ports to expose from the container.
ResourceRequirements	getResources() Compute Resource requirements by this container.
ResourceRequirementsOrBuilder	getResourcesOrBuilder() Compute Resource requirements by this container.
Probe	getStartupProbe() Startup probe of application within the container.
ProbeOrBuilder	getStartupProbeOrBuilder() Startup probe of application within the container.
VolumeMount	getVolumeMounts(int index) Volume to mount into the container's filesystem.
int	getVolumeMountsCount() Volume to mount into the container's filesystem.
List<VolumeMount>	getVolumeMountsList() Volume to mount into the container's filesystem.
VolumeMountOrBuilder	getVolumeMountsOrBuilder(int index) Volume to mount into the container's filesystem.
List<? extends VolumeMountOrBuilder>	getVolumeMountsOrBuilderList() Volume to mount into the container's filesystem.
String	getWorkingDir() Container's working directory.
com.google.protobuf.ByteString	getWorkingDirBytes() Container's working directory.
boolean	hasBuildInfo() Output only.
boolean	hasLivenessProbe() Periodic probe of container liveness.
boolean	hasResources() Compute Resource requirements by this container.
boolean	hasStartupProbe() Startup probe of application within the container.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getName

String getName()

 Name of the container specified as a DNS_LABEL (RFC 1123).
 

string name = 1;

Returns:

The name.

getNameBytes

com.google.protobuf.ByteString getNameBytes()

 Name of the container specified as a DNS_LABEL (RFC 1123).
 

string name = 1;

Returns:

The bytes for name.

getImage

String 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:

The image.

getImageBytes

com.google.protobuf.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:

The bytes for image.

getCommandList

List<String> getCommandList()

 Entrypoint array. Not executed within a shell.
 The docker image's ENTRYPOINT is used if this is not provided.
 

repeated string command = 3;

Returns:

A list containing the command.

getCommandCount

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:

The count of command.

getCommand

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;

Parameters:

index - The index of the element to return.

Returns:

The command at the given index.

getCommandBytes

com.google.protobuf.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;

Parameters:

index - The index of the value to return.

Returns:

The bytes of the command at the given index.

getArgsList

List<String> getArgsList()

 Arguments to the entrypoint.
 The docker image's CMD is used if this is not provided.
 

repeated string args = 4;

Returns:

A list containing the args.

getArgsCount

int getArgsCount()

 Arguments to the entrypoint.
 The docker image's CMD is used if this is not provided.
 

repeated string args = 4;

Returns:

The count of args.

getArgs

String getArgs(int index)

 Arguments to the entrypoint.
 The docker image's CMD is used if this is not provided.
 

repeated string args = 4;

Parameters:

index - The index of the element to return.

Returns:

The args at the given index.

getArgsBytes

com.google.protobuf.ByteString getArgsBytes(int index)

 Arguments to the entrypoint.
 The docker image's CMD is used if this is not provided.
 

repeated string args = 4;

Parameters:

index - The index of the value to return.

Returns:

The bytes of the args at the given index.

getEnvList

List<EnvVar> getEnvList()

 List of environment variables to set in the container.
 

repeated .google.cloud.run.v2.EnvVar env = 5;

getEnv

EnvVar getEnv(int index)

 List of environment variables to set in the container.
 

repeated .google.cloud.run.v2.EnvVar env = 5;

getEnvCount

int getEnvCount()

 List of environment variables to set in the container.
 

repeated .google.cloud.run.v2.EnvVar env = 5;

getEnvOrBuilderList

List<? extends EnvVarOrBuilder> getEnvOrBuilderList()

 List of environment variables to set in the container.
 

repeated .google.cloud.run.v2.EnvVar env = 5;

getEnvOrBuilder

EnvVarOrBuilder getEnvOrBuilder(int index)

 List of environment variables to set in the container.
 

repeated .google.cloud.run.v2.EnvVar env = 5;

hasResources

boolean hasResources()

 Compute Resource requirements by this container.
 

.google.cloud.run.v2.ResourceRequirements resources = 6;

Returns:

Whether the resources field is set.

getResources

ResourceRequirements getResources()

 Compute Resource requirements by this container.
 

.google.cloud.run.v2.ResourceRequirements resources = 6;

Returns:

The resources.

getResourcesOrBuilder

ResourceRequirementsOrBuilder getResourcesOrBuilder()

 Compute Resource requirements by this container.
 

.google.cloud.run.v2.ResourceRequirements resources = 6;

getPortsList

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;

getPorts

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;

getPortsCount

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;

getPortsOrBuilderList

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;

getPortsOrBuilder

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;

getVolumeMountsList

List<VolumeMount> getVolumeMountsList()

 Volume to mount into the container's filesystem.
 

repeated .google.cloud.run.v2.VolumeMount volume_mounts = 8;

getVolumeMounts

VolumeMount getVolumeMounts(int index)

 Volume to mount into the container's filesystem.
 

repeated .google.cloud.run.v2.VolumeMount volume_mounts = 8;

getVolumeMountsCount

int getVolumeMountsCount()

 Volume to mount into the container's filesystem.
 

repeated .google.cloud.run.v2.VolumeMount volume_mounts = 8;

getVolumeMountsOrBuilderList

List<? extends VolumeMountOrBuilder> getVolumeMountsOrBuilderList()

 Volume to mount into the container's filesystem.
 

repeated .google.cloud.run.v2.VolumeMount volume_mounts = 8;

getVolumeMountsOrBuilder

VolumeMountOrBuilder getVolumeMountsOrBuilder(int index)

 Volume to mount into the container's filesystem.
 

repeated .google.cloud.run.v2.VolumeMount volume_mounts = 8;

getWorkingDir

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:

The workingDir.

getWorkingDirBytes

com.google.protobuf.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:

The bytes for workingDir.

hasLivenessProbe

boolean hasLivenessProbe()

 Periodic probe of container liveness.
 Container will be restarted if the probe fails.
 

.google.cloud.run.v2.Probe liveness_probe = 10;

Returns:

Whether the livenessProbe field is set.

getLivenessProbe

Probe getLivenessProbe()

 Periodic probe of container liveness.
 Container will be restarted if the probe fails.
 

.google.cloud.run.v2.Probe liveness_probe = 10;

Returns:

The livenessProbe.

getLivenessProbeOrBuilder

ProbeOrBuilder getLivenessProbeOrBuilder()

 Periodic probe of container liveness.
 Container will be restarted if the probe fails.
 

.google.cloud.run.v2.Probe liveness_probe = 10;

hasStartupProbe

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:

Whether the startupProbe field is set.

getStartupProbe

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:

The startupProbe.

getStartupProbeOrBuilder

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;

getDependsOnList

List<String> getDependsOnList()

 Names of the containers that must start before this container.
 

repeated string depends_on = 12;

Returns:

A list containing the dependsOn.

getDependsOnCount

int getDependsOnCount()

 Names of the containers that must start before this container.
 

repeated string depends_on = 12;

Returns:

The count of dependsOn.

getDependsOn

String getDependsOn(int index)

 Names of the containers that must start before this container.
 

repeated string depends_on = 12;

Parameters:

index - The index of the element to return.

Returns:

The dependsOn at the given index.

getDependsOnBytes

com.google.protobuf.ByteString getDependsOnBytes(int index)

 Names of the containers that must start before this container.
 

repeated string depends_on = 12;

Parameters:

index - The index of the value to return.

Returns:

The bytes of the dependsOn at the given index.

getBaseImageUri

String getBaseImageUri()

 Base image for this container. Only supported for services. If set, it
 indicates that the service is enrolled into automatic base image update.
 

string base_image_uri = 13;

Returns:

The baseImageUri.

getBaseImageUriBytes

com.google.protobuf.ByteString getBaseImageUriBytes()

 Base image for this container. Only supported for services. If set, it
 indicates that the service is enrolled into automatic base image update.
 

string base_image_uri = 13;

Returns:

The bytes for baseImageUri.

hasBuildInfo

boolean hasBuildInfo()

 Output only. The build info of the container image.
 

.google.cloud.run.v2.BuildInfo build_info = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

Whether the buildInfo field is set.

getBuildInfo

BuildInfo getBuildInfo()

 Output only. The build info of the container image.
 

.google.cloud.run.v2.BuildInfo build_info = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The buildInfo.

getBuildInfoOrBuilder

BuildInfoOrBuilder getBuildInfoOrBuilder()

 Output only. The build info of the container image.
 

.google.cloud.run.v2.BuildInfo build_info = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];