Class Volume (0.45.0) 

public final class Volume extends GeneratedMessageV3 implements VolumeOrBuilder

Volume represents a named volume in a container.

Protobuf type google.cloud.run.v2.Volume

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > Volume

Implements

VolumeOrBuilder

Static Fields

CLOUD_SQL_INSTANCE_FIELD_NUMBER

public static final int CLOUD_SQL_INSTANCE_FIELD_NUMBER
Field Value
Type Description
int

EMPTY_DIR_FIELD_NUMBER

public static final int EMPTY_DIR_FIELD_NUMBER
Field Value
Type Description
int

GCS_FIELD_NUMBER

public static final int GCS_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

NFS_FIELD_NUMBER

public static final int NFS_FIELD_NUMBER
Field Value
Type Description
int

SECRET_FIELD_NUMBER

public static final int SECRET_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Volume getDefaultInstance()
Returns
Type Description
Volume

getDescriptor()

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

newBuilder()

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

newBuilder(Volume prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getCloudSqlInstance()

public CloudSqlInstance getCloudSqlInstance()

For Cloud SQL volumes, contains the specific instances that should be mounted. Visit https://cloud.google.com/sql/docs/mysql/connect-run for more information on how to connect Cloud SQL and Cloud Run.

.google.cloud.run.v2.CloudSqlInstance cloud_sql_instance = 3;

Returns
Type Description
CloudSqlInstance

The cloudSqlInstance.

getCloudSqlInstanceOrBuilder()

public CloudSqlInstanceOrBuilder getCloudSqlInstanceOrBuilder()

For Cloud SQL volumes, contains the specific instances that should be mounted. Visit https://cloud.google.com/sql/docs/mysql/connect-run for more information on how to connect Cloud SQL and Cloud Run.

.google.cloud.run.v2.CloudSqlInstance cloud_sql_instance = 3;

Returns
Type Description
CloudSqlInstanceOrBuilder

getDefaultInstanceForType()

public Volume getDefaultInstanceForType()
Returns
Type Description
Volume

getEmptyDir()

public EmptyDirVolumeSource getEmptyDir()

Ephemeral storage used as a shared volume.

.google.cloud.run.v2.EmptyDirVolumeSource empty_dir = 4;

Returns
Type Description
EmptyDirVolumeSource

The emptyDir.

getEmptyDirOrBuilder()

public EmptyDirVolumeSourceOrBuilder getEmptyDirOrBuilder()

Ephemeral storage used as a shared volume.

.google.cloud.run.v2.EmptyDirVolumeSource empty_dir = 4;

Returns
Type Description
EmptyDirVolumeSourceOrBuilder

getGcs()

public GCSVolumeSource getGcs()

Persistent storage backed by a Google Cloud Storage bucket.

.google.cloud.run.v2.GCSVolumeSource gcs = 6;

Returns
Type Description
GCSVolumeSource

The gcs.

getGcsOrBuilder()

public GCSVolumeSourceOrBuilder getGcsOrBuilder()

Persistent storage backed by a Google Cloud Storage bucket.

.google.cloud.run.v2.GCSVolumeSource gcs = 6;

Returns
Type Description
GCSVolumeSourceOrBuilder

getName()

public String getName()

Required. Volume's name.

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

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Required. Volume's name.

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

Returns
Type Description
ByteString

The bytes for name.

getNfs()

public NFSVolumeSource getNfs()

For NFS Voumes, contains the path to the nfs Volume

.google.cloud.run.v2.NFSVolumeSource nfs = 5;

Returns
Type Description
NFSVolumeSource

The nfs.

getNfsOrBuilder()

public NFSVolumeSourceOrBuilder getNfsOrBuilder()

For NFS Voumes, contains the path to the nfs Volume

.google.cloud.run.v2.NFSVolumeSource nfs = 5;

Returns
Type Description
NFSVolumeSourceOrBuilder

getParserForType()

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

getSecret()

public SecretVolumeSource getSecret()

Secret represents a secret that should populate this volume.

.google.cloud.run.v2.SecretVolumeSource secret = 2;

Returns
Type Description
SecretVolumeSource

The secret.

getSecretOrBuilder()

public SecretVolumeSourceOrBuilder getSecretOrBuilder()

Secret represents a secret that should populate this volume.

.google.cloud.run.v2.SecretVolumeSource secret = 2;

Returns
Type Description
SecretVolumeSourceOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getVolumeTypeCase()

public Volume.VolumeTypeCase getVolumeTypeCase()
Returns
Type Description
Volume.VolumeTypeCase

hasCloudSqlInstance()

public boolean hasCloudSqlInstance()

For Cloud SQL volumes, contains the specific instances that should be mounted. Visit https://cloud.google.com/sql/docs/mysql/connect-run for more information on how to connect Cloud SQL and Cloud Run.

.google.cloud.run.v2.CloudSqlInstance cloud_sql_instance = 3;

Returns
Type Description
boolean

Whether the cloudSqlInstance field is set.

hasEmptyDir()

public boolean hasEmptyDir()

Ephemeral storage used as a shared volume.

.google.cloud.run.v2.EmptyDirVolumeSource empty_dir = 4;

Returns
Type Description
boolean

Whether the emptyDir field is set.

hasGcs()

public boolean hasGcs()

Persistent storage backed by a Google Cloud Storage bucket.

.google.cloud.run.v2.GCSVolumeSource gcs = 6;

Returns
Type Description
boolean

Whether the gcs field is set.

hasNfs()

public boolean hasNfs()

For NFS Voumes, contains the path to the nfs Volume

.google.cloud.run.v2.NFSVolumeSource nfs = 5;

Returns
Type Description
boolean

Whether the nfs field is set.

hasSecret()

public boolean hasSecret()

Secret represents a secret that should populate this volume.

.google.cloud.run.v2.SecretVolumeSource secret = 2;

Returns
Type Description
boolean

Whether the secret field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Volume.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Volume.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

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

writeTo(CodedOutputStream output)

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