File "ProjectsLocationsEnvironments.php"
Full Path: /home/u528834676/domains/ahavalms.com/public_html/vendor/google/apiclient-services/src/CloudComposer/Resource/ProjectsLocationsEnvironments.php
File size: 16.5 KB
MIME-type: text/x-php
Charset: utf-8
<?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\CloudComposer\Resource;
use Google\Service\CloudComposer\CheckUpgradeRequest;
use Google\Service\CloudComposer\DatabaseFailoverRequest;
use Google\Service\CloudComposer\Environment;
use Google\Service\CloudComposer\ExecuteAirflowCommandRequest;
use Google\Service\CloudComposer\ExecuteAirflowCommandResponse;
use Google\Service\CloudComposer\FetchDatabasePropertiesResponse;
use Google\Service\CloudComposer\ListEnvironmentsResponse;
use Google\Service\CloudComposer\LoadSnapshotRequest;
use Google\Service\CloudComposer\Operation;
use Google\Service\CloudComposer\PollAirflowCommandRequest;
use Google\Service\CloudComposer\PollAirflowCommandResponse;
use Google\Service\CloudComposer\SaveSnapshotRequest;
use Google\Service\CloudComposer\StopAirflowCommandRequest;
use Google\Service\CloudComposer\StopAirflowCommandResponse;
/**
* The "environments" collection of methods.
* Typical usage is:
* <code>
* $composerService = new Google\Service\CloudComposer(...);
* $environments = $composerService->projects_locations_environments;
* </code>
*/
class ProjectsLocationsEnvironments extends \Google\Service\Resource
{
/**
* Check if an upgrade operation on the environment will succeed. In case of
* problems detailed info can be found in the returned Operation.
* (environments.checkUpgrade)
*
* @param string $environment Required. The resource name of the environment to
* check upgrade for, in the form:
* "projects/{projectId}/locations/{locationId}/environments/{environmentId}"
* @param CheckUpgradeRequest $postBody
* @param array $optParams Optional parameters.
* @return Operation
* @throws \Google\Service\Exception
*/
public function checkUpgrade($environment, CheckUpgradeRequest $postBody, $optParams = [])
{
$params = ['environment' => $environment, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('checkUpgrade', [$params], Operation::class);
}
/**
* Create a new environment. (environments.create)
*
* @param string $parent The parent must be of the form
* "projects/{projectId}/locations/{locationId}".
* @param Environment $postBody
* @param array $optParams Optional parameters.
* @return Operation
* @throws \Google\Service\Exception
*/
public function create($parent, Environment $postBody, $optParams = [])
{
$params = ['parent' => $parent, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('create', [$params], Operation::class);
}
/**
* Triggers database failover (only for highly resilient environments).
* (environments.databaseFailover)
*
* @param string $environment Target environment:
* "projects/{projectId}/locations/{locationId}/environments/{environmentId}"
* @param DatabaseFailoverRequest $postBody
* @param array $optParams Optional parameters.
* @return Operation
* @throws \Google\Service\Exception
*/
public function databaseFailover($environment, DatabaseFailoverRequest $postBody, $optParams = [])
{
$params = ['environment' => $environment, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('databaseFailover', [$params], Operation::class);
}
/**
* Delete an environment. (environments.delete)
*
* @param string $name The environment to delete, in the form:
* "projects/{projectId}/locations/{locationId}/environments/{environmentId}"
* @param array $optParams Optional parameters.
* @return Operation
* @throws \Google\Service\Exception
*/
public function delete($name, $optParams = [])
{
$params = ['name' => $name];
$params = array_merge($params, $optParams);
return $this->call('delete', [$params], Operation::class);
}
/**
* Executes Airflow CLI command. (environments.executeAirflowCommand)
*
* @param string $environment The resource name of the environment in the form:
* "projects/{projectId}/locations/{locationId}/environments/{environmentId}".
* @param ExecuteAirflowCommandRequest $postBody
* @param array $optParams Optional parameters.
* @return ExecuteAirflowCommandResponse
* @throws \Google\Service\Exception
*/
public function executeAirflowCommand($environment, ExecuteAirflowCommandRequest $postBody, $optParams = [])
{
$params = ['environment' => $environment, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('executeAirflowCommand', [$params], ExecuteAirflowCommandResponse::class);
}
/**
* Fetches database properties. (environments.fetchDatabaseProperties)
*
* @param string $environment Required. The resource name of the environment, in
* the form:
* "projects/{projectId}/locations/{locationId}/environments/{environmentId}"
* @param array $optParams Optional parameters.
* @return FetchDatabasePropertiesResponse
* @throws \Google\Service\Exception
*/
public function fetchDatabaseProperties($environment, $optParams = [])
{
$params = ['environment' => $environment];
$params = array_merge($params, $optParams);
return $this->call('fetchDatabaseProperties', [$params], FetchDatabasePropertiesResponse::class);
}
/**
* Get an existing environment. (environments.get)
*
* @param string $name The resource name of the environment to get, in the form:
* "projects/{projectId}/locations/{locationId}/environments/{environmentId}"
* @param array $optParams Optional parameters.
* @return Environment
* @throws \Google\Service\Exception
*/
public function get($name, $optParams = [])
{
$params = ['name' => $name];
$params = array_merge($params, $optParams);
return $this->call('get', [$params], Environment::class);
}
/**
* List environments. (environments.listProjectsLocationsEnvironments)
*
* @param string $parent List environments in the given project and location, in
* the form: "projects/{projectId}/locations/{locationId}"
* @param array $optParams Optional parameters.
*
* @opt_param int pageSize The maximum number of environments to return.
* @opt_param string pageToken The next_page_token value returned from a
* previous List request, if any.
* @return ListEnvironmentsResponse
* @throws \Google\Service\Exception
*/
public function listProjectsLocationsEnvironments($parent, $optParams = [])
{
$params = ['parent' => $parent];
$params = array_merge($params, $optParams);
return $this->call('list', [$params], ListEnvironmentsResponse::class);
}
/**
* Loads a snapshot of a Cloud Composer environment. As a result of this
* operation, a snapshot of environment's specified in LoadSnapshotRequest is
* loaded into the environment. (environments.loadSnapshot)
*
* @param string $environment The resource name of the target environment in the
* form:
* "projects/{projectId}/locations/{locationId}/environments/{environmentId}"
* @param LoadSnapshotRequest $postBody
* @param array $optParams Optional parameters.
* @return Operation
* @throws \Google\Service\Exception
*/
public function loadSnapshot($environment, LoadSnapshotRequest $postBody, $optParams = [])
{
$params = ['environment' => $environment, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('loadSnapshot', [$params], Operation::class);
}
/**
* Update an environment. (environments.patch)
*
* @param string $name The relative resource name of the environment to update,
* in the form:
* "projects/{projectId}/locations/{locationId}/environments/{environmentId}"
* @param Environment $postBody
* @param array $optParams Optional parameters.
*
* @opt_param string updateMask Required. A comma-separated list of paths,
* relative to `Environment`, of fields to update. For example, to set the
* version of scikit-learn to install in the environment to 0.19.0 and to remove
* an existing installation of numpy, the `updateMask` parameter would include
* the following two `paths` values: "config.softwareConfig.pypiPackages.scikit-
* learn" and "config.softwareConfig.pypiPackages.numpy". The included patch
* environment would specify the scikit-learn version as follows: { "config":{
* "softwareConfig":{ "pypiPackages":{ "scikit-learn":"==0.19.0" } } } } Note
* that in the above example, any existing PyPI packages other than scikit-learn
* and numpy will be unaffected. Only one update type may be included in a
* single request's `updateMask`. For example, one cannot update both the PyPI
* packages and labels in the same request. However, it is possible to update
* multiple members of a map field simultaneously in the same request. For
* example, to set the labels "label1" and "label2" while clearing "label3"
* (assuming it already exists), one can provide the paths "labels.label1",
* "labels.label2", and "labels.label3" and populate the patch environment as
* follows: { "labels":{ "label1":"new-label1-value" "label2":"new-label2-value"
* } } Note that in the above example, any existing labels that are not included
* in the `updateMask` will be unaffected. It is also possible to replace an
* entire map field by providing the map field's path in the `updateMask`. The
* new value of the field will be that which is provided in the patch
* environment. For example, to delete all pre-existing user-specified PyPI
* packages and install botocore at version 1.7.14, the `updateMask` would
* contain the path "config.softwareConfig.pypiPackages", and the patch
* environment would be the following: { "config":{ "softwareConfig":{
* "pypiPackages":{ "botocore":"==1.7.14" } } } } **Note:** Only the following
* fields can be updated: * `config.softwareConfig.pypiPackages` * Replace all
* custom custom PyPI packages. If a replacement package map is not included in
* `environment`, all custom PyPI packages are cleared. It is an error to
* provide both this mask and a mask specifying an individual package. *
* `config.softwareConfig.pypiPackages.`packagename * Update the custom PyPI
* package *packagename*, preserving other packages. To delete the package,
* include it in `updateMask`, and omit the mapping for it in
* `environment.config.softwareConfig.pypiPackages`. It is an error to provide
* both a mask of this form and the `config.softwareConfig.pypiPackages` mask. *
* `labels` * Replace all environment labels. If a replacement labels map is not
* included in `environment`, all labels are cleared. It is an error to provide
* both this mask and a mask specifying one or more individual labels. *
* `labels.`labelName * Set the label named *labelName*, while preserving other
* labels. To delete the label, include it in `updateMask` and omit its mapping
* in `environment.labels`. It is an error to provide both a mask of this form
* and the `labels` mask. * `config.nodeCount` * Horizontally scale the number
* of nodes in the environment. An integer greater than or equal to 3 must be
* provided in the `config.nodeCount` field. Supported for Cloud Composer
* environments in versions composer-1.*.*-airflow-*.*.*. *
* `config.webServerNetworkAccessControl` * Replace the environment's current
* `WebServerNetworkAccessControl`. *
* `config.softwareConfig.airflowConfigOverrides` * Replace all Apache Airflow
* config overrides. If a replacement config overrides map is not included in
* `environment`, all config overrides are cleared. It is an error to provide
* both this mask and a mask specifying one or more individual config overrides.
* * `config.softwareConfig.airflowConfigOverrides.`section-name * Override the
* Apache Airflow config property *name* in the section named *section*,
* preserving other properties. To delete the property override, include it in
* `updateMask` and omit its mapping in
* `environment.config.softwareConfig.airflowConfigOverrides`. It is an error to
* provide both a mask of this form and the
* `config.softwareConfig.airflowConfigOverrides` mask. *
* `config.softwareConfig.envVariables` * Replace all environment variables. If
* a replacement environment variable map is not included in `environment`, all
* custom environment variables are cleared. *
* `config.softwareConfig.schedulerCount` * Horizontally scale the number of
* schedulers in Airflow. A positive integer not greater than the number of
* nodes must be provided in the `config.softwareConfig.schedulerCount` field.
* Supported for Cloud Composer environments in versions
* composer-1.*.*-airflow-2.*.*. * `config.databaseConfig.machineType` * Cloud
* SQL machine type used by Airflow database. It has to be one of:
* db-n1-standard-2, db-n1-standard-4, db-n1-standard-8 or db-n1-standard-16.
* Supported for Cloud Composer environments in versions
* composer-1.*.*-airflow-*.*.*. * `config.webServerConfig.machineType` *
* Machine type on which Airflow web server is running. It has to be one of:
* composer-n1-webserver-2, composer-n1-webserver-4 or composer-n1-webserver-8.
* Supported for Cloud Composer environments in versions
* composer-1.*.*-airflow-*.*.*.
* @return Operation
* @throws \Google\Service\Exception
*/
public function patch($name, Environment $postBody, $optParams = [])
{
$params = ['name' => $name, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('patch', [$params], Operation::class);
}
/**
* Polls Airflow CLI command execution and fetches logs.
* (environments.pollAirflowCommand)
*
* @param string $environment The resource name of the environment in the form:
* "projects/{projectId}/locations/{locationId}/environments/{environmentId}"
* @param PollAirflowCommandRequest $postBody
* @param array $optParams Optional parameters.
* @return PollAirflowCommandResponse
* @throws \Google\Service\Exception
*/
public function pollAirflowCommand($environment, PollAirflowCommandRequest $postBody, $optParams = [])
{
$params = ['environment' => $environment, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('pollAirflowCommand', [$params], PollAirflowCommandResponse::class);
}
/**
* Creates a snapshots of a Cloud Composer environment. As a result of this
* operation, snapshot of environment's state is stored in a location specified
* in the SaveSnapshotRequest. (environments.saveSnapshot)
*
* @param string $environment The resource name of the source environment in the
* form:
* "projects/{projectId}/locations/{locationId}/environments/{environmentId}"
* @param SaveSnapshotRequest $postBody
* @param array $optParams Optional parameters.
* @return Operation
* @throws \Google\Service\Exception
*/
public function saveSnapshot($environment, SaveSnapshotRequest $postBody, $optParams = [])
{
$params = ['environment' => $environment, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('saveSnapshot', [$params], Operation::class);
}
/**
* Stops Airflow CLI command execution. (environments.stopAirflowCommand)
*
* @param string $environment The resource name of the environment in the form:
* "projects/{projectId}/locations/{locationId}/environments/{environmentId}".
* @param StopAirflowCommandRequest $postBody
* @param array $optParams Optional parameters.
* @return StopAirflowCommandResponse
* @throws \Google\Service\Exception
*/
public function stopAirflowCommand($environment, StopAirflowCommandRequest $postBody, $optParams = [])
{
$params = ['environment' => $environment, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('stopAirflowCommand', [$params], StopAirflowCommandResponse::class);
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ProjectsLocationsEnvironments::class, 'Google_Service_CloudComposer_Resource_ProjectsLocationsEnvironments');