Skip to content

Latest commit

 

History

History
351 lines (192 loc) · 11.7 KB

VariableRequest.md

File metadata and controls

351 lines (192 loc) · 11.7 KB

VariableRequest

Properties

Name Type Description Notes
Key string the key of the environment variable
Value string the value of the environment variable
MountPath Pointer to NullableString the path where the file will be mounted (only if type =file) [optional]
IsSecret bool if true, the variable will be considered as a secret and will not be accessible after its creation. Only your applications will be able to access its value at build and run time.
VariableScope APIVariableScopeEnum
VariableParentId string based on the selected scope, it contains the ID of the service, environment or project where the variable is attached
Description Pointer to NullableString optional variable description (255 characters maximum) [optional]
EnableInterpolationInFile Pointer to NullableBool [optional]
SecretManagerAccessId Pointer to NullableString [optional]
OverrideIfExists Pointer to NullableBool If true and a variable with the same key already exists at a higher scope (project or environment), an override of that variable is created instead of failing with 409. The override follows the usual rules: same secret kind, target must be a value or file variable, strictly lower scope. Defaults to false. [optional] [default to false]
JsonTargetKey Pointer to NullableString Optional JSON member/index path, only supported for `EXTERNAL_SECRET` variables (not external secret files). Use dots for nested members and numeric indexes for arrays, for example `accounts.0.password`. Escape literal dots with `\.` and backslashes with `\\`; other query characters are treated literally. Members must be non-empty, with no leading or trailing whitespace, control characters, or unescaped trailing backslash. Omit or set to null to read the whole secret. [optional]

Methods

NewVariableRequest

func NewVariableRequest(key string, value string, isSecret bool, variableScope APIVariableScopeEnum, variableParentId string, ) *VariableRequest

NewVariableRequest instantiates a new VariableRequest object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

NewVariableRequestWithDefaults

func NewVariableRequestWithDefaults() *VariableRequest

NewVariableRequestWithDefaults instantiates a new VariableRequest object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

GetKey

func (o *VariableRequest) GetKey() string

GetKey returns the Key field if non-nil, zero value otherwise.

GetKeyOk

func (o *VariableRequest) GetKeyOk() (*string, bool)

GetKeyOk returns a tuple with the Key field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetKey

func (o *VariableRequest) SetKey(v string)

SetKey sets Key field to given value.

GetValue

func (o *VariableRequest) GetValue() string

GetValue returns the Value field if non-nil, zero value otherwise.

GetValueOk

func (o *VariableRequest) GetValueOk() (*string, bool)

GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetValue

func (o *VariableRequest) SetValue(v string)

SetValue sets Value field to given value.

GetMountPath

func (o *VariableRequest) GetMountPath() string

GetMountPath returns the MountPath field if non-nil, zero value otherwise.

GetMountPathOk

func (o *VariableRequest) GetMountPathOk() (*string, bool)

GetMountPathOk returns a tuple with the MountPath field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetMountPath

func (o *VariableRequest) SetMountPath(v string)

SetMountPath sets MountPath field to given value.

HasMountPath

func (o *VariableRequest) HasMountPath() bool

HasMountPath returns a boolean if a field has been set.

SetMountPathNil

func (o *VariableRequest) SetMountPathNil(b bool)

SetMountPathNil sets the value for MountPath to be an explicit nil

UnsetMountPath

func (o *VariableRequest) UnsetMountPath()

UnsetMountPath ensures that no value is present for MountPath, not even an explicit nil

GetIsSecret

func (o *VariableRequest) GetIsSecret() bool

GetIsSecret returns the IsSecret field if non-nil, zero value otherwise.

GetIsSecretOk

func (o *VariableRequest) GetIsSecretOk() (*bool, bool)

GetIsSecretOk returns a tuple with the IsSecret field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetIsSecret

func (o *VariableRequest) SetIsSecret(v bool)

SetIsSecret sets IsSecret field to given value.

GetVariableScope

func (o *VariableRequest) GetVariableScope() APIVariableScopeEnum

GetVariableScope returns the VariableScope field if non-nil, zero value otherwise.

GetVariableScopeOk

func (o *VariableRequest) GetVariableScopeOk() (*APIVariableScopeEnum, bool)

GetVariableScopeOk returns a tuple with the VariableScope field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetVariableScope

func (o *VariableRequest) SetVariableScope(v APIVariableScopeEnum)

SetVariableScope sets VariableScope field to given value.

GetVariableParentId

func (o *VariableRequest) GetVariableParentId() string

GetVariableParentId returns the VariableParentId field if non-nil, zero value otherwise.

GetVariableParentIdOk

func (o *VariableRequest) GetVariableParentIdOk() (*string, bool)

GetVariableParentIdOk returns a tuple with the VariableParentId field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetVariableParentId

func (o *VariableRequest) SetVariableParentId(v string)

SetVariableParentId sets VariableParentId field to given value.

GetDescription

func (o *VariableRequest) GetDescription() string

GetDescription returns the Description field if non-nil, zero value otherwise.

GetDescriptionOk

func (o *VariableRequest) GetDescriptionOk() (*string, bool)

GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetDescription

