Skip to content

Commit

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

The following keys were added:
- resources.projects.resources.instanceConfigs.resources.operations.methods.cancel.description
- resources.projects.resources.instanceConfigs.resources.operations.methods.cancel.flatPath
- resources.projects.resources.instanceConfigs.resources.operations.methods.cancel.httpMethod
- resources.projects.resources.instanceConfigs.resources.operations.methods.cancel.id
- resources.projects.resources.instanceConfigs.resources.operations.methods.cancel.parameterOrder
- resources.projects.resources.instanceConfigs.resources.operations.methods.cancel.parameters.name.description
- resources.projects.resources.instanceConfigs.resources.operations.methods.cancel.parameters.name.location
- resources.projects.resources.instanceConfigs.resources.operations.methods.cancel.parameters.name.pattern
- resources.projects.resources.instanceConfigs.resources.operations.methods.cancel.parameters.name.required
- resources.projects.resources.instanceConfigs.resources.operations.methods.cancel.parameters.name.type
- resources.projects.resources.instanceConfigs.resources.operations.methods.cancel.path
- resources.projects.resources.instanceConfigs.resources.operations.methods.cancel.response.$ref
- resources.projects.resources.instanceConfigs.resources.operations.methods.cancel.scopes
- resources.projects.resources.instanceConfigs.resources.operations.methods.delete.description
- resources.projects.resources.instanceConfigs.resources.operations.methods.delete.flatPath
- resources.projects.resources.instanceConfigs.resources.operations.methods.delete.httpMethod
- resources.projects.resources.instanceConfigs.resources.operations.methods.delete.id
- resources.projects.resources.instanceConfigs.resources.operations.methods.delete.parameterOrder
- resources.projects.resources.instanceConfigs.resources.operations.methods.delete.parameters.name.description
- resources.projects.resources.instanceConfigs.resources.operations.methods.delete.parameters.name.location
- resources.projects.resources.instanceConfigs.resources.operations.methods.delete.parameters.name.pattern
- resources.projects.resources.instanceConfigs.resources.operations.methods.delete.parameters.name.required
- resources.projects.resources.instanceConfigs.resources.operations.methods.delete.parameters.name.type
- resources.projects.resources.instanceConfigs.resources.operations.methods.delete.path
- resources.projects.resources.instanceConfigs.resources.operations.methods.delete.response.$ref
- resources.projects.resources.instanceConfigs.resources.operations.methods.delete.scopes
- resources.projects.resources.instanceConfigs.resources.operations.methods.get.description
- resources.projects.resources.instanceConfigs.resources.operations.methods.get.flatPath
- resources.projects.resources.instanceConfigs.resources.operations.methods.get.httpMethod
- resources.projects.resources.instanceConfigs.resources.operations.methods.get.id
- resources.projects.resources.instanceConfigs.resources.operations.methods.get.parameterOrder
- resources.projects.resources.instanceConfigs.resources.operations.methods.get.parameters.name.description
- resources.projects.resources.instanceConfigs.resources.operations.methods.get.parameters.name.location
- resources.projects.resources.instanceConfigs.resources.operations.methods.get.parameters.name.pattern
- resources.projects.resources.instanceConfigs.resources.operations.methods.get.parameters.name.required
- resources.projects.resources.instanceConfigs.resources.operations.methods.get.parameters.name.type
- resources.projects.resources.instanceConfigs.resources.operations.methods.get.path
- resources.projects.resources.instanceConfigs.resources.operations.methods.get.response.$ref
- resources.projects.resources.instanceConfigs.resources.operations.methods.get.scopes
- resources.projects.resources.instanceConfigs.resources.operations.methods.list.description
- resources.projects.resources.instanceConfigs.resources.operations.methods.list.flatPath
- resources.projects.resources.instanceConfigs.resources.operations.methods.list.httpMethod
- resources.projects.resources.instanceConfigs.resources.operations.methods.list.id
- resources.projects.resources.instanceConfigs.resources.operations.methods.list.parameterOrder
- resources.projects.resources.instanceConfigs.resources.operations.methods.list.parameters.filter.description
- resources.projects.resources.instanceConfigs.resources.operations.methods.list.parameters.filter.location
- resources.projects.resources.instanceConfigs.resources.operations.methods.list.parameters.filter.type
- resources.projects.resources.instanceConfigs.resources.operations.methods.list.parameters.name.description
- resources.projects.resources.instanceConfigs.resources.operations.methods.list.parameters.name.location
- resources.projects.resources.instanceConfigs.resources.operations.methods.list.parameters.name.pattern
- resources.projects.resources.instanceConfigs.resources.operations.methods.list.parameters.name.required
- resources.projects.resources.instanceConfigs.resources.operations.methods.list.parameters.name.type
- resources.projects.resources.instanceConfigs.resources.operations.methods.list.parameters.pageSize.description
- resources.projects.resources.instanceConfigs.resources.operations.methods.list.parameters.pageSize.format
- resources.projects.resources.instanceConfigs.resources.operations.methods.list.parameters.pageSize.location
- resources.projects.resources.instanceConfigs.resources.operations.methods.list.parameters.pageSize.type
- resources.projects.resources.instanceConfigs.resources.operations.methods.list.parameters.pageToken.description
- resources.projects.resources.instanceConfigs.resources.operations.methods.list.parameters.pageToken.location
- resources.projects.resources.instanceConfigs.resources.operations.methods.list.parameters.pageToken.type
- resources.projects.resources.instanceConfigs.resources.operations.methods.list.path
- resources.projects.resources.instanceConfigs.resources.operations.methods.list.response.$ref
- resources.projects.resources.instanceConfigs.resources.operations.methods.list.scopes

