Service doublecloud.airflow.v1.ClusterService

Get

Returns the specified Apache Airflow® cluster.

Request

Field	Description
`cluster_id`	string ID of the Apache Airflow® cluster resource to return.
`sensitive`	bool Whether to include sensitive data in the response. If unspecified, defaults to false.

Response

Field	Description
`id`	string ID of the Apache Airflow® cluster.
`project_id`	string ID of the project that the Apache Airflow® cluster belongs to.
`cloud_type`	string Type of the cloud where instances should be hosted.
`region_id`	string ID of the region to place instances.
`create_time`	google.protobuf.Timestamp Creation timestamp.
`name`	string Name of the Apache Airflow® cluster. The name is unique within the project.
`description`	string Description of the Apache Airflow® cluster.
`status`	doublecloud.v1.ClusterStatus Current state of the cluster.
`resources`	doublecloud.airflow.v1.ClusterResources Resources allocated to Airflow cluster
`connection_info`	doublecloud.airflow.v1.ConnectionInfo Connection information.
`access`	doublecloud.v1.Access External network access settings
`config`	doublecloud.airflow.v1.AirflowConfig Configuration of the Apache Airflow® cluster.
`network_id`	string ID of the network that the Apache Airflow® cluster belongs to.
`maintenance_window`	doublecloud.v1.MaintenanceWindow Window of maintenance operations.
`cr_connection_info`	doublecloud.airflow.v1.CrConnectionInfo Custom images remote image path and credentials.
`managed_image_status`	doublecloud.airflow.v1.ManagedImageStatus Status of managed image.

List

Retrieves a list of Apache Airflow® clusters that belong to the specified project.

Request

Field	Description
`project_id`	string ID of the project to list Apache Airflow® clusters in.
`paging`	doublecloud.v1.Paging Paging information of the request
`view`	doublecloud.airflow.v1.ClusterView The level of detail to be returned. If unspecified, defaults to CLUSTER_VIEW_BASIC.

Response

Field	Description
`clusters`	list List of Apache Airflow® cluster resources.
`clusters[]`	doublecloud.airflow.v1.Cluster
`next_page`	doublecloud.v1.NextPage Pagination information of the response

Create

Creates an Apache Airflow® cluster in the specified project.

Request

Field	Description
`project_id`	string ID of the project to create the Apache Airflow® cluster in.
`cloud_type`	string Type of the cloud where instances should be hosted.
`region_id`	string ID of the region to place instances.
`name`	string Name of the Apache Airflow® cluster. The name must be unique within the project.
`description`	string Description of the Apache Airflow® cluster.
`resources`	doublecloud.airflow.v1.ClusterResources Resources allocated to the Apache Airflow® cluster.
`access`	doublecloud.v1.Access External network access settings
`config`	doublecloud.airflow.v1.CreateClusterRequest.AirflowConfig
`network_id`	string ID of the network that the Apache Airflow® cluster belongs to.
`maintenance_window`	doublecloud.v1.MaintenanceWindow Window of maintenance operations.

Response

Field	Description
`id`	string ID of the operation.
`project_id`	string ID of the project where operation performed.
`description`	string Description of the operation.
`created_by`	string ID of the user or service account who initiated the operation.
`metadata`	list Operation metadata (e.g. cluster_id for create cluster operation).
`metadata[]`	doublecloud.v1.Operation.MetadataEntry
`create_time`	google.protobuf.Timestamp The time when the operation was created.
`start_time`	google.protobuf.Timestamp The time when the operation was started.
`finish_time`	google.protobuf.Timestamp The time when the operation was finished.
`status`	doublecloud.v1.Operation.Status The status of the operation.
`error`	google.rpc.Status The error result of the operation in case of failure or cancellation.
`resource_id`	string ID of the resource operation performed on.

Delete

Deletes the specified Apache Airflow® cluster.

Request

Field	Description
`cluster_id`	string ID of the Apache Airflow® cluster to delete. To get the Apache Airflow® cluster ID, use a [ClusterService.List] request.

Response

