Package namespace.cloud.compute.v1beta

Interface Compute.ContainerRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Compute.ContainerRequest, Compute.ContainerRequest.Builder
Enclosing class:
Compute
public static interface Compute.ContainerRequestOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getName

      String getName()
       A name of the container being created. Must be unique within the instance.
 Must match the regular expression `[a-z0-9]([a-z0-9-]*[a-z0-9])?`.
      string name = 1;
      Returns:
      The name.

    • getNameBytes

      com.google.protobuf.ByteString getNameBytes()
       A name of the container being created. Must be unique within the instance.
 Must match the regular expression `[a-z0-9]([a-z0-9-]*[a-z0-9])?`.
      string name = 1;
      Returns:
      The bytes for name.

    • getImageRef

      String getImageRef()
       An image reference to the container image used to back this container.

 Ideally image references that are specified are fully resolved and
 "pinned", i.e. their digest is also specified.

 If no resolved image is provided, it is resolved during creation time,
 which may add latency to the creation request.

 Example:
 `ubuntu:22.04@sha256:dfd64a3b4296d8c9b62aa3309984f8620b98d87e47492599ee20739e8eb54fbf`
      string image_ref = 2;
      Returns:
      The imageRef.

    • getImageRefBytes

      com.google.protobuf.ByteString getImageRefBytes()
       An image reference to the container image used to back this container.

 Ideally image references that are specified are fully resolved and
 "pinned", i.e. their digest is also specified.

 If no resolved image is provided, it is resolved during creation time,
 which may add latency to the creation request.

 Example:
 `ubuntu:22.04@sha256:dfd64a3b4296d8c9b62aa3309984f8620b98d87e47492599ee20739e8eb54fbf`
      string image_ref = 2;
      Returns:
      The bytes for imageRef.

    • getKnownImageId

      String getKnownImageId()
       The ID of a Namespace-managed image. The ID is resolved to a pinned image
 reference during instance creation. Mutually exclusive with `image_ref`.

 Supported values:
 - `builtin:base`
 - `builtin:agents`
      string known_image_id = 17;
      Returns:
      The knownImageId.

    • getKnownImageIdBytes

      com.google.protobuf.ByteString getKnownImageIdBytes()
       The ID of a Namespace-managed image. The ID is resolved to a pinned image
 reference during instance creation. Mutually exclusive with `image_ref`.

 Supported values:
 - `builtin:base`
 - `builtin:agents`
      string known_image_id = 17;
      Returns:
      The bytes for knownImageId.

    • getArgsList

      List<String> getArgsList()
       A set of arguments to pass to the container's entrypoint. If `entrypoint`
 is not set, these are passed to the image's default ENTRYPOINT.

 Example: `["--foobar"]`
      repeated string args = 3;
      Returns:
      A list containing the args.

    • getArgsCount

      int getArgsCount()
       A set of arguments to pass to the container's entrypoint. If `entrypoint`
 is not set, these are passed to the image's default ENTRYPOINT.

 Example: `["--foobar"]`
      repeated string args = 3;
      Returns:
      The count of args.

    • getArgs

      String getArgs(int index)
       A set of arguments to pass to the container's entrypoint. If `entrypoint`
 is not set, these are passed to the image's default ENTRYPOINT.

 Example: `["--foobar"]`
      repeated string args = 3;
      Parameters:
      index - The index of the element to return.
      Returns:
      The args at the given index.

    • getArgsBytes

      com.google.protobuf.ByteString getArgsBytes(int index)
       A set of arguments to pass to the container's entrypoint. If `entrypoint`
 is not set, these are passed to the image's default ENTRYPOINT.

 Example: `["--foobar"]`
      repeated string args = 3;
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the args at the given index.

    • getEntrypointList

      List<String> getEntrypointList()
       If specified, overrides the image's entrypoint.
      repeated string entrypoint = 15;
      Returns:
      A list containing the entrypoint.

    • getEntrypointCount

      int getEntrypointCount()
       If specified, overrides the image's entrypoint.
      repeated string entrypoint = 15;
      Returns:
      The count of entrypoint.

    • getEntrypoint

      String getEntrypoint(int index)
       If specified, overrides the image's entrypoint.
      repeated string entrypoint = 15;
      Parameters:
      index - The index of the element to return.
      Returns:
      The entrypoint at the given index.

    • getEntrypointBytes

      com.google.protobuf.ByteString getEntrypointBytes(int index)
       If specified, overrides the image's entrypoint.
      repeated string entrypoint = 15;
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the entrypoint at the given index.

    • getEnvironmentCount

      int getEnvironmentCount()
       A set of environment values to be used as the container's environment.

 These set of environment variables are added in addition to a
 system-specified set of environment variables.

 Example: `{"FOOBAR": "1"}`

 This API will always be supported, but you may want to consider
 `env_vars` instead as a more complete API.
      map<string, string> environment = 4;

    • containsEnvironment

      boolean containsEnvironment(String key)
       A set of environment values to be used as the container's environment.

 These set of environment variables are added in addition to a
 system-specified set of environment variables.

 Example: `{"FOOBAR": "1"}`

 This API will always be supported, but you may want to consider
 `env_vars` instead as a more complete API.
      map<string, string> environment = 4;

    • getEnvironment

      @Deprecated Map<String,String> getEnvironment()
      Deprecated.
      Use getEnvironmentMap() instead.

    • getEnvironmentMap

      Map<String,String> getEnvironmentMap()
       A set of environment values to be used as the container's environment.

 These set of environment variables are added in addition to a
 system-specified set of environment variables.

 Example: `{"FOOBAR": "1"}`

 This API will always be supported, but you may want to consider
 `env_vars` instead as a more complete API.
      map<string, string> environment = 4;

    • getEnvironmentOrDefault

      String getEnvironmentOrDefault(String key, String defaultValue)
       A set of environment values to be used as the container's environment.

 These set of environment variables are added in addition to a
 system-specified set of environment variables.

 Example: `{"FOOBAR": "1"}`

 This API will always be supported, but you may want to consider
 `env_vars` instead as a more complete API.
      map<string, string> environment = 4;

    • getEnvironmentOrThrow

      String getEnvironmentOrThrow(String key)
       A set of environment values to be used as the container's environment.

 These set of environment variables are added in addition to a
 system-specified set of environment variables.

 Example: `{"FOOBAR": "1"}`

 This API will always be supported, but you may want to consider
 `env_vars` instead as a more complete API.
      map<string, string> environment = 4;

    • getEnvVarsList

      List<Compute.EnvironmentVariable> getEnvVarsList()
       A set of environment values to be used as the container's environment.

 These set of environment variables are added in addition to a
 system-specified set of environment variables.

 Example: `{"FOOBAR": "1"}`

 Can also refer to different source values, e.g. secrets.
 By default, no secrets are injected.
      repeated .namespace.cloud.compute.v1beta.EnvironmentVariable env_vars = 14;

    • getEnvVars

      Compute.EnvironmentVariable getEnvVars(int index)
       A set of environment values to be used as the container's environment.

 These set of environment variables are added in addition to a
 system-specified set of environment variables.

 Example: `{"FOOBAR": "1"}`

 Can also refer to different source values, e.g. secrets.
 By default, no secrets are injected.
      repeated .namespace.cloud.compute.v1beta.EnvironmentVariable env_vars = 14;

    • getEnvVarsCount

      int getEnvVarsCount()
       A set of environment values to be used as the container's environment.

 These set of environment variables are added in addition to a
 system-specified set of environment variables.

 Example: `{"FOOBAR": "1"}`

 Can also refer to different source values, e.g. secrets.
 By default, no secrets are injected.
      repeated .namespace.cloud.compute.v1beta.EnvironmentVariable env_vars = 14;

    • getEnvVarsOrBuilderList

      List<? extends Compute.EnvironmentVariableOrBuilder> getEnvVarsOrBuilderList()
       A set of environment values to be used as the container's environment.

 These set of environment variables are added in addition to a
 system-specified set of environment variables.

 Example: `{"FOOBAR": "1"}`

 Can also refer to different source values, e.g. secrets.
 By default, no secrets are injected.
      repeated .namespace.cloud.compute.v1beta.EnvironmentVariable env_vars = 14;

    • getEnvVarsOrBuilder

      Compute.EnvironmentVariableOrBuilder getEnvVarsOrBuilder(int index)
       A set of environment values to be used as the container's environment.

 These set of environment variables are added in addition to a
 system-specified set of environment variables.

 Example: `{"FOOBAR": "1"}`

 Can also refer to different source values, e.g. secrets.
 By default, no secrets are injected.
      repeated .namespace.cloud.compute.v1beta.EnvironmentVariable env_vars = 14;

    • getDockerSockPath

      String getDockerSockPath()
       If set, makes docker available to the container. Any containers that are
 started by the container via the Docker API are then run as containers
 alongside this container, not as children.

 Bind mounts work across containers by using container-aware bind mount
 resolution.

 Example: `/var/run/docker.sock`
      string docker_sock_path = 5;
      Returns:
      The dockerSockPath.

    • getDockerSockPathBytes

      com.google.protobuf.ByteString getDockerSockPathBytes()
       If set, makes docker available to the container. Any containers that are
 started by the container via the Docker API are then run as containers
 alongside this container, not as children.

 Bind mounts work across containers by using container-aware bind mount
 resolution.

 Example: `/var/run/docker.sock`
      string docker_sock_path = 5;
      Returns:
      The bytes for dockerSockPath.

    • getNscStatePath

      String getNscStatePath()
       If set, injects Namespace metadata and credentials into the container at
 the specified path. This includes the workload token and instance
 metadata, and sets the following environment variables:
 - `NSC_INSTANCE_ID`: the ID of the parent instance.
 - `NSC_ENDPOINT`: the regional Compute API endpoint.
 - `NSC_TOKEN_FILE`: path to the injected token file.

 Can be used to allow the container to call Namespace APIs as the
 instance.

 Example: `/var/run/nsc`
      string nsc_state_path = 6;
      Returns:
      The nscStatePath.

    • getNscStatePathBytes

      com.google.protobuf.ByteString getNscStatePathBytes()
       If set, injects Namespace metadata and credentials into the container at
 the specified path. This includes the workload token and instance
 metadata, and sets the following environment variables:
 - `NSC_INSTANCE_ID`: the ID of the parent instance.
 - `NSC_ENDPOINT`: the regional Compute API endpoint.
 - `NSC_TOKEN_FILE`: path to the injected token file.

 Can be used to allow the container to call Namespace APIs as the
 instance.

 Example: `/var/run/nsc`
      string nsc_state_path = 6;
      Returns:
      The bytes for nscStatePath.

    • getNscBinsPath

      String getNscBinsPath()
       If set, exposes guest-managed nsc binaries at the specified path.
      string nsc_bins_path = 18;
      Returns:
      The nscBinsPath.

    • getNscBinsPathBytes

      com.google.protobuf.ByteString getNscBinsPathBytes()
       If set, exposes guest-managed nsc binaries at the specified path.
      string nsc_bins_path = 18;
      Returns:
      The bytes for nscBinsPath.

    • getSecretsPath

      String getSecretsPath()
       If set, mounts available secrets at the specified path.
      string secrets_path = 19;
      Returns:
      The secretsPath.

    • getSecretsPathBytes

      com.google.protobuf.ByteString getSecretsPathBytes()
       If set, mounts available secrets at the specified path.
      string secrets_path = 19;
      Returns:
      The bytes for secretsPath.

    • getExportPortsList

      List<Compute.ContainerPort> getExportPortsList()
       A set of container ports to make available through the public ingress.
      repeated .namespace.cloud.compute.v1beta.ContainerPort export_ports = 7;

    • getExportPorts

      Compute.ContainerPort getExportPorts(int index)
       A set of container ports to make available through the public ingress.
      repeated .namespace.cloud.compute.v1beta.ContainerPort export_ports = 7;

    • getExportPortsCount

      int getExportPortsCount()
       A set of container ports to make available through the public ingress.
      repeated .namespace.cloud.compute.v1beta.ContainerPort export_ports = 7;

    • getExportPortsOrBuilderList

      List<? extends Compute.ContainerPortOrBuilder> getExportPortsOrBuilderList()
       A set of container ports to make available through the public ingress.
      repeated .namespace.cloud.compute.v1beta.ContainerPort export_ports = 7;

    • getExportPortsOrBuilder

      Compute.ContainerPortOrBuilder getExportPortsOrBuilder(int index)
       A set of container ports to make available through the public ingress.
      repeated .namespace.cloud.compute.v1beta.ContainerPort export_ports = 7;

    • getNetworkValue

      int getNetworkValue()
       By default containers run in a bridge network, with NAT. This allows
 containers to listen on arbitrary ports without requiring coordination.

 The container can be run in the instance networking by specifying `HOST`.
      .namespace.cloud.compute.v1beta.ContainerRequest.Network network = 9;
      Returns:
      The enum numeric value on the wire for network.

    • getNetwork

      Compute.ContainerRequest.Network getNetwork()
       By default containers run in a bridge network, with NAT. This allows
 containers to listen on arbitrary ports without requiring coordination.

 The container can be run in the instance networking by specifying `HOST`.
      .namespace.cloud.compute.v1beta.ContainerRequest.Network network = 9;
      Returns:
      The network.

    • hasExperimental

      boolean hasExperimental()
       A list of experimental features to enable in this container.
      .namespace.cloud.compute.v1beta.ContainerRequest.ExperimentalFeatures experimental = 10;
      Returns:
      Whether the experimental field is set.

    • getExperimental

      Compute.ContainerRequest.ExperimentalFeatures getExperimental()
       A list of experimental features to enable in this container.
      .namespace.cloud.compute.v1beta.ContainerRequest.ExperimentalFeatures experimental = 10;
      Returns:
      The experimental.

    • getExperimentalOrBuilder

      Compute.ContainerRequest.ExperimentalFeaturesOrBuilder getExperimentalOrBuilder()
       A list of experimental features to enable in this container.
      .namespace.cloud.compute.v1beta.ContainerRequest.ExperimentalFeatures experimental = 10;

    • getPrivileged

      boolean getPrivileged()
       Run the container with all capabilities.
      bool privileged = 11;
      Returns:
      The privileged.

    • getVolumesList

      List<Compute.VolumeRequest> getVolumesList()
       A set of volumes to be attached to this container.
      repeated .namespace.cloud.compute.v1beta.VolumeRequest volumes = 12;

    • getVolumes

      Compute.VolumeRequest getVolumes(int index)
       A set of volumes to be attached to this container.
      repeated .namespace.cloud.compute.v1beta.VolumeRequest volumes = 12;

    • getVolumesCount

      int getVolumesCount()
       A set of volumes to be attached to this container.
      repeated .namespace.cloud.compute.v1beta.VolumeRequest volumes = 12;

    • getVolumesOrBuilderList

      List<? extends Compute.VolumeRequestOrBuilder> getVolumesOrBuilderList()
       A set of volumes to be attached to this container.
      repeated .namespace.cloud.compute.v1beta.VolumeRequest volumes = 12;

    • getVolumesOrBuilder

      Compute.VolumeRequestOrBuilder getVolumesOrBuilder(int index)
       A set of volumes to be attached to this container.
      repeated .namespace.cloud.compute.v1beta.VolumeRequest volumes = 12;

    • getWorkloadTypeValue

      int getWorkloadTypeValue()
       When a container terminates, the instance where it runs in will also
 terminate. If the workload type is set to `service`, the instance will always be
 marked as failed, regardless of the exit code of the container.
      .namespace.cloud.compute.v1beta.ContainerRequest.WorkloadType workload_type = 13;
      Returns:
      The enum numeric value on the wire for workloadType.

    • getWorkloadType

      Compute.ContainerRequest.WorkloadType getWorkloadType()
       When a container terminates, the instance where it runs in will also
 terminate. If the workload type is set to `service`, the instance will always be
 marked as failed, regardless of the exit code of the container.
      .namespace.cloud.compute.v1beta.ContainerRequest.WorkloadType workload_type = 13;
      Returns:
      The workloadType.

    • getSidecarVolumesList

      List<Compute.ContainerRequest.SidecarVolume> getSidecarVolumesList()
       A set of volumes that get mounted into the container at the specified paths.
 These volumes are always read-only.
      repeated .namespace.cloud.compute.v1beta.ContainerRequest.SidecarVolume sidecar_volumes = 16;

    • getSidecarVolumes

      Compute.ContainerRequest.SidecarVolume getSidecarVolumes(int index)
       A set of volumes that get mounted into the container at the specified paths.
 These volumes are always read-only.
      repeated .namespace.cloud.compute.v1beta.ContainerRequest.SidecarVolume sidecar_volumes = 16;

    • getSidecarVolumesCount

      int getSidecarVolumesCount()
       A set of volumes that get mounted into the container at the specified paths.
 These volumes are always read-only.
      repeated .namespace.cloud.compute.v1beta.ContainerRequest.SidecarVolume sidecar_volumes = 16;

    • getSidecarVolumesOrBuilderList

      List<? extends Compute.ContainerRequest.SidecarVolumeOrBuilder> getSidecarVolumesOrBuilderList()
       A set of volumes that get mounted into the container at the specified paths.
 These volumes are always read-only.
      repeated .namespace.cloud.compute.v1beta.ContainerRequest.SidecarVolume sidecar_volumes = 16;

    • getSidecarVolumesOrBuilder

      Compute.ContainerRequest.SidecarVolumeOrBuilder getSidecarVolumesOrBuilder(int index)
       A set of volumes that get mounted into the container at the specified paths.
 These volumes are always read-only.
      repeated .namespace.cloud.compute.v1beta.ContainerRequest.SidecarVolume sidecar_volumes = 16;