Class SecretVolumeSource (0.48.0)

public final class SecretVolumeSource extends GeneratedMessageV3 implements SecretVolumeSourceOrBuilder

The secret's value will be presented as the content of a file whose name is defined in the item path. If no items are defined, the name of the file is the secret.

Protobuf type google.cloud.run.v2.SecretVolumeSource

Static Fields

DEFAULT_MODE_FIELD_NUMBER

public static final int DEFAULT_MODE_FIELD_NUMBER
Field Value
Type Description
int

ITEMS_FIELD_NUMBER

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

getDescriptor()

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

newBuilder()

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

newBuilder(SecretVolumeSource prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public SecretVolumeSource getDefaultInstanceForType()
Returns
Type Description
SecretVolumeSource

getDefaultMode()

public int getDefaultMode()

Integer representation of mode bits to use on created files by default. Must be a value between 0000 and 0777 (octal), defaulting to 0444. Directories within the path are not affected by this setting.

Notes

  • Internally, a umask of 0222 will be applied to any non-zero value.
  • This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10).
  • This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

    This might be in conflict with other options that affect the file mode, like fsGroup, and as a result, other mode bits could be set.

int32 default_mode = 3;

Returns
Type Description
int

The defaultMode.

getItems(int index)

public VersionToPath getItems(int index)

If unspecified, the volume will expose a file whose name is the secret, relative to VolumeMount.mount_path. If specified, the key will be used as the version to fetch from Cloud Secret Manager and the path will be the name of the file exposed in the volume. When items are defined, they must specify a path and a version.

repeated .google.cloud.run.v2.VersionToPath items = 2;

Parameter
Name Description
index int
Returns
Type Description
VersionToPath

getItemsCount()

public int getItemsCount()

If unspecified, the volume will expose a file whose name is the secret, relative to VolumeMount.mount_path. If specified, the key will be used as the version to fetch from Cloud Secret Manager and the path will be the name of the file exposed in the volume. When items are defined, they must specify a path and a version.

repeated .google.cloud.run.v2.VersionToPath items = 2;

Returns
Type Description
int

getItemsList()

public List<VersionToPath> getItemsList()

If unspecified, the volume will expose a file whose name is the secret, relative to VolumeMount.mount_path. If specified, the key will be used as the version to fetch from Cloud Secret Manager and the path will be the name of the file exposed in the volume. When items are defined, they must specify a path and a version.

repeated .google.cloud.run.v2.VersionToPath items = 2;

Returns
Type Description
List<VersionToPath>

getItemsOrBuilder(int index)

public VersionToPathOrBuilder getItemsOrBuilder(int index)

If unspecified, the volume will expose a file whose name is the secret, relative to VolumeMount.mount_path. If specified, the key will be used as the version to fetch from Cloud Secret Manager and the path will be the name of the file exposed in the volume. When items are defined, they must specify a path and a version.

repeated .google.cloud.run.v2.VersionToPath items = 2;

Parameter
Name Description
index int
Returns
Type Description
VersionToPathOrBuilder

getItemsOrBuilderList()

public List<? extends VersionToPathOrBuilder> getItemsOrBuilderList()

If unspecified, the volume will expose a file whose name is the secret, relative to VolumeMount.mount_path. If specified, the key will be used as the version to fetch from Cloud Secret Manager and the path will be the name of the file exposed in the volume. When items are defined, they must specify a path and a version.

repeated .google.cloud.run.v2.VersionToPath items = 2;

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

getParserForType()

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

getSecret()

public String getSecret()

Required. The name of the secret in Cloud Secret Manager. Format: {secret} if the secret is in the same project. projects/{project}/secrets/{secret} if the secret is in a different project.

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

Returns
Type Description
String

The secret.

getSecretBytes()

public ByteString getSecretBytes()

Required. The name of the secret in Cloud Secret Manager. Format: {secret} if the secret is in the same project. projects/{project}/secrets/{secret} if the secret is in a different project.

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

Returns
Type Description
ByteString

The bytes for secret.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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 SecretVolumeSource.Builder newBuilderForType()
Returns
Type Description
SecretVolumeSource.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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