The following keys were changed:
- resources.projects.resources.instances.resources.backupOperations.methods.list.parameters.filter.description
- schemas.CopyBackupMetadata.description
  • Loading branch information
yoshi-automation authored and bcoe committed Apr 11, 2022
1 parent 13c4e9b commit 5c39acc
Show file tree
Hide file tree
Showing 2 changed files with 714 additions and 6 deletions.
132 changes: 129 additions & 3 deletions discovery/spanner-v1.json
Original file line number Diff line number Diff line change
Expand Up @@ -178,6 +178,132 @@
"https://www.googleapis.com/auth/spanner.admin"
]
}
},
"resources": {
"operations": {
"methods": {
"cancel": {
"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.",
"flatPath": "v1/projects/{projectsId}/instanceConfigs/{instanceConfigsId}/operations/{operationsId}:cancel",
"httpMethod": "POST",
"id": "spanner.projects.instanceConfigs.operations.cancel",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource to be cancelled.",
"location": "path",
"pattern": "^projects/[^/]+/instanceConfigs/[^/]+/operations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}:cancel",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/spanner.admin"
]
},
"delete": {
"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
"flatPath": "v1/projects/{projectsId}/instanceConfigs/{instanceConfigsId}/operations/{operationsId}",
"httpMethod": "DELETE",
"id": "spanner.projects.instanceConfigs.operations.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource to be deleted.",
"location": "path",
"pattern": "^projects/[^/]+/instanceConfigs/[^/]+/operations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/spanner.admin"
]
},
"get": {
"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
"flatPath": "v1/projects/{projectsId}/instanceConfigs/{instanceConfigsId}/operations/{operationsId}",
"httpMethod": "GET",
"id": "spanner.projects.instanceConfigs.operations.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource.",
"location": "path",
"pattern": "^projects/[^/]+/instanceConfigs/[^/]+/operations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/spanner.admin"
]
},
"list": {
"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `\"/v1/{name=users/*}/operations\"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.",
"flatPath": "v1/projects/{projectsId}/instanceConfigs/{instanceConfigsId}/operations",
"httpMethod": "GET",
"id": "spanner.projects.instanceConfigs.operations.list",
"parameterOrder": [
"name"
],
"parameters": {
"filter": {
"description": "The standard list filter.",
"location": "query",
"type": "string"
},
"name": {
"description": "The name of the operation's parent resource.",
"location": "path",
"pattern": "^projects/[^/]+/instanceConfigs/[^/]+/operations$",
"required": true,
"type": "string"
},
"pageSize": {
"description": "The standard list page size.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "The standard list page token.",
"location": "query",
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "ListOperationsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/spanner.admin"
]
}
}
}
}
},
"instances": {
Expand Down Expand Up @@ -447,7 +573,7 @@
],
"parameters": {
"filter": {
"description": "An expression that filters the list of returned backup operations. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string, a number, or a boolean. The comparison operator must be one of: `<`, `>`, `<=`, `>=`, `!=`, `=`, or `:`. Colon `:` is the contains operator. Filter rules are not case sensitive. The following fields in the operation are eligible for filtering: * `name` - The name of the long-running operation * `done` - False if the operation is in progress, else true. * `metadata.@type` - the type of metadata. For example, the type string for CreateBackupMetadata is `type.googleapis.com/google.spanner.admin.database.v1.CreateBackupMetadata`. * `metadata.` - any field in metadata.value. `metadata.@type` must be specified first if filtering on metadata fields. * `error` - Error associated with the long-running operation. * `response.@type` - the type of response. * `response.` - any field in response.value. You can combine multiple expressions by enclosing each expression in parentheses. By default, expressions are combined with AND logic, but you can specify AND, OR, and NOT logic explicitly. Here are a few examples: * `done:true` - The operation is complete. * `(metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.CreateBackupMetadata) AND` \\ `metadata.database:prod` - Returns operations where: * The operation's metadata type is CreateBackupMetadata. * The database the backup was taken from has a name containing the string \"prod\". * `(metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.CreateBackupMetadata) AND` \\ `(metadata.name:howl) AND` \\ `(metadata.progress.start_time < \\\"2018-03-28T14:50:00Z\\\") AND` \\ `(error:*)` - Returns operations where: * The operation's metadata type is CreateBackupMetadata. * The backup name contains the string \"howl\". * The operation started before 2018-03-28T14:50:00Z. * The operation resulted in an error. * `(metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.CopyBackupMetadata) AND` \\ `(metadata.source_backup:test) AND` \\ `(metadata.progress.start_time < \\\"2022-01-18T14:50:00Z\\\") AND` \\ `(error:*)` - Returns operations where: * The operation's metadata type is CopyBackupMetadata. * The source backup of the copied backup name contains the string \"test\". * The operation started before 2022-01-18T14:50:00Z. * The operation resulted in an error. * `((metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.CreateBackupMetadata) AND` \\ `(metadata.database:test_db)) OR` \\ `((metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.CopyBackupMetadata) AND` \\ `(metadata.source_backup:test_bkp)) AND` \\ `(error:*)` - Returns operations where: * The operation's metadata matches either of criteria: * The operation's metadata type is CreateBackupMetadata AND the database the backup was taken from has name containing string \"test_db\" * The operation's metadata type is CopyBackupMetadata AND the backup the backup was copied from has name containing string \"test_bkp\" * The operation resulted in an error.",
"description": "An expression that filters the list of returned backup operations. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string, a number, or a boolean. The comparison operator must be one of: `<`, `>`, `<=`, `>=`, `!=`, `=`, or `:`. Colon `:` is the contains operator. Filter rules are not case sensitive. The following fields in the operation are eligible for filtering: * `name` - The name of the long-running operation * `done` - False if the operation is in progress, else true. * `metadata.@type` - the type of metadata. For example, the type string for CreateBackupMetadata is `type.googleapis.com/google.spanner.admin.database.v1.CreateBackupMetadata`. * `metadata.` - any field in metadata.value. `metadata.@type` must be specified first if filtering on metadata fields. * `error` - Error associated with the long-running operation. * `response.@type` - the type of response. * `response.` - any field in response.value. You can combine multiple expressions by enclosing each expression in parentheses. By default, expressions are combined with AND logic, but you can specify AND, OR, and NOT logic explicitly. Here are a few examples: * `done:true` - The operation is complete. * `(metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.CreateBackupMetadata) AND` \\ `metadata.database:prod` - Returns operations where: * The operation's metadata type is CreateBackupMetadata. * The source database name of backup contains the string \"prod\". * `(metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.CreateBackupMetadata) AND` \\ `(metadata.name:howl) AND` \\ `(metadata.progress.start_time < \\\"2018-03-28T14:50:00Z\\\") AND` \\ `(error:*)` - Returns operations where: * The operation's metadata type is CreateBackupMetadata. * The backup name contains the string \"howl\". * The operation started before 2018-03-28T14:50:00Z. * The operation resulted in an error. * `(metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.CopyBackupMetadata) AND` \\ `(metadata.source_backup:test) AND` \\ `(metadata.progress.start_time < \\\"2022-01-18T14:50:00Z\\\") AND` \\ `(error:*)` - Returns operations where: * The operation's metadata type is CopyBackupMetadata. * The source backup name contains the string \"test\". * The operation started before 2022-01-18T14:50:00Z. * The operation resulted in an error. * `((metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.CreateBackupMetadata) AND` \\ `(metadata.database:test_db)) OR` \\ `((metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.CopyBackupMetadata) AND` \\ `(metadata.source_backup:test_bkp)) AND` \\ `(error:*)` - Returns operations where: * The operation's metadata matches either of criteria: * The operation's metadata type is CreateBackupMetadata AND the source database name of the backup contains the string \"test_db\" * The operation's metadata type is CopyBackupMetadata AND the source backup name contains the string \"test_bkp\" * The operation resulted in an error.",
"location": "query",
"type": "string"
},
Expand Down Expand Up @@ -2066,7 +2192,7 @@
}
}
},
"revision": "20220326",
"revision": "20220404",
"rootUrl": "https://spanner.googleapis.com/",
"schemas": {
"Backup": {
Expand Down Expand Up @@ -2400,7 +2526,7 @@
"type": "object"
},
"CopyBackupMetadata": {
"description": "Metadata type for the google.longrunning.Operation returned by CopyBackup.",
"description": "Metadata type for the operation returned by CopyBackup.",
"id": "CopyBackupMetadata",
"properties": {
"cancelTime": {
Expand Down

0 comments on commit 5c39acc

Please sign in to comment.