Class SandboxTemplate (0.103.0)

public final class SandboxTemplate extends GeneratedMessage implements SandboxTemplateOrBuilder

Template for a single sandbox.

Protobuf type google.cloud.run.v2.SandboxTemplate

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

NAME_FIELD_NUMBER

public static final int NAME_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 SandboxTemplate getDefaultInstance()
Returns
Type Description
SandboxTemplate

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static SandboxTemplate.Builder newBuilder()
Returns
Type Description
SandboxTemplate.Builder

newBuilder(SandboxTemplate prototype)

public static SandboxTemplate.Builder newBuilder(SandboxTemplate prototype)
Parameter
Name Description
prototype SandboxTemplate
Returns
Type Description
SandboxTemplate.Builder

parseDelimitedFrom(InputStream input)

public static SandboxTemplate parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SandboxTemplate
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SandboxTemplate parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SandboxTemplate
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static SandboxTemplate parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
SandboxTemplate
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SandboxTemplate parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SandboxTemplate
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static SandboxTemplate parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
SandboxTemplate
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SandboxTemplate parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SandboxTemplate
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SandboxTemplate parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
SandboxTemplate
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SandboxTemplate parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SandboxTemplate
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static SandboxTemplate parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SandboxTemplate
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SandboxTemplate parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SandboxTemplate
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static SandboxTemplate parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
SandboxTemplate
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SandboxTemplate parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SandboxTemplate
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<SandboxTemplate> parser()
Returns
Type Description
Parser<SandboxTemplate>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getArgs(int index)

public String getArgs(int index)

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

repeated string args = 4 [(.google.api.field_behavior) = OPTIONAL];

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)

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

repeated string args = 4 [(.google.api.field_behavior) = OPTIONAL];

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()

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

repeated string args = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The count of args.

getArgsList()

public ProtocolStringList getArgsList()

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

repeated string args = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ProtocolStringList

A list containing the args.

getCommand(int index)

public String getCommand(int index)

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

repeated string command = 3 [(.google.api.field_behavior) = OPTIONAL];

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)

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

repeated string command = 3 [(.google.api.field_behavior) = OPTIONAL];

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()

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

repeated string command = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The count of command.

getCommandList()

public ProtocolStringList getCommandList()

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

repeated string command = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ProtocolStringList

A list containing the command.

getDefaultInstanceForType()

public SandboxTemplate getDefaultInstanceForType()
Returns
Type Description
SandboxTemplate

getEnv(int index)

public EnvVar getEnv(int index)

Optional. List of environment variables to set in the sandbox.

repeated .google.cloud.run.v2.EnvVar env = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
EnvVar

getEnvCount()

public int getEnvCount()

Optional. List of environment variables to set in the sandbox.

repeated .google.cloud.run.v2.EnvVar env = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getEnvList()

public List<EnvVar> getEnvList()

Optional. List of environment variables to set in the sandbox.

repeated .google.cloud.run.v2.EnvVar env = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<EnvVar>

getEnvOrBuilder(int index)

public EnvVarOrBuilder getEnvOrBuilder(int index)

Optional. List of environment variables to set in the sandbox.

repeated .google.cloud.run.v2.EnvVar env = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
EnvVarOrBuilder

getEnvOrBuilderList()

public List<? extends EnvVarOrBuilder> getEnvOrBuilderList()

Optional. List of environment variables to set in the sandbox.

repeated .google.cloud.run.v2.EnvVar env = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<? extends com.google.cloud.run.v2.EnvVarOrBuilder>

getImage()

public String getImage()

Required. Name of the container image in Dockerhub or Artifact 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 or Artifact 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.

getName()

public String getName()

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

string name = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

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

string name = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

public Parser<SandboxTemplate> getParserForType()
Returns
Type Description
Parser<SandboxTemplate>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getVolumeMounts(int index)

public VolumeMount getVolumeMounts(int index)

Optional. Volume to mount into the container's filesystem.

repeated .google.cloud.run.v2.VolumeMount volume_mounts = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
VolumeMount

getVolumeMountsCount()

public int getVolumeMountsCount()

Optional. Volume to mount into the container's filesystem.

repeated .google.cloud.run.v2.VolumeMount volume_mounts = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getVolumeMountsList()

public List<VolumeMount> getVolumeMountsList()

Optional. Volume to mount into the container's filesystem.

repeated .google.cloud.run.v2.VolumeMount volume_mounts = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<VolumeMount>

getVolumeMountsOrBuilder(int index)

public VolumeMountOrBuilder getVolumeMountsOrBuilder(int index)

Optional. Volume to mount into the container's filesystem.

repeated .google.cloud.run.v2.VolumeMount volume_mounts = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
VolumeMountOrBuilder

getVolumeMountsOrBuilderList()

public List<? extends VolumeMountOrBuilder> getVolumeMountsOrBuilderList()

Optional. Volume to mount into the container's filesystem.

repeated .google.cloud.run.v2.VolumeMount volume_mounts = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<? extends com.google.cloud.run.v2.VolumeMountOrBuilder>

getWorkingDir()

public String getWorkingDir()

Optional. 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 = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The workingDir.

getWorkingDirBytes()

public ByteString getWorkingDirBytes()

Optional. 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 = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for workingDir.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public SandboxTemplate.Builder newBuilderForType()
Returns
Type Description
SandboxTemplate.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected SandboxTemplate.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
SandboxTemplate.Builder
Overrides

toBuilder()

public SandboxTemplate.Builder toBuilder()
Returns
Type Description
SandboxTemplate.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException