com.google.api.services.run.v1.model

Class SecretVolumeSource

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.run.v1.model.SecretVolumeSource

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class SecretVolumeSource
extends com.google.api.client.json.GenericJson

A volume representing a secret stored in Google Secret Manager. 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_name. The contents of the target Secret's Data field will be presented in a volume as files using the keys in the Data field as the file names.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Cloud Run Admin API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
SecretVolumeSource()

Method Summary

Modifier and Type	Method and Description
SecretVolumeSource	clone()
Integer	getDefaultMode() Integer representation of mode bits to use on created files by default.
List<KeyToPath>	getItems() A list of secret versions to mount in the volume.
Boolean	getOptional() Not supported by Cloud Run.
String	getSecretName() The name of the secret in Cloud Secret Manager.
SecretVolumeSource	set(String fieldName, Object value)
SecretVolumeSource	setDefaultMode(Integer defaultMode) Integer representation of mode bits to use on created files by default.
SecretVolumeSource	setItems(List<KeyToPath> items) A list of secret versions to mount in the volume.
SecretVolumeSource	setOptional(Boolean optional) Not supported by Cloud Run.
SecretVolumeSource	setSecretName(String secretName) The name of the secret in Cloud Secret Manager.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

SecretVolumeSource

public SecretVolumeSource()

Method Detail

getDefaultMode

public Integer getDefaultMode()

Integer representation of mode bits to use on created files by default. Must be a value between 01 and 0777 (octal). If 0 or not set, it will default 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.

Returns:

value or null for none

setDefaultMode

public SecretVolumeSource setDefaultMode(Integer defaultMode)

Integer representation of mode bits to use on created files by default. Must be a value between 01 and 0777 (octal). If 0 or not set, it will default 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.

Parameters:

defaultMode - defaultMode or null for none

getItems

public List<KeyToPath> getItems()

A list of secret versions to mount in the volume. If no items are specified, the volume will expose a file with the same name as the secret name. The contents of the file will be the data in the latest version of the secret. If items are 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 both a key and a path.

Returns:

value or null for none

setItems

public SecretVolumeSource setItems(List<KeyToPath> items)

A list of secret versions to mount in the volume. If no items are specified, the volume will expose a file with the same name as the secret name. The contents of the file will be the data in the latest version of the secret. If items are 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 both a key and a path.

Parameters:

items - items or null for none

getOptional

public Boolean getOptional()

Not supported by Cloud Run.

Returns:

value or null for none

setOptional

public SecretVolumeSource setOptional(Boolean optional)

Not supported by Cloud Run.

Parameters:

optional - optional or null for none

getSecretName

public String getSecretName()

The name of the secret in Cloud Secret Manager. By default, the secret is assumed to be in the same project. If the secret is in another project, you must define an alias. An alias definition has the form: :projects//secrets/. If multiple alias definitions are needed, they must be separated by commas. The alias definitions must be set on the run.googleapis.com/secrets annotation. Name of the secret in the container's namespace to use.

Returns:

value or null for none

setSecretName

public SecretVolumeSource setSecretName(String secretName)

The name of the secret in Cloud Secret Manager. By default, the secret is assumed to be in the same project. If the secret is in another project, you must define an alias. An alias definition has the form: :projects//secrets/. If multiple alias definitions are needed, they must be separated by commas. The alias definitions must be set on the run.googleapis.com/secrets annotation. Name of the secret in the container's namespace to use.

Parameters:

secretName - secretName or null for none

set

public SecretVolumeSource set(String fieldName,
                              Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public SecretVolumeSource clone()

Overrides:

clone in class com.google.api.client.json.GenericJson