• Home
• com.google.apis
• google-api-services-composer
• v1-rev20240917-2.0.0
• source code
• CloudComposer.Projects.Locations.Environments.html

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

target.apidocs.com.google.api.services.composer.v1.CloudComposer.Projects.Locations.Environments.html Maven / Gradle / Ivy

Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








com.google.api.services.composer.v1
Class CloudComposer.Projects.Locations.Environments



java.lang.Object


com.google.api.services.composer.v1.CloudComposer.Projects.Locations.Environments







Enclosing class:
CloudComposer.Projects.Locations




public class CloudComposer.Projects.Locations.Environments
extends Object
The "environments" collection of methods.











Nested Class Summary

Nested Classes 

Modifier and Type
Class and Description


class 
CloudComposer.Projects.Locations.Environments.CheckUpgrade 


class 
CloudComposer.Projects.Locations.Environments.Create 


class 
CloudComposer.Projects.Locations.Environments.DatabaseFailover 


class 
CloudComposer.Projects.Locations.Environments.Delete 


class 
CloudComposer.Projects.Locations.Environments.ExecuteAirflowCommand 


class 
CloudComposer.Projects.Locations.Environments.FetchDatabaseProperties 


class 
CloudComposer.Projects.Locations.Environments.Get 


class 
CloudComposer.Projects.Locations.Environments.List 


class 
CloudComposer.Projects.Locations.Environments.LoadSnapshot 


class 
CloudComposer.Projects.Locations.Environments.Patch 


class 
CloudComposer.Projects.Locations.Environments.PollAirflowCommand 


class 
CloudComposer.Projects.Locations.Environments.SaveSnapshot 


class 
CloudComposer.Projects.Locations.Environments.StopAirflowCommand 


class 
CloudComposer.Projects.Locations.Environments.UserWorkloadsConfigMaps
The "userWorkloadsConfigMaps" collection of methods.



class 
CloudComposer.Projects.Locations.Environments.UserWorkloadsSecrets
The "userWorkloadsSecrets" collection of methods.



class 
CloudComposer.Projects.Locations.Environments.Workloads
The "workloads" collection of methods.










Constructor Summary

Constructors 

Constructor and Description


Environments() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


CloudComposer.Projects.Locations.Environments.CheckUpgrade
checkUpgrade(String environment,
            CheckUpgradeRequest content)
Check if an upgrade operation on the environment will succeed.



CloudComposer.Projects.Locations.Environments.Create
create(String parent,
      Environment content)
Create a new environment.



CloudComposer.Projects.Locations.Environments.DatabaseFailover
databaseFailover(String environment,
                DatabaseFailoverRequest content)
Triggers database failover (only for highly resilient environments).



CloudComposer.Projects.Locations.Environments.Delete
delete(String name)
Delete an environment.



CloudComposer.Projects.Locations.Environments.ExecuteAirflowCommand
executeAirflowCommand(String environment,
                     ExecuteAirflowCommandRequest content)
Executes Airflow CLI command.



CloudComposer.Projects.Locations.Environments.FetchDatabaseProperties
fetchDatabaseProperties(String environment)
Fetches database properties.



CloudComposer.Projects.Locations.Environments.Get
get(String name)
Get an existing environment.



CloudComposer.Projects.Locations.Environments.List
list(String parent)
List environments.



CloudComposer.Projects.Locations.Environments.LoadSnapshot
loadSnapshot(String environment,
            LoadSnapshotRequest content)
Loads a snapshot of a Cloud Composer environment.



CloudComposer.Projects.Locations.Environments.Patch
patch(String name,
     Environment content)
Update an environment.



CloudComposer.Projects.Locations.Environments.PollAirflowCommand
pollAirflowCommand(String environment,
                  PollAirflowCommandRequest content)
Polls Airflow CLI command execution and fetches logs.



CloudComposer.Projects.Locations.Environments.SaveSnapshot
saveSnapshot(String environment,
            SaveSnapshotRequest content)
Creates a snapshots of a Cloud Composer environment.



CloudComposer.Projects.Locations.Environments.StopAirflowCommand
stopAirflowCommand(String environment,
                  StopAirflowCommandRequest content)
Stops Airflow CLI command execution.



CloudComposer.Projects.Locations.Environments.UserWorkloadsConfigMaps
userWorkloadsConfigMaps()
An accessor for creating requests from the UserWorkloadsConfigMaps collection.



CloudComposer.Projects.Locations.Environments.UserWorkloadsSecrets
userWorkloadsSecrets()
An accessor for creating requests from the UserWorkloadsSecrets collection.



CloudComposer.Projects.Locations.Environments.Workloads
workloads()
An accessor for creating requests from the Workloads collection.







Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait














Constructor Detail





Environments
public Environments()









Method Detail





checkUpgrade
public CloudComposer.Projects.Locations.Environments.CheckUpgrade checkUpgrade(String environment,
                                                                               CheckUpgradeRequest content)
                                                                        throws IOException
Check if an upgrade operation on the environment will succeed. In case of problems detailed info
 can be found in the returned Operation.

 Create a request for the method "environments.checkUpgrade".

 This request holds the parameters needed by the composer server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
environment - Required. The resource name of the environment to check upgrade for, in the form:
        "projects/{projectId}/locations/{locationId}/environments/{environmentId}"
content - the CheckUpgradeRequest
Returns:
the request
Throws:
IOException








create
public CloudComposer.Projects.Locations.Environments.Create create(String parent,
                                                                   Environment content)
                                                            throws IOException
Create a new environment.

 Create a request for the method "environments.create".

 This request holds the parameters needed by the composer server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
parent - The parent must be of the form "projects/{projectId}/locations/{locationId}".
content - the Environment
Returns:
the request
Throws:
IOException








databaseFailover
public CloudComposer.Projects.Locations.Environments.DatabaseFailover databaseFailover(String environment,
                                                                                       DatabaseFailoverRequest content)
                                                                                throws IOException
Triggers database failover (only for highly resilient environments).

 Create a request for the method "environments.databaseFailover".

 This request holds the parameters needed by the composer server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
environment - Target environment: "projects/{projectId}/locations/{locationId}/environments/{environmentId}"
content - the DatabaseFailoverRequest
Returns:
the request
Throws:
IOException








delete
public CloudComposer.Projects.Locations.Environments.Delete delete(String name)
                                                            throws IOException
Delete an environment.

 Create a request for the method "environments.delete".

 This request holds the parameters needed by the composer server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
name - The environment to delete, in the form:
        "projects/{projectId}/locations/{locationId}/environments/{environmentId}"
Returns:
the request
Throws:
IOException








executeAirflowCommand
public CloudComposer.Projects.Locations.Environments.ExecuteAirflowCommand executeAirflowCommand(String environment,
                                                                                                 ExecuteAirflowCommandRequest content)
                                                                                          throws IOException
Executes Airflow CLI command.

 Create a request for the method "environments.executeAirflowCommand".

 This request holds the parameters needed by the composer server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote
 operation.

Parameters:
environment - The resource name of the environment in the form:
        "projects/{projectId}/locations/{locationId}/environments/{environmentId}".
content - the ExecuteAirflowCommandRequest
Returns:
the request
Throws:
IOException








fetchDatabaseProperties
public CloudComposer.Projects.Locations.Environments.FetchDatabaseProperties fetchDatabaseProperties(String environment)
                                                                                              throws IOException
Fetches database properties.

 Create a request for the method "environments.fetchDatabaseProperties".

 This request holds the parameters needed by the composer server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote
 operation.

Parameters:
environment - Required. The resource name of the environment, in the form:
        "projects/{projectId}/locations/{locationId}/environments/{environmentId}"
Returns:
the request
Throws:
IOException








get
public CloudComposer.Projects.Locations.Environments.Get get(String name)
                                                      throws IOException
Get an existing environment.

 Create a request for the method "environments.get".

 This request holds the parameters needed by the composer server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
name - The resource name of the environment to get, in the form:
        "projects/{projectId}/locations/{locationId}/environments/{environmentId}"
Returns:
the request
Throws:
IOException








list
public CloudComposer.Projects.Locations.Environments.List list(String parent)
                                                        throws IOException
List environments.

 Create a request for the method "environments.list".

 This request holds the parameters needed by the composer server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
parent - List environments in the given project and location, in the form:
        "projects/{projectId}/locations/{locationId}"
Returns:
the request
Throws:
IOException








loadSnapshot
public CloudComposer.Projects.Locations.Environments.LoadSnapshot loadSnapshot(String environment,
                                                                               LoadSnapshotRequest content)
                                                                        throws IOException
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.

 Create a request for the method "environments.loadSnapshot".

 This request holds the parameters needed by the composer server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
environment - The resource name of the target environment in the form:
        "projects/{projectId}/locations/{locationId}/environments/{environmentId}"
content - the LoadSnapshotRequest
Returns:
the request
Throws:
IOException








patch
public CloudComposer.Projects.Locations.Environments.Patch patch(String name,
                                                                 Environment content)
                                                          throws IOException
Update an environment.

 Create a request for the method "environments.patch".

 This request holds the parameters needed by the composer server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
name - The relative resource name of the environment to update, in the form:
        "projects/{projectId}/locations/{locationId}/environments/{environmentId}"
content - the Environment
Returns:
the request
Throws:
IOException








pollAirflowCommand
public CloudComposer.Projects.Locations.Environments.PollAirflowCommand pollAirflowCommand(String environment,
                                                                                           PollAirflowCommandRequest content)
                                                                                    throws IOException
Polls Airflow CLI command execution and fetches logs.

 Create a request for the method "environments.pollAirflowCommand".

 This request holds the parameters needed by the composer server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
environment - The resource name of the environment in the form:
        "projects/{projectId}/locations/{locationId}/environments/{environmentId}"
content - the PollAirflowCommandRequest
Returns:
the request
Throws:
IOException








saveSnapshot
public CloudComposer.Projects.Locations.Environments.SaveSnapshot saveSnapshot(String environment,
                                                                               SaveSnapshotRequest content)
                                                                        throws IOException
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.

 Create a request for the method "environments.saveSnapshot".

 This request holds the parameters needed by the composer server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
environment - The resource name of the source environment in the form:
        "projects/{projectId}/locations/{locationId}/environments/{environmentId}"
content - the SaveSnapshotRequest
Returns:
the request
Throws:
IOException








stopAirflowCommand
public CloudComposer.Projects.Locations.Environments.StopAirflowCommand stopAirflowCommand(String environment,
                                                                                           StopAirflowCommandRequest content)
                                                                                    throws IOException
Stops Airflow CLI command execution.

 Create a request for the method "environments.stopAirflowCommand".

 This request holds the parameters needed by the composer server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
environment - The resource name of the environment in the form:
        "projects/{projectId}/locations/{locationId}/environments/{environmentId}".
content - the StopAirflowCommandRequest
Returns:
the request
Throws:
IOException








userWorkloadsConfigMaps
public CloudComposer.Projects.Locations.Environments.UserWorkloadsConfigMaps userWorkloadsConfigMaps()
An accessor for creating requests from the UserWorkloadsConfigMaps collection.

 
The typical use is:
 
    CloudComposer composer = new CloudComposer(...);
    CloudComposer.UserWorkloadsConfigMaps.List request = composer.userWorkloadsConfigMaps().list(parameters ...)
 

Returns:
the resource collection








userWorkloadsSecrets
public CloudComposer.Projects.Locations.Environments.UserWorkloadsSecrets userWorkloadsSecrets()
An accessor for creating requests from the UserWorkloadsSecrets collection.

 
The typical use is:
 
    CloudComposer composer = new CloudComposer(...);
    CloudComposer.UserWorkloadsSecrets.List request = composer.userWorkloadsSecrets().list(parameters ...)
 

Returns:
the resource collection








workloads
public CloudComposer.Projects.Locations.Environments.Workloads workloads()
An accessor for creating requests from the Workloads collection.

 
The typical use is:
 
    CloudComposer composer = new CloudComposer(...);
    CloudComposer.Workloads.List request = composer.workloads().list(parameters ...)
 

Returns:
the resource collection














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2011–2024 Google. All rights reserved.