feat(file): update the API

#### file:v1beta1 The following keys were added: - schemas.FixedIOPS.description - schemas.FixedIOPS.id - schemas.FixedIOPS.properties.maxReadIops.description - schemas.FixedIOPS.properties.maxReadIops.format - schemas.FixedIOPS.properties.maxReadIops.type - schemas.FixedIOPS.type - schemas.IOPSPerTB.description - schemas.IOPSPerTB.id - schemas.IOPSPerTB.properties.maxReadIopsPerTb.description - schemas.IOPSPerTB.properties.maxReadIopsPerTb.format - schemas.IOPSPerTB.properties.maxReadIopsPerTb.type - schemas.IOPSPerTB.type - schemas.Instance.properties.configurablePerformanceEnabled.description - schemas.Instance.properties.configurablePerformanceEnabled.readOnly - schemas.Instance.properties.configurablePerformanceEnabled.type - schemas.Instance.properties.deletionProtectionEnabled.description - schemas.Instance.properties.deletionProtectionEnabled.type - schemas.Instance.properties.deletionProtectionReason.description - schemas.Instance.properties.deletionProtectionReason.type - schemas.Instance.properties.performanceConfig.$ref - schemas.Instance.properties.performanceConfig.description - schemas.Instance.properties.performanceLimits.$ref - schemas.Instance.properties.performanceLimits.description - schemas.Instance.properties.performanceLimits.readOnly - schemas.PerformanceConfig.description - schemas.PerformanceConfig.id - schemas.PerformanceConfig.properties.fixedIops.$ref - schemas.PerformanceConfig.properties.fixedIops.description - schemas.PerformanceConfig.properties.iopsPerTb.$ref - schemas.PerformanceConfig.properties.iopsPerTb.description - schemas.PerformanceConfig.type - schemas.PerformanceLimits.description - schemas.PerformanceLimits.id - schemas.PerformanceLimits.properties.maxReadIops.description - schemas.PerformanceLimits.properties.maxReadIops.format - schemas.PerformanceLimits.properties.maxReadIops.readOnly - schemas.PerformanceLimits.properties.maxReadIops.type - schemas.PerformanceLimits.properties.maxReadThroughputBps.description - schemas.PerformanceLimits.properties.maxReadThroughputBps.format - schemas.PerformanceLimits.properties.maxReadThroughputBps.readOnly - schemas.PerformanceLimits.properties.maxReadThroughputBps.type - schemas.PerformanceLimits.properties.maxWriteIops.description - schemas.PerformanceLimits.properties.maxWriteIops.format - schemas.PerformanceLimits.properties.maxWriteIops.readOnly - schemas.PerformanceLimits.properties.maxWriteIops.type - schemas.PerformanceLimits.properties.maxWriteThroughputBps.description - schemas.PerformanceLimits.properties.maxWriteThroughputBps.format - schemas.PerformanceLimits.properties.maxWriteThroughputBps.readOnly - schemas.PerformanceLimits.properties.maxWriteThroughputBps.type - schemas.PerformanceLimits.type The following keys were changed: - resources.projects.resources.locations.resources.instances.methods.patch.parameters.updateMask.description - resources.projects.resources.locations.resources.instances.methods.promoteReplica.description - schemas.Backup.properties.tags.description - schemas.Instance.properties.replication.description - schemas.Instance.properties.tags.description - schemas.ManagedActiveDirectoryConfig.description - schemas.ManagedActiveDirectoryConfig.properties.computer.description - schemas.Replication.properties.replicas.description - schemas.Replication.properties.role.enumDescriptions - schemas.Snapshot.properties.tags.description #### file:v1 The following keys were added: - schemas.FixedIOPS.description - schemas.FixedIOPS.id - schemas.FixedIOPS.properties.maxReadIops.description - schemas.FixedIOPS.properties.maxReadIops.format - schemas.FixedIOPS.properties.maxReadIops.type - schemas.FixedIOPS.type - schemas.IOPSPerTB.description - schemas.IOPSPerTB.id - schemas.IOPSPerTB.properties.maxReadIopsPerTb.description - schemas.IOPSPerTB.properties.maxReadIopsPerTb.format - schemas.IOPSPerTB.properties.maxReadIopsPerTb.type - schemas.IOPSPerTB.type - schemas.Instance.properties.configurablePerformanceEnabled.description - schemas.Instance.properties.configurablePerformanceEnabled.readOnly - schemas.Instance.properties.configurablePerformanceEnabled.type - schemas.Instance.properties.performanceConfig.$ref - schemas.Instance.properties.performanceConfig.description - schemas.Instance.properties.performanceLimits.$ref - schemas.Instance.properties.performanceLimits.description - schemas.Instance.properties.performanceLimits.readOnly - schemas.PerformanceConfig.description - schemas.PerformanceConfig.id - schemas.PerformanceConfig.properties.fixedIops.$ref - schemas.PerformanceConfig.properties.fixedIops.description - schemas.PerformanceConfig.properties.iopsPerTb.$ref - schemas.PerformanceConfig.properties.iopsPerTb.description - schemas.PerformanceConfig.type - schemas.PerformanceLimits.description - schemas.PerformanceLimits.id - schemas.PerformanceLimits.properties.maxReadIops.description - schemas.PerformanceLimits.properties.maxReadIops.format - schemas.PerformanceLimits.properties.maxReadIops.readOnly - schemas.PerformanceLimits.properties.maxReadIops.type - schemas.PerformanceLimits.properties.maxReadThroughputBps.description - schemas.PerformanceLimits.properties.maxReadThroughputBps.format - schemas.PerformanceLimits.properties.maxReadThroughputBps.readOnly - schemas.PerformanceLimits.properties.maxReadThroughputBps.type - schemas.PerformanceLimits.properties.maxWriteIops.description - schemas.PerformanceLimits.properties.maxWriteIops.format - schemas.PerformanceLimits.properties.maxWriteIops.readOnly - schemas.PerformanceLimits.properties.maxWriteIops.type - schemas.PerformanceLimits.properties.maxWriteThroughputBps.description - schemas.PerformanceLimits.properties.maxWriteThroughputBps.format - schemas.PerformanceLimits.properties.maxWriteThroughputBps.readOnly - schemas.PerformanceLimits.properties.maxWriteThroughputBps.type - schemas.PerformanceLimits.type
googleapis · Oct 10, 2024 · 748b48e · 748b48e
1 parent a770614
commit 748b48e
Show file tree

Hide file tree

Showing 4 changed files with 334 additions and 22 deletions.
diff --git a/discovery/file-v1.json b/discovery/file-v1.json
@@ -902,7 +902,7 @@
       }
     }
   },
-  "revision": "20240821",
+  "revision": "20240905",
   "rootUrl": "https://file.googleapis.com/",
   "schemas": {
     "Backup": {
@@ -1140,6 +1140,18 @@
       },
       "type": "object"
     },
+    "FixedIOPS": {
+      "description": "Fixed IOPS (input/output operations per second) parameters.",
+      "id": "FixedIOPS",
+      "properties": {
+        "maxReadIops": {
+          "description": "Required. Maximum raw read IOPS.",
+          "format": "int64",
+          "type": "string"
+        }
+      },
+      "type": "object"
+    },
     "GoogleCloudSaasacceleratorManagementProvidersV1Instance": {
       "description": "Instance represents the interface for SLM services to actuate the state of control plane resources. Example Instance in JSON, where consumer-project-number=123456, producer-project-id=cloud-sql: ```json Instance: { \"name\": \"projects/123456/locations/us-east1/instances/prod-instance\", \"create_time\": { \"seconds\": 1526406431, }, \"labels\": { \"env\": \"prod\", \"foo\": \"bar\" }, \"state\": READY, \"software_versions\": { \"software_update\": \"cloud-sql-09-28-2018\", }, \"maintenance_policy_names\": { \"UpdatePolicy\": \"projects/123456/locations/us-east1/maintenancePolicies/prod-update-policy\", } \"tenant_project_id\": \"cloud-sql-test-tenant\", \"producer_metadata\": { \"cloud-sql-tier\": \"basic\", \"cloud-sql-instance-size\": \"1G\", }, \"provisioned_resources\": [ { \"resource-type\": \"compute-instance\", \"resource-url\": \"https://www.googleapis.com/compute/v1/projects/cloud-sql/zones/us-east1-b/instances/vm-1\", } ], \"maintenance_schedules\": { \"csa_rollout\": { \"start_time\": { \"seconds\": 1526406431, }, \"end_time\": { \"seconds\": 1535406431, }, }, \"ncsa_rollout\": { \"start_time\": { \"seconds\": 1526406431, }, \"end_time\": { \"seconds\": 1535406431, }, } }, \"consumer_defined_name\": \"my-sql-instance1\", } ``` LINT.IfChange",
       "id": "GoogleCloudSaasacceleratorManagementProvidersV1Instance",
@@ -1415,10 +1427,27 @@
       },
       "type": "object"
     },
