Skip to content

Commit 67ce067

Browse files
yoshi-automationquirogas
yoshi-automation
authored and
quirogas
committed
feat(file): update the API
#### file:v1beta1 The following keys were changed: - resources.projects.resources.locations.methods.list.parameters.extraLocationTypes.description - resources.projects.resources.locations.resources.operations.methods.list.parameters.returnPartialSuccess.description - schemas.Instance.properties.capacityStepSizeGb.description - schemas.Instance.properties.maxCapacityGb.description - schemas.Instance.properties.maxShareCount.description - schemas.Instance.properties.minCapacityGb.description - schemas.ListOperationsResponse.properties.unreachable.description - schemas.PerformanceLimits.properties.maxIops.description - schemas.PerformanceLimits.properties.maxReadIops.description - schemas.PerformanceLimits.properties.maxReadThroughputBps.description - schemas.PerformanceLimits.properties.maxWriteIops.description - schemas.PerformanceLimits.properties.maxWriteThroughputBps.description - schemas.ReplicaConfig.properties.peerInstance.description - schemas.Replication.description - schemas.Replication.properties.role.description #### file:v1 The following keys were added: - resources.projects.resources.locations.resources.instances.methods.pauseReplica.description - resources.projects.resources.locations.resources.instances.methods.pauseReplica.flatPath - resources.projects.resources.locations.resources.instances.methods.pauseReplica.httpMethod - resources.projects.resources.locations.resources.instances.methods.pauseReplica.id - resources.projects.resources.locations.resources.instances.methods.pauseReplica.parameterOrder - resources.projects.resources.locations.resources.instances.methods.pauseReplica.parameters.name.description - resources.projects.resources.locations.resources.instances.methods.pauseReplica.parameters.name.location - resources.projects.resources.locations.resources.instances.methods.pauseReplica.parameters.name.pattern - resources.projects.resources.locations.resources.instances.methods.pauseReplica.parameters.name.required - resources.projects.resources.locations.resources.instances.methods.pauseReplica.parameters.name.type - resources.projects.resources.locations.resources.instances.methods.pauseReplica.path - resources.projects.resources.locations.resources.instances.methods.pauseReplica.request.$ref - resources.projects.resources.locations.resources.instances.methods.pauseReplica.response.$ref - resources.projects.resources.locations.resources.instances.methods.pauseReplica.scopes - resources.projects.resources.locations.resources.instances.methods.resumeReplica.description - resources.projects.resources.locations.resources.instances.methods.resumeReplica.flatPath - resources.projects.resources.locations.resources.instances.methods.resumeReplica.httpMethod - resources.projects.resources.locations.resources.instances.methods.resumeReplica.id - resources.projects.resources.locations.resources.instances.methods.resumeReplica.parameterOrder - resources.projects.resources.locations.resources.instances.methods.resumeReplica.parameters.name.description - resources.projects.resources.locations.resources.instances.methods.resumeReplica.parameters.name.location - resources.projects.resources.locations.resources.instances.methods.resumeReplica.parameters.name.pattern - resources.projects.resources.locations.resources.instances.methods.resumeReplica.parameters.name.required - resources.projects.resources.locations.resources.instances.methods.resumeReplica.parameters.name.type - resources.projects.resources.locations.resources.instances.methods.resumeReplica.path - resources.projects.resources.locations.resources.instances.methods.resumeReplica.request.$ref - resources.projects.resources.locations.resources.instances.methods.resumeReplica.response.$ref - resources.projects.resources.locations.resources.instances.methods.resumeReplica.scopes - schemas.PauseReplicaRequest.description - schemas.PauseReplicaRequest.id - schemas.PauseReplicaRequest.type - schemas.ResumeReplicaRequest.description - schemas.ResumeReplicaRequest.id - schemas.ResumeReplicaRequest.type The following keys were changed: - resources.projects.resources.locations.methods.list.parameters.extraLocationTypes.description - resources.projects.resources.locations.resources.operations.methods.list.parameters.returnPartialSuccess.description - schemas.Instance.properties.capacityStepSizeGb.description - schemas.Instance.properties.maxCapacityGb.description - schemas.Instance.properties.minCapacityGb.description - schemas.ListOperationsResponse.properties.unreachable.description - schemas.PerformanceLimits.properties.maxIops.description - schemas.PerformanceLimits.properties.maxReadIops.description - schemas.PerformanceLimits.properties.maxReadThroughputBps.description - schemas.PerformanceLimits.properties.maxWriteIops.description - schemas.PerformanceLimits.properties.maxWriteThroughputBps.description - schemas.ReplicaConfig.properties.peerInstance.description - schemas.Replication.description - schemas.Replication.properties.role.description
1 parent 552c32c commit 67ce067

