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.AirflowMetadataRetentionPolicyConfig (Total Keys: 5)
- schemas.DataRetentionConfig.properties.airflowMetadataRetentionConfig.$ref (Total Keys: 1)

#### composer:v1beta1

The following keys were added:
- schemas.AirflowMetadataRetentionPolicyConfig (Total Keys: 5)
- schemas.DataRetentionConfig.properties.airflowDatabaseRetentionDays (Total Keys: 3)
- schemas.DataRetentionConfig.properties.airflowMetadataRetentionConfig.$ref (Total Keys: 1)
  • Loading branch information
yoshi-automation committed Mar 5, 2024
1 parent 359fa99 commit 1aa161c
Show file tree
Hide file tree
Showing 4 changed files with 104 additions and 2 deletions.
16 changes: 16 additions & 0 deletions docs/dyn/composer_v1.projects.locations.environments.html
Original file line number Diff line number Diff line change
Expand Up @@ -152,6 +152,10 @@ <h3>Method Details</h3>
&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;airflowMetadataRetentionConfig&quot;: { # The policy for airflow metadata database retention. # Optional. The retention policy for airflow metadata database. Details: go/composer-database-retention-2
&quot;retentionDays&quot;: 42, # Optional. How many days data should be retained for.
&quot;retentionMode&quot;: &quot;A String&quot;, # Optional. Retention can be either enabled or disabled.
},
&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
},
Expand Down Expand Up @@ -486,6 +490,10 @@ <h3>Method Details</h3>
&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;airflowMetadataRetentionConfig&quot;: { # The policy for airflow metadata database retention. # Optional. The retention policy for airflow metadata database. Details: go/composer-database-retention-2
&quot;retentionDays&quot;: 42, # Optional. How many days data should be retained for.
&quot;retentionMode&quot;: &quot;A String&quot;, # Optional. Retention can be either enabled or disabled.
},
&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
},
Expand Down Expand Up @@ -666,6 +674,10 @@ <h3>Method Details</h3>
&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;airflowMetadataRetentionConfig&quot;: { # The policy for airflow metadata database retention. # Optional. The retention policy for airflow metadata database. Details: go/composer-database-retention-2
&quot;retentionDays&quot;: 42, # Optional. How many days data should be retained for.
&quot;retentionMode&quot;: &quot;A String&quot;, # Optional. Retention can be either enabled or disabled.
},
&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
},
Expand Down Expand Up @@ -900,6 +912,10 @@ <h3>Method Details</h3>
&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;airflowMetadataRetentionConfig&quot;: { # The policy for airflow metadata database retention. # Optional. The retention policy for airflow metadata database. Details: go/composer-database-retention-2
&quot;retentionDays&quot;: 42, # Optional. How many days data should be retained for.
&quot;retentionMode&quot;: &quot;A String&quot;, # Optional. Retention can be either enabled or disabled.
},
&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
},
Expand Down
20 changes: 20 additions & 0 deletions docs/dyn/composer_v1beta1.projects.locations.environments.html
Original file line number Diff line number Diff line change
Expand Up @@ -200,6 +200,11 @@ <h3>Method Details</h3>
&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;airflowDatabaseRetentionDays&quot;: 42, # Optional. The number of days describing for how long to store event-based records in airflow database. If the retention mechanism is enabled this value must be a positive integer otherwise, value should be set to 0.
&quot;airflowMetadataRetentionConfig&quot;: { # The policy for airflow metadata database retention. # Optional. The retention policy for airflow metadata database.
&quot;retentionDays&quot;: 42, # Optional. How many days data should be retained for.
&quot;retentionMode&quot;: &quot;A String&quot;, # Optional. Retention can be either enabled or disabled.
},
&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
},
Expand Down Expand Up @@ -535,6 +540,11 @@ <h3>Method Details</h3>
&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;airflowDatabaseRetentionDays&quot;: 42, # Optional. The number of days describing for how long to store event-based records in airflow database. If the retention mechanism is enabled this value must be a positive integer otherwise, value should be set to 0.
&quot;airflowMetadataRetentionConfig&quot;: { # The policy for airflow metadata database retention. # Optional. The retention policy for airflow metadata database.
&quot;retentionDays&quot;: 42, # Optional. How many days data should be retained for.
&quot;retentionMode&quot;: &quot;A String&quot;, # Optional. Retention can be either enabled or disabled.
},
&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
},
Expand Down Expand Up @@ -716,6 +726,11 @@ <h3>Method Details</h3>
&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;airflowDatabaseRetentionDays&quot;: 42, # Optional. The number of days describing for how long to store event-based records in airflow database. If the retention mechanism is enabled this value must be a positive integer otherwise, value should be set to 0.
&quot;airflowMetadataRetentionConfig&quot;: { # The policy for airflow metadata database retention. # Optional. The retention policy for airflow metadata database.
&quot;retentionDays&quot;: 42, # Optional. How many days data should be retained for.
&quot;retentionMode&quot;: &quot;A String&quot;, # Optional. Retention can be either enabled or disabled.
},
&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
},
Expand Down Expand Up @@ -951,6 +966,11 @@ <h3>Method Details</h3>
&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;airflowDatabaseRetentionDays&quot;: 42, # Optional. The number of days describing for how long to store event-based records in airflow database. If the retention mechanism is enabled this value must be a positive integer otherwise, value should be set to 0.
&quot;airflowMetadataRetentionConfig&quot;: { # The policy for airflow metadata database retention. # Optional. The retention policy for airflow metadata database.
&quot;retentionDays&quot;: 42, # Optional. How many days data should be retained for.
&quot;retentionMode&quot;: &quot;A String&quot;, # Optional. Retention can be either enabled or disabled.
},
&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
},
Expand Down
32 changes: 31 additions & 1 deletion googleapiclient/discovery_cache/documents/composer.v1.json
Original file line number Diff line number Diff line change
Expand Up @@ -938,9 +938,35 @@
}
}
},
"revision": "20240221",
"revision": "20240227",
"rootUrl": "https://composer.googleapis.com/",
"schemas": {
"AirflowMetadataRetentionPolicyConfig": {
"description": "The policy for airflow metadata database retention.",
"id": "AirflowMetadataRetentionPolicyConfig",
"properties": {
"retentionDays": {
"description": "Optional. How many days data should be retained for.",
"format": "int32",
"type": "integer"
},
"retentionMode": {
"description": "Optional. Retention can be either enabled or disabled.",
"enum": [
"RETENTION_MODE_UNSPECIFIED",
"RETENTION_MODE_ENABLED",
"RETENTION_MODE_DISABLED"
],
"enumDescriptions": [
"Default mode doesn't change environment parameters.",
"Retention policy is enabled.",
"Retention policy is disabled."
],
"type": "string"
}
},
"type": "object"
},
"AllowedIpRange": {
"description": "Allowed IP range with user-provided description.",
"id": "AllowedIpRange",
Expand Down Expand Up @@ -1138,6 +1164,10 @@
"description": "The configuration setting for Airflow database data retention mechanism.",
"id": "DataRetentionConfig",
"properties": {
"airflowMetadataRetentionConfig": {
"$ref": "AirflowMetadataRetentionPolicyConfig",
"description": "Optional. The retention policy for airflow metadata database. Details: go/composer-database-retention-2"
},
"taskLogsRetentionConfig": {
"$ref": "TaskLogsRetentionConfig",
"description": "Optional. The configuration settings for task logs retention"
Expand Down
38 changes: 37 additions & 1 deletion googleapiclient/discovery_cache/documents/composer.v1beta1.json
Original file line number Diff line number Diff line change
Expand Up @@ -994,9 +994,35 @@
}
}
},
"revision": "20240221",
"revision": "20240227",
"rootUrl": "https://composer.googleapis.com/",
"schemas": {
"AirflowMetadataRetentionPolicyConfig": {
"description": "The policy for airflow metadata database retention.",
"id": "AirflowMetadataRetentionPolicyConfig",
"properties": {
"retentionDays": {
"description": "Optional. How many days data should be retained for.",
"format": "int32",
"type": "integer"
},
"retentionMode": {
"description": "Optional. Retention can be either enabled or disabled.",
"enum": [
"RETENTION_MODE_UNSPECIFIED",
"RETENTION_MODE_ENABLED",
"RETENTION_MODE_DISABLED"
],
"enumDescriptions": [
"Default mode doesn't change environment parameters.",
"Retention policy is enabled.",
"Retention policy is disabled."
],
"type": "string"
}
},
"type": "object"
},
"AllowedIpRange": {
"description": "Allowed IP range with user-provided description.",
"id": "AllowedIpRange",
Expand Down Expand Up @@ -1205,6 +1231,16 @@
"description": "The configuration setting for Airflow database data retention mechanism.",
"id": "DataRetentionConfig",
"properties": {
"airflowDatabaseRetentionDays": {
"deprecated": true,
"description": "Optional. The number of days describing for how long to store event-based records in airflow database. If the retention mechanism is enabled this value must be a positive integer otherwise, value should be set to 0.",
"format": "int32",
"type": "integer"
},
"airflowMetadataRetentionConfig": {
"$ref": "AirflowMetadataRetentionPolicyConfig",
"description": "Optional. The retention policy for airflow metadata database."
},
"taskLogsRetentionConfig": {
"$ref": "TaskLogsRetentionConfig",
"description": "Optional. The configuration settings for task logs retention"
Expand Down

0 comments on commit 1aa161c

Please sign in to comment.