+    "IOPSPerTB": {
+      "description": "IOPS per TB. Filestore defines TB as 1024^4 bytes (TiB).",
+      "id": "IOPSPerTB",
+      "properties": {
+        "maxReadIopsPerTb": {
+          "description": "Required. Maximum read IOPS per TiB.",
+          "format": "int64",
+          "type": "string"
+        }
+      },
+      "type": "object"
+    },
     "Instance": {
       "description": "A Filestore instance.",
       "id": "Instance",
       "properties": {
+        "configurablePerformanceEnabled": {
+          "description": "Output only. Indicates whether this instance's performance is configurable. If enabled, adjust it using the 'performance_config' field.",
+          "readOnly": true,
+          "type": "boolean"
+        },
         "createTime": {
           "description": "Output only. The time when the instance was created.",
           "format": "google-datetime",
@@ -1471,6 +1500,15 @@
           },
           "type": "array"
         },
+        "performanceConfig": {
+          "$ref": "PerformanceConfig",
+          "description": "Optional. Used to configure performance."
+        },
+        "performanceLimits": {
+          "$ref": "PerformanceLimits",
+          "description": "Output only. Used for getting performance limits.",
+          "readOnly": true
+        },
         "protocol": {
           "description": "Immutable. The protocol indicates the access protocol for all shares in the instance. This field is immutable and it cannot be changed after the instance has been created. Default value: `NFS_V3`.",
           "enum": [
@@ -1975,6 +2013,52 @@
       },
       "type": "object"
     },
+    "PerformanceConfig": {
+      "description": "Used for setting the performance configuration. If the user doesn't specify PerformanceConfig, automatically provision the default performance settings as described in https://cloud.google.com/filestore/docs/performance. Larger instances will be linearly set to more IOPS. If the instance's capacity is increased or decreased, its performance will be automatically adjusted upwards or downwards accordingly (respectively).",
+      "id": "PerformanceConfig",
+      "properties": {
+        "fixedIops": {
+          "$ref": "FixedIOPS",
+          "description": "Choose a fixed provisioned IOPS value for the instance, which will remain constant regardless of instance capacity. Value must be a multiple of 1000. If the chosen value is outside the supported range for the instance's capacity during instance creation, instance creation will fail with an `InvalidArgument` error. Similarly, if an instance capacity update would result in a value outside the supported range, the update will fail with an `InvalidArgument` error."
+        },
+        "iopsPerTb": {
+          "$ref": "IOPSPerTB",
+          "description": "Provision IOPS dynamically based on the capacity of the instance. Provisioned read IOPS will be calculated by multiplying the capacity of the instance in TiB by the `iops_per_tb` value. For example, for a 2 TiB instance with an `iops_per_tb` value of 17000 the provisioned read IOPS will be 34000. If the calculated value is outside the supported range for the instance's capacity during instance creation, instance creation will fail with an `InvalidArgument` error. Similarly, if an instance capacity update would result in a value outside the supported range, the update will fail with an `InvalidArgument` error."
+        }
+      },
+      "type": "object"
+    },
+    "PerformanceLimits": {
+      "description": "The enforced performance limits, calculated from the instance's performance configuration.",
+      "id": "PerformanceLimits",
+      "properties": {
+        "maxReadIops": {
+          "description": "Output only. The max read IOPS.",
+          "format": "int64",
+          "readOnly": true,
+          "type": "string"
+        },
+        "maxReadThroughputBps": {
+          "description": "Output only. The max read throughput in bytes per second.",
+          "format": "int64",
+          "readOnly": true,
+          "type": "string"
+        },
+        "maxWriteIops": {
+          "description": "Output only. The max write IOPS.",
+          "format": "int64",
+          "readOnly": true,
+          "type": "string"
+        },
+        "maxWriteThroughputBps": {
+          "description": "Output only. The max write throughput in bytes per second.",
+          "format": "int64",
+          "readOnly": true,
+          "type": "string"
+        }
+      },
+      "type": "object"
+    },
     "PromoteReplicaRequest": {
       "description": "PromoteReplicaRequest promotes a Filestore standby instance (replica).",
       "id": "PromoteReplicaRequest",

diff --git a/discovery/file-v1beta1.json b/discovery/file-v1beta1.json
@@ -502,7 +502,7 @@
                       "type": "string"
                     },
                     "updateMask": {
-                      "description": "Required. Mask of fields to update. At least one path must be supplied in this field. The elements of the repeated paths field may only include these fields: * \"description\" * \"directory_services\" * \"file_shares\" * \"labels\"",
+                      "description": "Required. Mask of fields to update. At least one path must be supplied in this field. The elements of the repeated paths field may only include these fields: * \"description\" * \"directory_services\" * \"file_shares\" * \"labels\" * \"performance_config\" * \"deletion_protection_enabled\" * \"deletion_protection_reason\"",
                       "format": "google-fieldmask",
                       "location": "query",
                       "type": "string"
@@ -520,7 +520,7 @@
                   ]
                 },
                 "promoteReplica": {
-                  "description": "Promote an standby instance (replica).",
+                  "description": "Promote the standby instance (replica).",
                   "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:promoteReplica",
                   "httpMethod": "POST",
                   "id": "file.projects.locations.instances.promoteReplica",
@@ -1069,7 +1069,7 @@
       }
     }
   },
