📄 Source: EnvironmentVariable.php
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\FirebaseAppHosting;
class EnvironmentVariable extends \Google\Collection
{
/**
* Source is unspecified.
*/
public const ORIGIN_ORIGIN_UNSPECIFIED = 'ORIGIN_UNSPECIFIED';
/**
* Variable was set on the backend resource (e.g. via API or Console).
* Represents variables from `Backend.override_env`
*/
public const ORIGIN_BACKEND_OVERRIDES = 'BACKEND_OVERRIDES';
/**
* Variable was provided specifically for the build upon creation via the
* `Build.Config.env` field. Only used for pre-built images.
*/
public const ORIGIN_BUILD_CONFIG = 'BUILD_CONFIG';
/**
* Variable is defined in apphosting.yaml file.
*/
public const ORIGIN_APPHOSTING_YAML = 'APPHOSTING_YAML';
/**
* Variable is defined provided by the firebase platform.
*/
public const ORIGIN_FIREBASE_SYSTEM = 'FIREBASE_SYSTEM';
protected $collection_key = 'availability';
/**
* Optional. Where this variable should be made available. If left
* unspecified, will be available in both BUILD and BACKEND.
*
* @var string[]
*/
public $availability;
/**
* Output only. The high-level origin category of the environment variable.
*
* @var string
*/
public $origin;
/**
* Output only. Specific detail about the source. For APPHOSTING_YAML origins,
* this will contain the exact filename, such as "apphosting.yaml" or
* "apphosting.staging.yaml".
*
* @var string
*/
public $originFileName;
/**
* A fully qualified secret version. The value of the secret will be accessed
* once while building the application and once per cold start of the
* container at runtime. The service account used by Cloud Build and by Cloud
* Run must each have the `secretmanager.versions.access` permission on the
* secret.
*
* @var string
*/
public $secret;
/**
* A plaintext value. This value is encrypted at rest, but all project readers
* can view the value when reading your backend configuration.
*
* @var string
*/
public $value;
/**
* Required. The name of the environment variable. The environment variables
* reserved by [Cloud Run](https://docs.cloud.google.com/run/docs/configuring/
* services/environment-variables#reserved) should not be set. Additionally,
* variable names cannot start with "X_FIREBASE_".
*
* @var string
*/
public $variable;
/**
* Optional. Where this variable should be made available. If left
* unspecified, will be available in both BUILD and BACKEND.
*
* @param string[] $availability
*/
public function setAvailability($availability)
{
$this->availability = $availability;
}
/**
* @return string[]
*/
public function getAvailability()
{
return $this->availability;
}
/**
* Output only. The high-level origin category of the environment variable.
*
* Accepted values: ORIGIN_UNSPECIFIED, BACKEND_OVERRIDES, BUILD_CONFIG,
* APPHOSTING_YAML, FIREBASE_SYSTEM
*
* @param self::ORIGIN_* $origin
*/
public function setOrigin($origin)
{
$this->origin = $origin;
}
/**
* @return self::ORIGIN_*
*/
public function getOrigin()
{
return $this->origin;
}
/**
* Output only. Specific detail about the source. For APPHOSTING_YAML origins,
* this will contain the exact filename, such as "apphosting.yaml" or
* "apphosting.staging.yaml".
*
* @param string $originFileName
*/
public function setOriginFileName($originFileName)
{
$this->originFileName = $originFileName;
}
/**
* @return string
*/
public function getOriginFileName()
{
return $this->originFileName;
}
/**
* A fully qualified secret version. The value of the secret will be accessed
* once while building the application and once per cold start of the
* container at runtime. The service account used by Cloud Build and by Cloud
* Run must each have the `secretmanager.versions.access` permission on the
* secret.
*
* @param string $secret
*/
public function setSecret($secret)
{
$this->secret = $secret;
}
/**
* @return string
*/
public function getSecret()
{
return $this->secret;
}
/**
* A plaintext value. This value is encrypted at rest, but all project readers
* can view the value when reading your backend configuration.
*
* @param string $value
*/
public function setValue($value)
{
$this->value = $value;
}
/**
* @return string
*/
public function getValue()
{
return $this->value;
}
/**
* Required. The name of the environment variable. The environment variables
* reserved by [Cloud Run](https://docs.cloud.google.com/run/docs/configuring/
* services/environment-variables#reserved) should not be set. Additionally,
* variable names cannot start with "X_FIREBASE_".
*
* @param string $variable
*/
public function setVariable($variable)
{
$this->variable = $variable;
}
/**
* @return string
*/
public function getVariable()
{
return $this->variable;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(EnvironmentVariable::class, 'Google_Service_FirebaseAppHosting_EnvironmentVariable');
← Back