Class ProjectsResource.LocationsResource.EnvironmentsResource

The "environments" collection of methods.

Inheritance

object

ProjectsResource.LocationsResource.EnvironmentsResource

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.CloudComposer.v1beta1

Assembly: Google.Apis.CloudComposer.v1beta1.dll

Syntax

public class ProjectsResource.LocationsResource.EnvironmentsResource

Constructors

EnvironmentsResource(IClientService)

Constructs a new resource.

Declaration

public EnvironmentsResource(IClientService service)

Parameters

Type	Name	Description
IClientService	service

Properties

UserWorkloadsConfigMaps

Gets the UserWorkloadsConfigMaps resource.

Declaration

public virtual ProjectsResource.LocationsResource.EnvironmentsResource.UserWorkloadsConfigMapsResource UserWorkloadsConfigMaps { get; }

Property Value

Type	Description
ProjectsResource.LocationsResource.EnvironmentsResource.UserWorkloadsConfigMapsResource

UserWorkloadsSecrets

Gets the UserWorkloadsSecrets resource.

Declaration

public virtual ProjectsResource.LocationsResource.EnvironmentsResource.UserWorkloadsSecretsResource UserWorkloadsSecrets { get; }

Property Value

Type	Description
ProjectsResource.LocationsResource.EnvironmentsResource.UserWorkloadsSecretsResource

Workloads

Gets the Workloads resource.

Declaration

public virtual ProjectsResource.LocationsResource.EnvironmentsResource.WorkloadsResource Workloads { get; }

Property Value

Type	Description
ProjectsResource.LocationsResource.EnvironmentsResource.WorkloadsResource

Methods

CheckUpgrade(CheckUpgradeRequest, string)

Check if an upgrade operation on the environment will succeed. In case of problems detailed info can be found in the returned Operation.

Declaration

public virtual ProjectsResource.LocationsResource.EnvironmentsResource.CheckUpgradeRequest CheckUpgrade(CheckUpgradeRequest body, string environment)

Parameters

Type	Name	Description
CheckUpgradeRequest	body	The body of the request.
string	environment	The resource name of the environment to check upgrade for, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}"

Returns

Type	Description
ProjectsResource.LocationsResource.EnvironmentsResource.CheckUpgradeRequest

Create(Environment, string)

Create a new environment.

Declaration

public virtual ProjectsResource.LocationsResource.EnvironmentsResource.CreateRequest Create(Environment body, string parent)

Parameters

Type	Name	Description
Environment	body	The body of the request.
string	parent	The parent must be of the form "projects/{projectId}/locations/{locationId}".

Returns

Type	Description
ProjectsResource.LocationsResource.EnvironmentsResource.CreateRequest

DatabaseFailover(DatabaseFailoverRequest, string)

Triggers database failover (only for highly resilient environments).

Declaration

public virtual ProjectsResource.LocationsResource.EnvironmentsResource.DatabaseFailoverRequest DatabaseFailover(DatabaseFailoverRequest body, string environment)

Parameters

Type	Name	Description
DatabaseFailoverRequest	body	The body of the request.
string	environment	Target environment: "projects/{projectId}/locations/{locationId}/environments/{environmentId}"

Returns

Type	Description
ProjectsResource.LocationsResource.EnvironmentsResource.DatabaseFailoverRequest

Delete(string)

Delete an environment.

Declaration

public virtual ProjectsResource.LocationsResource.EnvironmentsResource.DeleteRequest Delete(string name)

Parameters

Type	Name	Description
string	name	The environment to delete, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}"

Returns

Type	Description
ProjectsResource.LocationsResource.EnvironmentsResource.DeleteRequest

ExecuteAirflowCommand(ExecuteAirflowCommandRequest, string)

Executes Airflow CLI command.

Declaration

public virtual ProjectsResource.LocationsResource.EnvironmentsResource.ExecuteAirflowCommandRequest ExecuteAirflowCommand(ExecuteAirflowCommandRequest body, string environment)

Parameters

Type	Name	Description
ExecuteAirflowCommandRequest	body	The body of the request.
string	environment	The resource name of the environment in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}".

Returns

Type	Description
ProjectsResource.LocationsResource.EnvironmentsResource.ExecuteAirflowCommandRequest

FetchDatabaseProperties(string)

Fetches database properties.

Declaration

public virtual ProjectsResource.LocationsResource.EnvironmentsResource.FetchDatabasePropertiesRequest FetchDatabaseProperties(string environment)

Parameters

Type	Name	Description
string	environment	Required. The resource name of the environment, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}"

Returns

Type	Description
ProjectsResource.LocationsResource.EnvironmentsResource.FetchDatabasePropertiesRequest

Get(string)

Get an existing environment.

Declaration

public virtual ProjectsResource.LocationsResource.EnvironmentsResource.GetRequest Get(string name)

Parameters

Type	Name	Description
string	name	The resource name of the environment to get, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}"

Returns

Type	Description
ProjectsResource.LocationsResource.EnvironmentsResource.GetRequest