-  "revision": "20240716",
+  "revision": "20240905",
   "rootUrl": "https://file.googleapis.com/",
   "schemas": {
     "Backup": {
@@ -1205,7 +1205,7 @@
           "additionalProperties": {
             "type": "string"
           },
-          "description": "Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: \"123/environment\": \"production\", \"123/costCenter\": \"marketing\"",
+          "description": "Optional. Input only. Immutable. Tag key-value pairs are bound to this resource. For example: \"123/environment\": \"production\", \"123/costCenter\": \"marketing\"",
           "type": "object"
         }
       },
@@ -1318,6 +1318,18 @@
       },
       "type": "object"
     },
+    "FixedIOPS": {
+      "description": "Fixed IOPS (input/output operations per second) parameters.",
+      "id": "FixedIOPS",
+      "properties": {
+        "maxReadIops": {
+          "description": "Required. Maximum raw read IOPS.",
+          "format": "int64",
+          "type": "string"
+        }
+      },
+      "type": "object"
+    },
     "GoogleCloudSaasacceleratorManagementProvidersV1Instance": {
       "description": "Instance represents the interface for SLM services to actuate the state of control plane resources. Example Instance in JSON, where consumer-project-number=123456, producer-project-id=cloud-sql: ```json Instance: { \"name\": \"projects/123456/locations/us-east1/instances/prod-instance\", \"create_time\": { \"seconds\": 1526406431, }, \"labels\": { \"env\": \"prod\", \"foo\": \"bar\" }, \"state\": READY, \"software_versions\": { \"software_update\": \"cloud-sql-09-28-2018\", }, \"maintenance_policy_names\": { \"UpdatePolicy\": \"projects/123456/locations/us-east1/maintenancePolicies/prod-update-policy\", } \"tenant_project_id\": \"cloud-sql-test-tenant\", \"producer_metadata\": { \"cloud-sql-tier\": \"basic\", \"cloud-sql-instance-size\": \"1G\", }, \"provisioned_resources\": [ { \"resource-type\": \"compute-instance\", \"resource-url\": \"https://www.googleapis.com/compute/v1/projects/cloud-sql/zones/us-east1-b/instances/vm-1\", } ], \"maintenance_schedules\": { \"csa_rollout\": { \"start_time\": { \"seconds\": 1526406431, }, \"end_time\": { \"seconds\": 1535406431, }, }, \"ncsa_rollout\": { \"start_time\": { \"seconds\": 1526406431, }, \"end_time\": { \"seconds\": 1535406431, }, } }, \"consumer_defined_name\": \"my-sql-instance1\", } ``` LINT.IfChange",
       "id": "GoogleCloudSaasacceleratorManagementProvidersV1Instance",
@@ -1593,6 +1605,18 @@
       },
       "type": "object"
     },
