Class SecretVolumeSource.Builder (0.54.0) 

public static final class SecretVolumeSource.Builder extends GeneratedMessageV3.Builder<SecretVolumeSource.Builder> 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

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > SecretVolumeSource.Builder

Static Methods

getDescriptor()

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

Methods

addAllItems(Iterable<? extends VersionToPath> values)

public SecretVolumeSource.Builder addAllItems(Iterable<? extends VersionToPath> values)

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
values Iterable<? extends com.google.cloud.run.v2.VersionToPath>
Returns
Type Description
SecretVolumeSource.Builder

addItems(VersionToPath value)

public SecretVolumeSource.Builder addItems(VersionToPath value)

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
value VersionToPath
Returns
Type Description
SecretVolumeSource.Builder

addItems(VersionToPath.Builder builderForValue)

public SecretVolumeSource.Builder addItems(VersionToPath.Builder builderForValue)

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
builderForValue VersionToPath.Builder
Returns
Type Description
SecretVolumeSource.Builder

addItems(int index, VersionToPath value)

public SecretVolumeSource.Builder addItems(int index, VersionToPath value)

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;

Parameters
Name Description
index int
value VersionToPath
Returns
Type Description
SecretVolumeSource.Builder

addItems(int index, VersionToPath.Builder builderForValue)

public SecretVolumeSource.Builder addItems(int index, VersionToPath.Builder builderForValue)

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;

Parameters
Name Description
index int
builderForValue VersionToPath.Builder
Returns
Type Description
SecretVolumeSource.Builder

addItemsBuilder()

public VersionToPath.Builder addItemsBuilder()

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
VersionToPath.Builder

addItemsBuilder(int index)

public VersionToPath.Builder addItemsBuilder(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.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public SecretVolumeSource.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
SecretVolumeSource.Builder
Overrides

build()

public SecretVolumeSource build()
Returns
Type Description
SecretVolumeSource

buildPartial()

public SecretVolumeSource buildPartial()
Returns
Type Description
SecretVolumeSource

clear()

public SecretVolumeSource.Builder clear()
Returns
Type Description
SecretVolumeSource.Builder
Overrides

clearDefaultMode()

public SecretVolumeSource.Builder clearDefaultMode()

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 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
SecretVolumeSource.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public SecretVolumeSource.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
SecretVolumeSource.Builder
Overrides

clearItems()

public SecretVolumeSource.Builder clearItems()

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
SecretVolumeSource.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public SecretVolumeSource.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
SecretVolumeSource.Builder
Overrides

clearSecret()

public SecretVolumeSource.Builder clearSecret()

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
SecretVolumeSource.Builder

This builder for chaining.

clone()

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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

getItemsBuilder(int index)

public VersionToPath.Builder getItemsBuilder(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.Builder

getItemsBuilderList()

public List<VersionToPath.Builder> getItemsBuilderList()

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<Builder>

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>

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(SecretVolumeSource other)

public SecretVolumeSource.Builder mergeFrom(SecretVolumeSource other)
Parameter
Name Description
other SecretVolumeSource
Returns
Type Description
SecretVolumeSource.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public SecretVolumeSource.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SecretVolumeSource.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public SecretVolumeSource.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
SecretVolumeSource.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final SecretVolumeSource.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
SecretVolumeSource.Builder
Overrides

removeItems(int index)

public SecretVolumeSource.Builder removeItems(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
SecretVolumeSource.Builder

setDefaultMode(int value)

public SecretVolumeSource.Builder setDefaultMode(int value)

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 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;

Parameter
Name Description
value int

The defaultMode to set.
Returns
Type Description
SecretVolumeSource.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public SecretVolumeSource.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
SecretVolumeSource.Builder
Overrides

setItems(int index, VersionToPath value)

public SecretVolumeSource.Builder setItems(int index, VersionToPath value)

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;

Parameters
Name Description
index int
value VersionToPath
Returns
Type Description
SecretVolumeSource.Builder

setItems(int index, VersionToPath.Builder builderForValue)

public SecretVolumeSource.Builder setItems(int index, VersionToPath.Builder builderForValue)

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;

Parameters
Name Description
index int
builderForValue VersionToPath.Builder
Returns
Type Description
SecretVolumeSource.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public SecretVolumeSource.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
SecretVolumeSource.Builder
Overrides

setSecret(String value)

public SecretVolumeSource.Builder setSecret(String value)

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];

Parameter
Name Description
value String

The secret to set.
Returns
Type Description
SecretVolumeSource.Builder

This builder for chaining.

setSecretBytes(ByteString value)

public SecretVolumeSource.Builder setSecretBytes(ByteString value)

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];

Parameter
Name Description
value ByteString

The bytes for secret to set.
Returns
Type Description
SecretVolumeSource.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final SecretVolumeSource.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
SecretVolumeSource.Builder
Overrides