Hibernate(HibernateEnvironmentRequest, string)

Hibernates (pauses) a running environment. It requests the environment to switch to the HIBERNATED state, keeping its data and minimizing cost, but not running any DAGs. This method is supported for Cloud Composer environments in development mode in versions composer-3-airflow-..-build. and newer.

Declaration

public virtual ProjectsResource.LocationsResource.EnvironmentsResource.HibernateRequest Hibernate(HibernateEnvironmentRequest body, string name)

Parameters

Type	Name	Description
HibernateEnvironmentRequest	body	The body of the request.
string	name	Required. The resource name of the environment to hibernate, in the form: "projects/{project}/locations/{location}/environments/{environment}"

Returns

Type	Description
ProjectsResource.LocationsResource.EnvironmentsResource.HibernateRequest

List(string)

List environments.

Declaration

public virtual ProjectsResource.LocationsResource.EnvironmentsResource.ListRequest List(string parent)

Parameters

Type	Name	Description
string	parent	List environments in the given project and location, in the form: "projects/{projectId}/locations/{locationId}"

Returns

Type	Description
ProjectsResource.LocationsResource.EnvironmentsResource.ListRequest

LoadSnapshot(LoadSnapshotRequest, string)

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.

Declaration

public virtual ProjectsResource.LocationsResource.EnvironmentsResource.LoadSnapshotRequest LoadSnapshot(LoadSnapshotRequest body, string environment)

Parameters

Type	Name	Description
LoadSnapshotRequest	body	The body of the request.
string	environment	The resource name of the target environment in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}"

Returns

Type	Description
ProjectsResource.LocationsResource.EnvironmentsResource.LoadSnapshotRequest

Patch(Environment, string)

Update an environment.

Declaration

public virtual ProjectsResource.LocationsResource.EnvironmentsResource.PatchRequest Patch(Environment body, string name)

Parameters

Type	Name	Description
Environment	body	The body of the request.
string	name	The relative resource name of the environment to update, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}"

Returns

Type	Description
ProjectsResource.LocationsResource.EnvironmentsResource.PatchRequest

PollAirflowCommand(PollAirflowCommandRequest, string)

Polls Airflow CLI command execution and fetches logs.

Declaration

public virtual ProjectsResource.LocationsResource.EnvironmentsResource.PollAirflowCommandRequest PollAirflowCommand(PollAirflowCommandRequest body, string environment)

Parameters

Type	Name	Description
PollAirflowCommandRequest	body	The body of the request.
string	environment	The resource name of the environment in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}"

Returns

Type	Description
ProjectsResource.LocationsResource.EnvironmentsResource.PollAirflowCommandRequest

RestartWebServer(RestartWebServerRequest, string)

Restart Airflow web server.

Declaration

public virtual ProjectsResource.LocationsResource.EnvironmentsResource.RestartWebServerRequest RestartWebServer(RestartWebServerRequest body, string name)

Parameters

Type	Name	Description
RestartWebServerRequest	body	The body of the request.
string	name	Required. The resource name of the environment to restart the web server for, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}"

Returns

Type	Description
ProjectsResource.LocationsResource.EnvironmentsResource.RestartWebServerRequest

Resume(ResumeEnvironmentRequest, string)

Resumes (unpauses) a hibernated environment. It requests the environment to switch to the RUNNING state, so that it is ready to use and run DAGs. This method is supported for Cloud Composer environments in development mode in versions composer-3-airflow-..-build. and newer.

Declaration

public virtual ProjectsResource.LocationsResource.EnvironmentsResource.ResumeRequest Resume(ResumeEnvironmentRequest body, string name)

Parameters

Type	Name	Description
ResumeEnvironmentRequest	body	The body of the request.
string	name	Required. The resource name of the environment to resume, in the form: "projects/{project}/locations/{location}/environments/{environment}"

Returns

Type	Description
ProjectsResource.LocationsResource.EnvironmentsResource.ResumeRequest

SaveSnapshot(SaveSnapshotRequest, string)

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.

Declaration

public virtual ProjectsResource.LocationsResource.EnvironmentsResource.SaveSnapshotRequest SaveSnapshot(SaveSnapshotRequest body, string environment)

Parameters

Type	Name	Description
SaveSnapshotRequest	body	The body of the request.
string	environment	The resource name of the source environment in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}"

Returns

Type	Description
ProjectsResource.LocationsResource.EnvironmentsResource.SaveSnapshotRequest

StopAirflowCommand(StopAirflowCommandRequest, string)

Stops Airflow CLI command execution.

Declaration

public virtual ProjectsResource.LocationsResource.EnvironmentsResource.StopAirflowCommandRequest StopAirflowCommand(StopAirflowCommandRequest body, string environment)

Parameters

Type	Name	Description
StopAirflowCommandRequest	body	The body of the request.
string	environment	The resource name of the environment in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}".

Returns

Type	Description
ProjectsResource.LocationsResource.EnvironmentsResource.StopAirflowCommandRequest