+    "IOPSPerTB": {
+      "description": "IOPS per TB. Filestore defines TB as 1024^4 bytes (TiB).",
+      "id": "IOPSPerTB",
+      "properties": {
+        "maxReadIopsPerTb": {
+          "description": "Required. Maximum read IOPS per TiB.",
+          "format": "int64",
+          "type": "string"
+        }
+      },
+      "type": "object"
+    },
     "Instance": {
       "description": "A Filestore instance.",
       "id": "Instance",
@@ -1608,12 +1632,25 @@
           "readOnly": true,
           "type": "string"
         },
+        "configurablePerformanceEnabled": {
+          "description": "Output only. Indicates whether this instance's performance is configurable. If enabled, adjust it using the 'performance_config' field.",
+          "readOnly": true,
+          "type": "boolean"
+        },
         "createTime": {
           "description": "Output only. The time when the instance was created.",
           "format": "google-datetime",
           "readOnly": true,
           "type": "string"
         },
+        "deletionProtectionEnabled": {
+          "description": "Optional. Indicates whether the instance is protected against deletion.",
+          "type": "boolean"
+        },
+        "deletionProtectionReason": {
+          "description": "Optional. The reason for enabling deletion protection.",
+          "type": "string"
+        },
         "description": {
           "description": "The description of the instance (2048 characters or less).",
           "type": "string"
@@ -1671,6 +1708,15 @@
           },
           "type": "array"
         },