Field	Description
`id`	string ID of the operation.
`project_id`	string ID of the project where operation performed.
`description`	string Description of the operation.
`created_by`	string ID of the user or service account who initiated the operation.
`metadata`	list Operation metadata (e.g. cluster_id for create cluster operation).
`metadata[]`	doublecloud.v1.Operation.MetadataEntry
`create_time`	google.protobuf.Timestamp The time when the operation was created.
`start_time`	google.protobuf.Timestamp The time when the operation was started.
`finish_time`	google.protobuf.Timestamp The time when the operation was finished.
`status`	doublecloud.v1.Operation.Status The status of the operation.
`error`	google.rpc.Status The error result of the operation in case of failure or cancellation.
`resource_id`	string ID of the resource operation performed on.

Update

Updates the specified Apache Airflow® cluster.

Request

Field	Description
`cluster_id`	string ID of the Apache Airflow® Cluster resource to update. To get the Apache Airflow® cluster ID, use a [ClusterService.List] request.
`description`	google.protobuf.StringValue New description of the Apache Airflow® cluster.
`resources`	doublecloud.airflow.v1.UpdateClusterRequest.UpdateClusterResources New resources allocated to the Apache Airflow® cluster.
`access`	doublecloud.v1.Access Access settings
`maintenance_window`	doublecloud.v1.MaintenanceWindow Window of maintenance operations.
`config`	doublecloud.airflow.v1.UpdateClusterRequest.UpdateAirflowConfig Configuration and resources for hosts that should be created for the Apache Airflow® cluster.
`name`	google.protobuf.StringValue New name of the Apache Airflow® cluster.

Response

Field	Description
`id`	string ID of the operation.
`project_id`	string ID of the project where operation performed.
`description`	string Description of the operation.
`created_by`	string ID of the user or service account who initiated the operation.
`metadata`	list Operation metadata (e.g. cluster_id for create cluster operation).
`metadata[]`	doublecloud.v1.Operation.MetadataEntry
`create_time`	google.protobuf.Timestamp The time when the operation was created.
`start_time`	google.protobuf.Timestamp The time when the operation was started.
`finish_time`	google.protobuf.Timestamp The time when the operation was finished.
`status`	doublecloud.v1.Operation.Status The status of the operation.
`error`	google.rpc.Status The error result of the operation in case of failure or cancellation.
`resource_id`	string ID of the resource operation performed on.

ListOperations

List cluster operations.

Request

Field	Description
`cluster_id`	string Required. ID of the cluster.
`paging`	doublecloud.v1.Paging Paging information of the request

Response

Field	Description
`operations`	list
`operations[]`	doublecloud.v1.Operation
`next_page`	doublecloud.v1.NextPage Pagination information of the response

RescheduleMaintenance

Reschedule planned maintenance operation.

Request

Field	Description
`cluster_id`	string Required. ID of the Airflow cluster to maintenance reschedule.
`reschedule_type`	doublecloud.v1.RescheduleType Required. The type of reschedule request.
`delayed_until_time`	google.protobuf.Timestamp The time for SPECIFIC_TIME reschedule. Limited by two weeks since first time scheduled.

Response

Field	Description
`id`	string ID of the operation.
`project_id`	string ID of the project where operation performed.
`description`	string Description of the operation.
`created_by`	string ID of the user or service account who initiated the operation.
`metadata`	list Operation metadata (e.g. cluster_id for create cluster operation).
`metadata[]`	doublecloud.v1.Operation.MetadataEntry
`create_time`	google.protobuf.Timestamp The time when the operation was created.
`start_time`	google.protobuf.Timestamp The time when the operation was started.
`finish_time`	google.protobuf.Timestamp The time when the operation was finished.
`status`	doublecloud.v1.Operation.Status The status of the operation.
`error`	google.rpc.Status The error result of the operation in case of failure or cancellation.
`resource_id`	string ID of the resource operation performed on.

ListCustomImages

List of custom images associated to the cluster

Request

Field	Description
`cluster_id`	string ID of the Apache Airflow® cluster.

Response

Field	Description
`custom_images`	list List of custom images associated with the cluster.
`custom_images[]`	doublecloud.airflow.v1.CustomImage

Overview

OperationService