Skip to content

Commit

Permalink
feat(composer): update the api
Browse files Browse the repository at this point in the history
#### composer:v1

The following keys were added:
- schemas.CloudDataLineageIntegration (Total Keys: 3)
- schemas.DataRetentionConfig (Total Keys: 3)
- schemas.EnvironmentConfig.properties.dataRetentionConfig.$ref (Total Keys: 1)
- schemas.SoftwareConfig.properties.cloudDataLineageIntegration.$ref (Total Keys: 1)
- schemas.TaskLogsRetentionConfig (Total Keys: 3)

#### composer:v1beta1

The following keys were added:
- schemas.DataRetentionConfig (Total Keys: 3)
- schemas.EnvironmentConfig.properties.dataRetentionConfig.$ref (Total Keys: 1)
- schemas.TaskLogsRetentionConfig (Total Keys: 3)
  • Loading branch information
yoshi-automation committed Jan 16, 2024
1 parent 43f6df0 commit 2508494
Show file tree
Hide file tree
Showing 4 changed files with 141 additions and 2 deletions.
32 changes: 32 additions & 0 deletions docs/dyn/composer_v1.projects.locations.environments.html
Original file line number Diff line number Diff line change
Expand Up @@ -136,6 +136,11 @@ <h3>Method Details</h3>
&quot;airflowByoidUri&quot;: &quot;A String&quot;, # Output only. The &#x27;bring your own identity&#x27; variant of the URI of the Apache Airflow Web UI hosted within this environment, to be accessed with external identities using workforce identity federation (see [Access environments with workforce identity federation](/composer/docs/composer-2/access-environments-with-workforce-identity-federation)).
&quot;airflowUri&quot;: &quot;A String&quot;, # Output only. The URI of the Apache Airflow Web UI hosted within this environment (see [Airflow web interface](/composer/docs/how-to/accessing/airflow-web-interface)).
&quot;dagGcsPrefix&quot;: &quot;A String&quot;, # Output only. The Cloud Storage prefix of the DAGs for this environment. Although Cloud Storage objects reside in a flat namespace, a hierarchical file tree can be simulated using &quot;/&quot;-delimited object name prefixes. DAG objects for this environment reside in a simulated directory with the given prefix.
&quot;dataRetentionConfig&quot;: { # The configuration setting for Airflow database data retention mechanism. # Optional. The configuration setting for Airflow database data retention mechanism.
&quot;taskLogsRetentionConfig&quot;: { # The configuration setting for Task Logs. # Optional. The configuration settings for task logs retention
&quot;storageMode&quot;: &quot;A String&quot;, # Optional. The mode of storage for Airflow workers task logs. For details, see go/composer-store-task-logs-in-cloud-logging-only-design-doc
},
},
&quot;databaseConfig&quot;: { # The configuration of Cloud SQL instance that is used by the Apache Airflow software. # Optional. The configuration settings for Cloud SQL instance used internally by Apache Airflow software.
&quot;machineType&quot;: &quot;A String&quot;, # Optional. 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. If not specified, db-n1-standard-2 will be used. Supported for Cloud Composer environments in versions composer-1.*.*-airflow-*.*.*.
&quot;zone&quot;: &quot;A String&quot;, # Optional. The Compute Engine zone where the Airflow database is created. If zone is provided, it must be in the region selected for the environment. If zone is not provided, a zone is automatically selected. The zone can only be set during environment creation. Supported for Cloud Composer environments in versions composer-2.*.*-airflow-*.*.*.
Expand Down Expand Up @@ -213,6 +218,9 @@ <h3>Method Details</h3>
&quot;airflowConfigOverrides&quot;: { # Optional. Apache Airflow configuration properties to override. Property keys contain the section and property names, separated by a hyphen, for example &quot;core-dags_are_paused_at_creation&quot;. Section names must not contain hyphens (&quot;-&quot;), opening square brackets (&quot;[&quot;), or closing square brackets (&quot;]&quot;). The property name must not be empty and must not contain an equals sign (&quot;=&quot;) or semicolon (&quot;;&quot;). Section and property names must not contain a period (&quot;.&quot;). Apache Airflow configuration property names must be written in [snake_case](https://en.wikipedia.org/wiki/Snake_case). Property values can contain any character, and can be written in any lower/upper case format. Certain Apache Airflow configuration property values are [blocked](/composer/docs/concepts/airflow-configurations), and cannot be overridden.
&quot;a_key&quot;: &quot;A String&quot;,
},
&quot;cloudDataLineageIntegration&quot;: { # Configuration for Cloud Data Lineage integration. # Optional. The configuration for Cloud Data Lineage integration.
&quot;enabled&quot;: True or False, # Optional. Whether or not Cloud Data Lineage integration is enabled.
},
&quot;envVariables&quot;: { # Optional. Additional environment variables to provide to the Apache Airflow scheduler, worker, and webserver processes. Environment variable names must match the regular expression `a-zA-Z_*`. They cannot specify Apache Airflow software configuration overrides (they cannot match the regular expression `AIRFLOW__[A-Z0-9_]+__[A-Z0-9_]+`), and they cannot match any of the following reserved names: * `AIRFLOW_HOME` * `C_FORCE_ROOT` * `CONTAINER_NAME` * `DAGS_FOLDER` * `GCP_PROJECT` * `GCS_BUCKET` * `GKE_CLUSTER_NAME` * `SQL_DATABASE` * `SQL_INSTANCE` * `SQL_PASSWORD` * `SQL_PROJECT` * `SQL_REGION` * `SQL_USER`
&quot;a_key&quot;: &quot;A String&quot;,
},
Expand Down Expand Up @@ -452,6 +460,11 @@ <h3>Method Details</h3>
&quot;airflowByoidUri&quot;: &quot;A String&quot;, # Output only. The &#x27;bring your own identity&#x27; variant of the URI of the Apache Airflow Web UI hosted within this environment, to be accessed with external identities using workforce identity federation (see [Access environments with workforce identity federation](/composer/docs/composer-2/access-environments-with-workforce-identity-federation)).
&quot;airflowUri&quot;: &quot;A String&quot;, # Output only. The URI of the Apache Airflow Web UI hosted within this environment (see [Airflow web interface](/composer/docs/how-to/accessing/airflow-web-interface)).
&quot;dagGcsPrefix&quot;: &quot;A String&quot;, # Output only. The Cloud Storage prefix of the DAGs for this environment. Although Cloud Storage objects reside in a flat namespace, a hierarchical file tree can be simulated using &quot;/&quot;-delimited object name prefixes. DAG objects for this environment reside in a simulated directory with the given prefix.
&quot;dataRetentionConfig&quot;: { # The configuration setting for Airflow database data retention mechanism. # Optional. The configuration setting for Airflow database data retention mechanism.
&quot;taskLogsRetentionConfig&quot;: { # The configuration setting for Task Logs. # Optional. The configuration settings for task logs retention
&quot;storageMode&quot;: &quot;A String&quot;, # Optional. The mode of storage for Airflow workers task logs. For details, see go/composer-store-task-logs-in-cloud-logging-only-design-doc
},
},
&quot;databaseConfig&quot;: { # The configuration of Cloud SQL instance that is used by the Apache Airflow software. # Optional. The configuration settings for Cloud SQL instance used internally by Apache Airflow software.
&quot;machineType&quot;: &quot;A String&quot;, # Optional. 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. If not specified, db-n1-standard-2 will be used. Supported for Cloud Composer environments in versions composer-1.*.*-airflow-*.*.*.
&quot;zone&quot;: &quot;A String&quot;, # Optional. The Compute Engine zone where the Airflow database is created. If zone is provided, it must be in the region selected for the environment. If zone is not provided, a zone is automatically selected. The zone can only be set during environment creation. Supported for Cloud Composer environments in versions composer-2.*.*-airflow-*.*.*.
Expand Down Expand Up @@ -529,6 +542,9 @@ <h3>Method Details</h3>
&quot;airflowConfigOverrides&quot;: { # Optional. Apache Airflow configuration properties to override. Property keys contain the section and property names, separated by a hyphen, for example &quot;core-dags_are_paused_at_creation&quot;. Section names must not contain hyphens (&quot;-&quot;), opening square brackets (&quot;[&quot;), or closing square brackets (&quot;]&quot;). The property name must not be empty and must not contain an equals sign (&quot;=&quot;) or semicolon (&quot;;&quot;). Section and property names must not contain a period (&quot;.&quot;). Apache Airflow configuration property names must be written in [snake_case](https://en.wikipedia.org/wiki/Snake_case). Property values can contain any character, and can be written in any lower/upper case format. Certain Apache Airflow configuration property values are [blocked](/composer/docs/concepts/airflow-configurations), and cannot be overridden.
&quot;a_key&quot;: &quot;A String&quot;,
},
&quot;cloudDataLineageIntegration&quot;: { # Configuration for Cloud Data Lineage integration. # Optional. The configuration for Cloud Data Lineage integration.
&quot;enabled&quot;: True or False, # Optional. Whether or not Cloud Data Lineage integration is enabled.
},
&quot;envVariables&quot;: { # Optional. Additional environment variables to provide to the Apache Airflow scheduler, worker, and webserver processes. Environment variable names must match the regular expression `a-zA-Z_*`. They cannot specify Apache Airflow software configuration overrides (they cannot match the regular expression `AIRFLOW__[A-Z0-9_]+__[A-Z0-9_]+`), and they cannot match any of the following reserved names: * `AIRFLOW_HOME` * `C_FORCE_ROOT` * `CONTAINER_NAME` * `DAGS_FOLDER` * `GCP_PROJECT` * `GCS_BUCKET` * `GKE_CLUSTER_NAME` * `SQL_DATABASE` * `SQL_INSTANCE` * `SQL_PASSWORD` * `SQL_PROJECT` * `SQL_REGION` * `SQL_USER`
&quot;a_key&quot;: &quot;A String&quot;,
},
Expand Down Expand Up @@ -614,6 +630,11 @@ <h3>Method Details</h3>
&quot;airflowByoidUri&quot;: &quot;A String&quot;, # Output only. The &#x27;bring your own identity&#x27; variant of the URI of the Apache Airflow Web UI hosted within this environment, to be accessed with external identities using workforce identity federation (see [Access environments with workforce identity federation](/composer/docs/composer-2/access-environments-with-workforce-identity-federation)).
&quot;airflowUri&quot;: &quot;A String&quot;, # Output only. The URI of the Apache Airflow Web UI hosted within this environment (see [Airflow web interface](/composer/docs/how-to/accessing/airflow-web-interface)).
&quot;dagGcsPrefix&quot;: &quot;A String&quot;, # Output only. The Cloud Storage prefix of the DAGs for this environment. Although Cloud Storage objects reside in a flat namespace, a hierarchical file tree can be simulated using &quot;/&quot;-delimited object name prefixes. DAG objects for this environment reside in a simulated directory with the given prefix.
&quot;dataRetentionConfig&quot;: { # The configuration setting for Airflow database data retention mechanism. # Optional. The configuration setting for Airflow database data retention mechanism.
&quot;taskLogsRetentionConfig&quot;: { # The configuration setting for Task Logs. # Optional. The configuration settings for task logs retention
&quot;storageMode&quot;: &quot;A String&quot;, # Optional. The mode of storage for Airflow workers task logs. For details, see go/composer-store-task-logs-in-cloud-logging-only-design-doc
},
},
&quot;databaseConfig&quot;: { # The configuration of Cloud SQL instance that is used by the Apache Airflow software. # Optional. The configuration settings for Cloud SQL instance used internally by Apache Airflow software.
&quot;machineType&quot;: &quot;A String&quot;, # Optional. 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. If not specified, db-n1-standard-2 will be used. Supported for Cloud Composer environments in versions composer-1.*.*-airflow-*.*.*.
&quot;zone&quot;: &quot;A String&quot;, # Optional. The Compute Engine zone where the Airflow database is created. If zone is provided, it must be in the region selected for the environment. If zone is not provided, a zone is automatically selected. The zone can only be set during environment creation. Supported for Cloud Composer environments in versions composer-2.*.*-airflow-*.*.*.
Expand Down Expand Up @@ -691,6 +712,9 @@ <h3>Method Details</h3>
&quot;airflowConfigOverrides&quot;: { # Optional. Apache Airflow configuration properties to override. Property keys contain the section and property names, separated by a hyphen, for example &quot;core-dags_are_paused_at_creation&quot;. Section names must not contain hyphens (&quot;-&quot;), opening square brackets (&quot;[&quot;), or closing square brackets (&quot;]&quot;). The property name must not be empty and must not contain an equals sign (&quot;=&quot;) or semicolon (&quot;;&quot;). Section and property names must not contain a period (&quot;.&quot;). Apache Airflow configuration property names must be written in [snake_case](https://en.wikipedia.org/wiki/Snake_case). Property values can contain any character, and can be written in any lower/upper case format. Certain Apache Airflow configuration property values are [blocked](/composer/docs/concepts/airflow-configurations), and cannot be overridden.
&quot;a_key&quot;: &quot;A String&quot;,
},
&quot;cloudDataLineageIntegration&quot;: { # Configuration for Cloud Data Lineage integration. # Optional. The configuration for Cloud Data Lineage integration.
&quot;enabled&quot;: True or False, # Optional. Whether or not Cloud Data Lineage integration is enabled.
},
&quot;envVariables&quot;: { # Optional. Additional environment variables to provide to the Apache Airflow scheduler, worker, and webserver processes. Environment variable names must match the regular expression `a-zA-Z_*`. They cannot specify Apache Airflow software configuration overrides (they cannot match the regular expression `AIRFLOW__[A-Z0-9_]+__[A-Z0-9_]+`), and they cannot match any of the following reserved names: * `AIRFLOW_HOME` * `C_FORCE_ROOT` * `CONTAINER_NAME` * `DAGS_FOLDER` * `GCP_PROJECT` * `GCS_BUCKET` * `GKE_CLUSTER_NAME` * `SQL_DATABASE` * `SQL_INSTANCE` * `SQL_PASSWORD` * `SQL_PROJECT` * `SQL_REGION` * `SQL_USER`
&quot;a_key&quot;: &quot;A String&quot;,
},
Expand Down Expand Up @@ -830,6 +854,11 @@ <h3>Method Details</h3>
&quot;airflowByoidUri&quot;: &quot;A String&quot;, # Output only. The &#x27;bring your own identity&#x27; variant of the URI of the Apache Airflow Web UI hosted within this environment, to be accessed with external identities using workforce identity federation (see [Access environments with workforce identity federation](/composer/docs/composer-2/access-environments-with-workforce-identity-federation)).
&quot;airflowUri&quot;: &quot;A String&quot;, # Output only. The URI of the Apache Airflow Web UI hosted within this environment (see [Airflow web interface](/composer/docs/how-to/accessing/airflow-web-interface)).
&quot;dagGcsPrefix&quot;: &quot;A String&quot;, # Output only. The Cloud Storage prefix of the DAGs for this environment. Although Cloud Storage objects reside in a flat namespace, a hierarchical file tree can be simulated using &quot;/&quot;-delimited object name prefixes. DAG objects for this environment reside in a simulated directory with the given prefix.
&quot;dataRetentionConfig&quot;: { # The configuration setting for Airflow database data retention mechanism. # Optional. The configuration setting for Airflow database data retention mechanism.
&quot;taskLogsRetentionConfig&quot;: { # The configuration setting for Task Logs. # Optional. The configuration settings for task logs retention
&quot;storageMode&quot;: &quot;A String&quot;, # Optional. The mode of storage for Airflow workers task logs. For details, see go/composer-store-task-logs-in-cloud-logging-only-design-doc
},
},
&quot;databaseConfig&quot;: { # The configuration of Cloud SQL instance that is used by the Apache Airflow software. # Optional. The configuration settings for Cloud SQL instance used internally by Apache Airflow software.
&quot;machineType&quot;: &quot;A String&quot;, # Optional. 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. If not specified, db-n1-standard-2 will be used. Supported for Cloud Composer environments in versions composer-1.*.*-airflow-*.*.*.
&quot;zone&quot;: &quot;A String&quot;, # Optional. The Compute Engine zone where the Airflow database is created. If zone is provided, it must be in the region selected for the environment. If zone is not provided, a zone is automatically selected. The zone can only be set during environment creation. Supported for Cloud Composer environments in versions composer-2.*.*-airflow-*.*.*.
Expand Down Expand Up @@ -907,6 +936,9 @@ <h3>Method Details</h3>
&quot;airflowConfigOverrides&quot;: { # Optional. Apache Airflow configuration properties to override. Property keys contain the section and property names, separated by a hyphen, for example &quot;core-dags_are_paused_at_creation&quot;. Section names must not contain hyphens (&quot;-&quot;), opening square brackets (&quot;[&quot;), or closing square brackets (&quot;]&quot;). The property name must not be empty and must not contain an equals sign (&quot;=&quot;) or semicolon (&quot;;&quot;). Section and property names must not contain a period (&quot;.&quot;). Apache Airflow configuration property names must be written in [snake_case](https://en.wikipedia.org/wiki/Snake_case). Property values can contain any character, and can be written in any lower/upper case format. Certain Apache Airflow configuration property values are [blocked](/composer/docs/concepts/airflow-configurations), and cannot be overridden.
&quot;a_key&quot;: &quot;A String&quot;,
},
&quot;cloudDataLineageIntegration&quot;: { # Configuration for Cloud Data Lineage integration. # Optional. The configuration for Cloud Data Lineage integration.
&quot;enabled&quot;: True or False, # Optional. Whether or not Cloud Data Lineage integration is enabled.
},
&quot;envVariables&quot;: { # Optional. Additional environment variables to provide to the Apache Airflow scheduler, worker, and webserver processes. Environment variable names must match the regular expression `a-zA-Z_*`. They cannot specify Apache Airflow software configuration overrides (they cannot match the regular expression `AIRFLOW__[A-Z0-9_]+__[A-Z0-9_]+`), and they cannot match any of the following reserved names: * `AIRFLOW_HOME` * `C_FORCE_ROOT` * `CONTAINER_NAME` * `DAGS_FOLDER` * `GCP_PROJECT` * `GCS_BUCKET` * `GKE_CLUSTER_NAME` * `SQL_DATABASE` * `SQL_INSTANCE` * `SQL_PASSWORD` * `SQL_PROJECT` * `SQL_REGION` * `SQL_USER`
&quot;a_key&quot;: &quot;A String&quot;,
},
Expand Down

0 comments on commit 2508494

Please sign in to comment.