+        "performanceConfig": {
+          "$ref": "PerformanceConfig",
+          "description": "Optional. Used to configure performance."
+        },
+        "performanceLimits": {
+          "$ref": "PerformanceLimits",
+          "description": "Output only. Used for getting performance limits.",
+          "readOnly": true
+        },
         "protocol": {
           "description": "Immutable. The protocol indicates the access protocol for all shares in the instance. This field is immutable and it cannot be changed after the instance has been created. Default value: `NFS_V3`.",
           "enum": [
@@ -1687,7 +1733,7 @@
         },
         "replication": {
           "$ref": "Replication",
-          "description": "Optional. Replicaition configuration."
+          "description": "Optional. Replication configuration."
         },
         "satisfiesPzi": {
           "description": "Output only. Reserved for future use.",
@@ -1757,7 +1803,7 @@
           "additionalProperties": {
             "type": "string"
           },
-          "description": "Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: \"123/environment\": \"production\", \"123/costCenter\": \"marketing\"",
+          "description": "Optional. Input only. Immutable. Tag key-value pairs are bound to this resource. For example: \"123/environment\": \"production\", \"123/costCenter\": \"marketing\"",
           "type": "object"
         },
         "tier": {
@@ -2018,11 +2064,11 @@
       "type": "object"
     },
     "ManagedActiveDirectoryConfig": {
-      "description": "ManagedActiveDirectoryConfig contains all the parameters for connecting to Managed Active Directory.",
+      "description": "ManagedActiveDirectoryConfig contains all the parameters for connecting to Managed Service for Microsoft Active Directory (Managed Microsoft AD).",
       "id": "ManagedActiveDirectoryConfig",
       "properties": {
         "computer": {
-          "description": "Required. The computer name is used as a prefix to the mount remote target. Example: if the computer is `my-computer`, the mount command will look like: `$mount -o vers=4.1,sec=krb5 my-computer.filestore.: `.",
+          "description": "Required. The computer name is used as a prefix in the command to mount the remote target. For example: if the computer is `my-computer`, the mount command will look like: `$mount -o vers=4.1,sec=krb5 my-computer.filestore.: `.",
           "type": "string"
         },
         "domain": {
@@ -2236,6 +2282,52 @@
       },
       "type": "object"
     },
+    "PerformanceConfig": {
+      "description": "Used for setting the performance configuration. If the user doesn't specify PerformanceConfig, automatically provision the default performance settings as described in https://cloud.google.com/filestore/docs/performance. Larger instances will be linearly set to more IOPS. If the instance's capacity is increased or decreased, its performance will be automatically adjusted upwards or downwards accordingly (respectively).",
+      "id": "PerformanceConfig",
+      "properties": {
+        "fixedIops": {
+          "$ref": "FixedIOPS",
+          "description": "Choose a fixed provisioned IOPS value for the instance, which will remain constant regardless of instance capacity. Value must be a multiple of 1000. If the chosen value is outside the supported range for the instance's capacity during instance creation, instance creation will fail with an `InvalidArgument` error. Similarly, if an instance capacity update would result in a value outside the supported range, the update will fail with an `InvalidArgument` error."
+        },
+        "iopsPerTb": {
+          "$ref": "IOPSPerTB",
+          "description": "Provision IOPS dynamically based on the capacity of the instance. Provisioned read IOPS will be calculated by multiplying the capacity of the instance in TiB by the `iops_per_tb` value. For example, for a 2 TiB instance with an `iops_per_tb` value of 17000 the provisioned read IOPS will be 34000. If the calculated value is outside the supported range for the instance's capacity during instance creation, instance creation will fail with an `InvalidArgument` error. Similarly, if an instance capacity update would result in a value outside the supported range, the update will fail with an `InvalidArgument` error."
+        }
+      },
+      "type": "object"
+    },
+    "PerformanceLimits": {
+      "description": "The enforced performance limits, calculated from the instance's performance configuration.",
+      "id": "PerformanceLimits",
+      "properties": {
+        "maxReadIops": {
+          "description": "Output only. The max read IOPS.",
+          "format": "int64",
+          "readOnly": true,
+          "type": "string"
+        },
+        "maxReadThroughputBps": {
+          "description": "Output only. The max read throughput in bytes per second.",
+          "format": "int64",
+          "readOnly": true,
+          "type": "string"
+        },
+        "maxWriteIops": {
+          "description": "Output only. The max write IOPS.",
+          "format": "int64",
+          "readOnly": true,
+          "type": "string"
+        },
+        "maxWriteThroughputBps": {
+          "description": "Output only. The max write throughput in bytes per second.",
+          "format": "int64",
+          "readOnly": true,
+          "type": "string"
+        }
+      },
+      "type": "object"
+    },
     "PromoteReplicaRequest": {
       "description": "PromoteReplicaRequest promotes a Filestore standby instance (replica).",
       "id": "PromoteReplicaRequest",
@@ -2296,7 +2388,7 @@
       "id": "Replication",
       "properties": {
         "replicas": {
-          "description": "Replicas configuration on the instance. For now, only a single replica config is supported.",
+          "description": "Replication configuration for the replica instance associated with this instance. Only a single replica is supported.",
           "items": {
             "$ref": "ReplicaConfig"
           },
@@ -2311,8 +2403,8 @@
           ],
           "enumDescriptions": [
             "Role not set.",
-            "The instance is a Active replication member, functions as the replication source instance.",
-            "The instance is a Standby replication member, functions as the replication destination instance."
+            "The instance is the `ACTIVE` replication member, functions as the replication source instance.",
+            "The instance is the `STANDBY` replication member, functions as the replication destination instance."
           ],
           "type": "string"
         }
@@ -2509,7 +2601,7 @@
           "additionalProperties": {
             "type": "string"
           },
-          "description": "Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: \"123/environment\": \"production\", \"123/costCenter\": \"marketing\"",
+          "description": "Optional. Input only. Immutable. Tag key-value pairs are bound to this resource. For example: \"123/environment\": \"production\", \"123/costCenter\": \"marketing\"",
           "type": "object"
         }
       },