func (o *VariableRequest) SetDescription(v string)

SetDescription sets Description field to given value.

HasDescription

func (o *VariableRequest) HasDescription() bool

HasDescription returns a boolean if a field has been set.

SetDescriptionNil

func (o *VariableRequest) SetDescriptionNil(b bool)

SetDescriptionNil sets the value for Description to be an explicit nil

UnsetDescription

func (o *VariableRequest) UnsetDescription()

UnsetDescription ensures that no value is present for Description, not even an explicit nil

GetEnableInterpolationInFile

func (o *VariableRequest) GetEnableInterpolationInFile() bool

GetEnableInterpolationInFile returns the EnableInterpolationInFile field if non-nil, zero value otherwise.

GetEnableInterpolationInFileOk

func (o *VariableRequest) GetEnableInterpolationInFileOk() (*bool, bool)

GetEnableInterpolationInFileOk returns a tuple with the EnableInterpolationInFile field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetEnableInterpolationInFile

func (o *VariableRequest) SetEnableInterpolationInFile(v bool)

SetEnableInterpolationInFile sets EnableInterpolationInFile field to given value.

HasEnableInterpolationInFile

func (o *VariableRequest) HasEnableInterpolationInFile() bool

HasEnableInterpolationInFile returns a boolean if a field has been set.

SetEnableInterpolationInFileNil

func (o *VariableRequest) SetEnableInterpolationInFileNil(b bool)

SetEnableInterpolationInFileNil sets the value for EnableInterpolationInFile to be an explicit nil

UnsetEnableInterpolationInFile

func (o *VariableRequest) UnsetEnableInterpolationInFile()

UnsetEnableInterpolationInFile ensures that no value is present for EnableInterpolationInFile, not even an explicit nil

GetSecretManagerAccessId

func (o *VariableRequest) GetSecretManagerAccessId() string

GetSecretManagerAccessId returns the SecretManagerAccessId field if non-nil, zero value otherwise.

GetSecretManagerAccessIdOk

func (o *VariableRequest) GetSecretManagerAccessIdOk() (*string, bool)

GetSecretManagerAccessIdOk returns a tuple with the SecretManagerAccessId field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetSecretManagerAccessId

func (o *VariableRequest) SetSecretManagerAccessId(v string)

SetSecretManagerAccessId sets SecretManagerAccessId field to given value.

HasSecretManagerAccessId

func (o *VariableRequest) HasSecretManagerAccessId() bool

HasSecretManagerAccessId returns a boolean if a field has been set.

SetSecretManagerAccessIdNil

func (o *VariableRequest) SetSecretManagerAccessIdNil(b bool)

SetSecretManagerAccessIdNil sets the value for SecretManagerAccessId to be an explicit nil

UnsetSecretManagerAccessId

func (o *VariableRequest) UnsetSecretManagerAccessId()

UnsetSecretManagerAccessId ensures that no value is present for SecretManagerAccessId, not even an explicit nil

GetOverrideIfExists

func (o *VariableRequest) GetOverrideIfExists() bool

GetOverrideIfExists returns the OverrideIfExists field if non-nil, zero value otherwise.

GetOverrideIfExistsOk

func (o *VariableRequest) GetOverrideIfExistsOk() (*bool, bool)

GetOverrideIfExistsOk returns a tuple with the OverrideIfExists field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetOverrideIfExists

func (o *VariableRequest) SetOverrideIfExists(v bool)

SetOverrideIfExists sets OverrideIfExists field to given value.

HasOverrideIfExists

func (o *VariableRequest) HasOverrideIfExists() bool

HasOverrideIfExists returns a boolean if a field has been set.

SetOverrideIfExistsNil

func (o *VariableRequest) SetOverrideIfExistsNil(b bool)

SetOverrideIfExistsNil sets the value for OverrideIfExists to be an explicit nil

UnsetOverrideIfExists

func (o *VariableRequest) UnsetOverrideIfExists()

UnsetOverrideIfExists ensures that no value is present for OverrideIfExists, not even an explicit nil

GetJsonTargetKey

func (o *VariableRequest) GetJsonTargetKey() string

GetJsonTargetKey returns the JsonTargetKey field if non-nil, zero value otherwise.

GetJsonTargetKeyOk

func (o *VariableRequest) GetJsonTargetKeyOk() (*string, bool)

GetJsonTargetKeyOk returns a tuple with the JsonTargetKey field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetJsonTargetKey

func (o *VariableRequest) SetJsonTargetKey(v string)

SetJsonTargetKey sets JsonTargetKey field to given value.

HasJsonTargetKey

func (o *VariableRequest) HasJsonTargetKey() bool

HasJsonTargetKey returns a boolean if a field has been set.

SetJsonTargetKeyNil

func (o *VariableRequest) SetJsonTargetKeyNil(b bool)

SetJsonTargetKeyNil sets the value for JsonTargetKey to be an explicit nil

UnsetJsonTargetKey

func (o *VariableRequest) UnsetJsonTargetKey()

UnsetJsonTargetKey ensures that no value is present for JsonTargetKey, not even an explicit nil

[Back to Model list] [Back to API list] [Back to README]