File tree

4 files changed

+458
-64
lines changed

4 files changed

+458
-64
lines changed

‎discovery/file-v1.json‎

Lines changed: 83 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,7 @@
144144
],
145145
"parameters": {
146146
"extraLocationTypes": {
147-
"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.",
147+
"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.",
148148
"location": "query",
149149
"repeated": true,
150150
"type": "string"
@@ -520,6 +520,34 @@
520520
"https://www.googleapis.com/auth/cloud-platform"
521521
]
522522
},
523+
"pauseReplica": {
524+
"description": "Pause the standby instance (replica). WARNING: This operation makes the standby instance's NFS filesystem writable. Any data written to the standby instance while paused will be lost when the replica is resumed or promoted.",
525+
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:pauseReplica",
526+
"httpMethod": "POST",
527+
"id": "file.projects.locations.instances.pauseReplica",
528+
"parameterOrder": [
529+
"name"
530+
],
531+
"parameters": {
532+
"name": {
533+
"description": "Required. The resource name of the instance, in the format `projects/{project_id}/locations/{location_id}/instances/{instance_id}`.",
534+
"location": "path",
535+
"pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$",
536+
"required": true,
537+
"type": "string"
538+
}
539+
},
540+
"path": "v1/{+name}:pauseReplica",
541+
"request": {
542+
"$ref": "PauseReplicaRequest"
543+
},
544+
"response": {
545+
"$ref": "Operation"
546+
},
547+
"scopes": [
548+
"https://www.googleapis.com/auth/cloud-platform"
549+
]
550+
},
523551
"promoteReplica": {
524552
"description": "Promote the standby instance (replica).",
525553
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:promoteReplica",
@@ -576,6 +604,34 @@
576604
"https://www.googleapis.com/auth/cloud-platform"
577605
]
578606
},
607+
"resumeReplica": {
608+
"description": "Resume the standby instance (replica). WARNING: Any data written to the standby instance while paused will be lost when the replica is resumed.",
609+
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:resumeReplica",
610+
"httpMethod": "POST",
611+
"id": "file.projects.locations.instances.resumeReplica",
612+
"parameterOrder": [
613+
"name"
614+
],
615+
"parameters": {
616+
"name": {
617+
"description": "Required. The resource name of the instance, in the format `projects/{project_id}/locations/{location_id}/instances/{instance_id}`.",
618+
"location": "path",
619+
"pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$",
620+
"required": true,
621+
"type": "string"
622+
}
623+
},
624+
"path": "v1/{+name}:resumeReplica",
625+
"request": {
626+
"$ref": "ResumeReplicaRequest"
627+
},
628+
"response": {
629+
"$ref": "Operation"
630+
},
631+
"scopes": [
632+
"https://www.googleapis.com/auth/cloud-platform"
633+
]
634+
},
579635
"revert": {
580636
"description": "Revert an existing instance's file system to a specified snapshot.",
581637
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:revert",
@@ -893,7 +949,7 @@
893949
"type": "string"
894950
},
895951
"returnPartialSuccess": {
896-
"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
952+
"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
897953
"location": "query",
898954
"type": "boolean"
899955
}
@@ -913,7 +969,7 @@
913969
}
914970
}
915971
},
916-
"revision": "20251015",
972+
"revision": "20251204",
917973
"rootUrl": "https://file.googleapis.com/",
918974
"schemas": {
919975
"Backup": {
@@ -1474,7 +1530,7 @@
14741530
"id": "Instance",
14751531
"properties": {
14761532
"capacityStepSizeGb": {
1477-
"description": "Output only. The increase/decrease capacity step size in GB.",
1533+
"description": "Output only. The incremental increase or decrease in capacity, designated in some number of GB.",
14781534
"format": "int64",
14791535
"readOnly": true,
14801536
"type": "string"
@@ -1529,13 +1585,13 @@
15291585
"type": "object"
15301586
},
15311587
"maxCapacityGb": {
1532-
"description": "Output only. The max capacity of the instance in GB.",
1588+
"description": "Output only. The maximum capacity of the instance in GB.",
15331589
"format": "int64",
15341590
"readOnly": true,
15351591
"type": "string"
15361592
},
15371593
"minCapacityGb": {
1538-
"description": "Output only. The min capacity of the instance in GB.",
1594+
"description": "Output only. The minimum capacity of the instance in GB.",
15391595
"format": "int64",
15401596
"readOnly": true,
15411597
"type": "string"
@@ -1789,7 +1845,7 @@
17891845
"type": "array"
17901846
},
17911847
"unreachable": {
1792-
"description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.",
1848+
"description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations.",
17931849
"items": {
17941850
"type": "string"
17951851
},
@@ -2115,6 +2171,12 @@
21152171
},
21162172
"type": "object"
21172173
},
2174+
"PauseReplicaRequest": {
2175+
"description": "PauseReplicaRequest pauses a Filestore standby instance (replica).",
2176+
"id": "PauseReplicaRequest",
2177+
"properties": {},
2178+
"type": "object"
2179+
},
21182180
"PerformanceConfig": {
21192181
"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).",
21202182
"id": "PerformanceConfig",
@@ -2135,31 +2197,31 @@
21352197
"id": "PerformanceLimits",
21362198
"properties": {
21372199
"maxIops": {
2138-
"description": "Output only. The max IOPS.",
2200+
"description": "Output only. The maximum IOPS.",
21392201
"format": "int64",
21402202
"readOnly": true,
21412203
"type": "string"
21422204
},
21432205
"maxReadIops": {
2144-
"description": "Output only. The max read IOPS.",
2206+
"description": "Output only. The maximum read IOPS.",
21452207
"format": "int64",
21462208
"readOnly": true,
21472209
"type": "string"
21482210
},
21492211
"maxReadThroughputBps": {
2150-
"description": "Output only. The max read throughput in bytes per second.",
2212+
"description": "Output only. The maximum read throughput in bytes per second.",
21512213
"format": "int64",
21522214
"readOnly": true,
21532215
"type": "string"
21542216
},
21552217
"maxWriteIops": {
2156-
"description": "Output only. The max write IOPS.",
2218+
"description": "Output only. The maximum write IOPS.",
21572219
"format": "int64",
21582220
"readOnly": true,
21592221
"type": "string"
21602222
},
21612223
"maxWriteThroughputBps": {
2162-
"description": "Output only. The max write throughput in bytes per second.",
2224+
"description": "Output only. The maximum write throughput in bytes per second.",
21632225
"format": "int64",
21642226
"readOnly": true,
21652227
"type": "string"
@@ -2200,7 +2262,7 @@
22002262
"type": "string"
22012263
},
22022264
"peerInstance": {
2203-
"description": "Optional. The peer instance.",
2265+
"description": "Optional. The name of the source instance for the replica, in the format `projects/{project}/locations/{location}/instances/{instance}`. This field is required when creating a replica.",
22042266
"type": "string"
22052267
},
22062268
"state": {
@@ -2262,7 +2324,7 @@
22622324
"type": "object"
22632325
},
22642326
"Replication": {
2265-
"description": "Replication specifications.",
2327+
"description": "Optional. The configuration used to replicate an instance.",
22662328
"id": "Replication",
22672329
"properties": {
22682330
"replicas": {
@@ -2273,7 +2335,7 @@
22732335
"type": "array"
22742336
},
22752337
"role": {
2276-
"description": "Optional. The replication role.",
2338+
"description": "Optional. The replication role. When creating a new replica, this field must be set to `STANDBY`.",
22772339
"enum": [
22782340
"ROLE_UNSPECIFIED",
22792341
"ACTIVE",
@@ -2304,6 +2366,12 @@
23042366
},
23052367
"type": "object"
23062368
},
2369+
"ResumeReplicaRequest": {
2370+
"description": "ResumeReplicaRequest resumes a Filestore standby instance (replica).",
2371+
"id": "ResumeReplicaRequest",
2372+
"properties": {},
2373+
"type": "object"
2374+
},
23072375
"RevertInstanceRequest": {
23082376
"description": "RevertInstanceRequest reverts the given instance's file share to the specified snapshot.",
23092377
"id": "RevertInstanceRequest",

‎discovery/file-v1beta1.json‎

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,7 @@
144144
],
145145
"parameters": {
146146
"extraLocationTypes": {
147-
"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.",
147+
"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.",
148148
"location": "query",
149149
"repeated": true,
150150
"type": "string"
@@ -1116,7 +1116,7 @@
11161116
"type": "string"
11171117
},
11181118
"returnPartialSuccess": {
1119-
"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
1119+
"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
11201120
"location": "query",
11211121
"type": "boolean"
11221122
}
@@ -1136,7 +1136,7 @@
11361136
}
11371137
}
11381138
},
1139-
"revision": "20251015",
1139+
"revision": "20251204",
11401140
"rootUrl": "https://file.googleapis.com/",
11411141
"schemas": {
11421142
"Backup": {
@@ -1720,7 +1720,7 @@
17201720
"type": "string"
17211721
},
17221722
"capacityStepSizeGb": {
1723-
"description": "Output only. The increase/decrease capacity step size.",
1723+
"description": "Output only. The incremental increase or decrease in capacity, designated in some number of GB.",
17241724
"format": "int64",
17251725
"readOnly": true,
17261726
"type": "string"
@@ -1775,18 +1775,18 @@
17751775
"type": "object"
17761776
},
17771777
"maxCapacityGb": {
1778-
"description": "Output only. The max capacity of the instance.",
1778+
"description": "Output only. The maximum capacity of the instance.",
17791779
"format": "int64",
17801780
"readOnly": true,
17811781
"type": "string"
17821782
},
17831783
"maxShareCount": {
1784-
"description": "The max number of shares allowed.",
1784+
"description": "The maximum number of shares allowed.",
17851785
"format": "int64",
17861786
"type": "string"
17871787
},
17881788
"minCapacityGb": {
1789-
"description": "Output only. The min capacity of the instance.",
1789+
"description": "Output only. The minimum capacity of the instance.",
17901790
"format": "int64",
17911791
"readOnly": true,
17921792
"type": "string"
@@ -2044,7 +2044,7 @@
20442044
"type": "array"
20452045
},
20462046
"unreachable": {
2047-
"description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.",
2047+
"description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations.",
20482048
"items": {
20492049
"type": "string"
20502050
},
@@ -2457,31 +2457,31 @@
24572457
"id": "PerformanceLimits",
24582458
"properties": {
24592459
"maxIops": {
2460-
"description": "Output only. The max IOPS.",
2460+
"description": "Output only. The maximum IOPS.",
24612461
"format": "int64",
24622462
"readOnly": true,
24632463
"type": "string"
24642464
},
24652465
"maxReadIops": {
2466-
"description": "Output only. The max read IOPS.",
2466+
"description": "Output only. The maximum read IOPS.",
24672467
"format": "int64",
24682468
"readOnly": true,
24692469
"type": "string"
24702470
},
24712471
"maxReadThroughputBps": {
2472-
"description": "Output only. The max read throughput in bytes per second.",
2472+
"description": "Output only. The maximum read throughput in bytes per second.",
24732473
"format": "int64",
24742474
"readOnly": true,
24752475
"type": "string"
24762476
},
24772477
"maxWriteIops": {
2478-
"description": "Output only. The max write IOPS.",
2478+
"description": "Output only. The maximum write IOPS.",
24792479
"format": "int64",
24802480
"readOnly": true,
24812481
"type": "string"
24822482
},
24832483
"maxWriteThroughputBps": {
2484-
"description": "Output only. The max write throughput in bytes per second.",
2484+
"description": "Output only. The maximumwrite throughput in bytes per second.",
24852485
"format": "int64",
24862486
"readOnly": true,
24872487
"type": "string"
@@ -2521,7 +2521,7 @@
25212521
"type": "string"
25222522
},
25232523
"peerInstance": {
2524-
"description": "The peer instance.",
2524+
"description": "The name of the source instance for the replica, in the format `projects/{project}/locations/{location}/instances/{instance}`. This field is required when creating a replica.",
25252525
"type": "string"
25262526
},
25272527
"state": {
@@ -2581,7 +2581,7 @@
25812581
"type": "object"
25822582
},
25832583
"Replication": {
2584-
"description": "Replication specifications.",
2584+
"description": "Optional. The configuration used to replicate an instance.",
25852585
"id": "Replication",
25862586
"properties": {
25872587
"replicas": {
@@ -2592,7 +2592,7 @@
25922592
"type": "array"
25932593
},
25942594
"role": {
2595-
"description": "Output only. The replication role.",
2595+
"description": "Output only. The replication role. When creating a new replica, this field must be set to `STANDBY`.",
25962596
"enum": [
25972597
"ROLE_UNSPECIFIED",
25982598
"ACTIVE",

0 commit comments

Comments
 (0)