| { |
| "auth": { |
| "oauth2": { |
| "scopes": { |
| "https://www.googleapis.com/auth/cloud-platform": { |
| "description": "View and manage your data across Google Cloud Platform services" |
| } |
| } |
| } |
| }, |
| "basePath": "", |
| "baseUrl": "https://cloudshell.googleapis.com/", |
| "batchPath": "batch", |
| "canonicalName": "Cloud Shell", |
| "description": "Allows users to start, configure, and connect to interactive shell sessions running in the cloud.\n", |
| "discoveryVersion": "v1", |
| "documentationLink": "https://cloud.google.com/shell/docs/", |
| "fullyEncodeReservedExpansion": true, |
| "icons": { |
| "x16": "http://www.google.com/images/icons/product/search-16.gif", |
| "x32": "http://www.google.com/images/icons/product/search-32.gif" |
| }, |
| "id": "cloudshell:v1", |
| "kind": "discovery#restDescription", |
| "name": "cloudshell", |
| "ownerDomain": "google.com", |
| "ownerName": "Google", |
| "parameters": { |
| "$.xgafv": { |
| "description": "V1 error format.", |
| "enum": [ |
| "1", |
| "2" |
| ], |
| "enumDescriptions": [ |
| "v1 error format", |
| "v2 error format" |
| ], |
| "location": "query", |
| "type": "string" |
| }, |
| "access_token": { |
| "description": "OAuth access token.", |
| "location": "query", |
| "type": "string" |
| }, |
| "alt": { |
| "default": "json", |
| "description": "Data format for response.", |
| "enum": [ |
| "json", |
| "media", |
| "proto" |
| ], |
| "enumDescriptions": [ |
| "Responses with Content-Type of application/json", |
| "Media download with context-dependent Content-Type", |
| "Responses with Content-Type of application/x-protobuf" |
| ], |
| "location": "query", |
| "type": "string" |
| }, |
| "callback": { |
| "description": "JSONP", |
| "location": "query", |
| "type": "string" |
| }, |
| "fields": { |
| "description": "Selector specifying which fields to include in a partial response.", |
| "location": "query", |
| "type": "string" |
| }, |
| "key": { |
| "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", |
| "location": "query", |
| "type": "string" |
| }, |
| "oauth_token": { |
| "description": "OAuth 2.0 token for the current user.", |
| "location": "query", |
| "type": "string" |
| }, |
| "prettyPrint": { |
| "default": "true", |
| "description": "Returns response with indentations and line breaks.", |
| "location": "query", |
| "type": "boolean" |
| }, |
| "quotaUser": { |
| "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", |
| "location": "query", |
| "type": "string" |
| }, |
| "uploadType": { |
| "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", |
| "location": "query", |
| "type": "string" |
| }, |
| "upload_protocol": { |
| "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", |
| "location": "query", |
| "type": "string" |
| } |
| }, |
| "protocol": "rest", |
| "resources": { |
| "operations": { |
| "methods": { |
| "cancel": { |
| "description": "Starts asynchronous cancellation on a long-running operation. The server\nmakes a best effort to cancel the operation, but success is not\nguaranteed. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`. Clients can use\nOperations.GetOperation or\nother methods to check whether the cancellation succeeded or whether the\noperation completed despite cancellation. On successful cancellation,\nthe operation is not deleted; instead, it becomes an operation with\nan Operation.error value with a google.rpc.Status.code of 1,\ncorresponding to `Code.CANCELLED`.", |
| "flatPath": "v1/operations/{operationsId}:cancel", |
| "httpMethod": "POST", |
| "id": "cloudshell.operations.cancel", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "The name of the operation resource to be cancelled.", |
| "location": "path", |
| "pattern": "^operations/.+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+name}:cancel", |
| "request": { |
| "$ref": "CancelOperationRequest" |
| }, |
| "response": { |
| "$ref": "Empty" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "delete": { |
| "description": "Deletes a long-running operation. This method indicates that the client is\nno longer interested in the operation result. It does not cancel the\noperation. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`.", |
| "flatPath": "v1/operations/{operationsId}", |
| "httpMethod": "DELETE", |
| "id": "cloudshell.operations.delete", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "The name of the operation resource to be deleted.", |
| "location": "path", |
| "pattern": "^operations/.+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+name}", |
| "response": { |
| "$ref": "Empty" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "get": { |
| "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice.", |
| "flatPath": "v1/operations/{operationsId}", |
| "httpMethod": "GET", |
| "id": "cloudshell.operations.get", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "The name of the operation resource.", |
| "location": "path", |
| "pattern": "^operations/.+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+name}", |
| "response": { |
| "$ref": "Operation" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "list": { |
| "description": "Lists operations that match the specified filter in the request. If the\nserver doesn't support this method, it returns `UNIMPLEMENTED`.\n\nNOTE: the `name` binding allows API services to override the binding\nto use different resource name schemes, such as `users/*/operations`. To\noverride the binding, API services can add a binding such as\n`\"/v1/{name=users/*}/operations\"` to their service configuration.\nFor backwards compatibility, the default name includes the operations\ncollection id, however overriding users must ensure the name binding\nis the parent resource, without the operations collection id.", |
| "flatPath": "v1/operations", |
| "httpMethod": "GET", |
| "id": "cloudshell.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": "^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" |
| ] |
| } |
| } |
| } |
| }, |
| "revision": "20191028", |
| "rootUrl": "https://cloudshell.googleapis.com/", |
| "schemas": { |
| "CancelOperationRequest": { |
| "description": "The request message for Operations.CancelOperation.", |
| "id": "CancelOperationRequest", |
| "properties": {}, |
| "type": "object" |
| }, |
| "Empty": { |
| "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.", |
| "id": "Empty", |
| "properties": {}, |
| "type": "object" |
| }, |
| "Environment": { |
| "description": "A Cloud Shell environment, which is defined as the combination of a Docker\nimage specifying what is installed on the environment and a home directory\ncontaining the user's data that will remain across sessions. Each user has a\nsingle environment with the ID \"default\".", |
| "id": "Environment", |
| "properties": { |
| "dockerImage": { |
| "description": "Required. Full path to the Docker image used to run this environment, e.g.\n\"gcr.io/dev-con/cloud-devshell:latest\".", |
| "type": "string" |
| }, |
| "id": { |
| "description": "Output only. The environment's identifier, which is always \"default\".", |
| "type": "string" |
| }, |
| "name": { |
| "description": "Output only. Full name of this resource, in the format\n`users/{owner_email}/environments/{environment_id}`. `{owner_email}` is the\nemail address of the user to whom this environment belongs, and\n`{environment_id}` is the identifier of this environment. For example,\n`users/someone@example.com/environments/default`.", |
| "type": "string" |
| }, |
| "publicKeys": { |
| "description": "Output only. Public keys associated with the environment. Clients can\nconnect to this environment via SSH only if they possess a private key\ncorresponding to at least one of these public keys. Keys can be added to or\nremoved from the environment using the CreatePublicKey and DeletePublicKey\nmethods.", |
| "items": { |
| "$ref": "PublicKey" |
| }, |
| "type": "array" |
| }, |
| "size": { |
| "description": "Indicates the size of the backing VM running the environment. If set to\nsomething other than DEFAULT, it will be reverted to the default VM size\nafter vm_size_expire_time.", |
| "enum": [ |
| "VM_SIZE_UNSPECIFIED", |
| "DEFAULT", |
| "BOOSTED" |
| ], |
| "enumDescriptions": [ |
| "The VM size is unknown.", |
| "The default VM size.", |
| "The boosted VM size." |
| ], |
| "type": "string" |
| }, |
| "sshHost": { |
| "description": "Output only. Host to which clients can connect to initiate SSH sessions\nwith the environment.", |
| "type": "string" |
| }, |
| "sshPort": { |
| "description": "Output only. Port to which clients can connect to initiate SSH sessions\nwith the environment.", |
| "format": "int32", |
| "type": "integer" |
| }, |
| "sshUsername": { |
| "description": "Output only. Username that clients should use when initiating SSH sessions\nwith the environment.", |
| "type": "string" |
| }, |
| "state": { |
| "description": "Output only. Current execution state of this environment.", |
| "enum": [ |
| "STATE_UNSPECIFIED", |
| "DISABLED", |
| "STARTING", |
| "RUNNING" |
| ], |
| "enumDescriptions": [ |
| "The environment's states is unknown.", |
| "The environment is not running and can't be connected to. Starting the\nenvironment will transition it to the STARTING state.", |
| "The environment is being started but is not yet ready to accept\nconnections.", |
| "The environment is running and ready to accept connections. It will\nautomatically transition back to DISABLED after a period of inactivity or\nif another environment is started." |
| ], |
| "type": "string" |
| }, |
| "vmSizeExpireTime": { |
| "description": "Output only. The time when the Environment will expire back to the default\nVM size.", |
| "format": "google-datetime", |
| "type": "string" |
| }, |
| "webHost": { |
| "description": "Output only. Host to which clients can connect to initiate HTTPS or WSS\nconnections with the environment.", |
| "type": "string" |
| }, |
| "webPorts": { |
| "description": "Output only. Ports to which clients can connect to initiate HTTPS or WSS\nconnections with the environment.", |
| "items": { |
| "format": "int32", |
| "type": "integer" |
| }, |
| "type": "array" |
| } |
| }, |
| "type": "object" |
| }, |
| "ListOperationsResponse": { |
| "description": "The response message for Operations.ListOperations.", |
| "id": "ListOperationsResponse", |
| "properties": { |
| "nextPageToken": { |
| "description": "The standard List next-page token.", |
| "type": "string" |
| }, |
| "operations": { |
| "description": "A list of operations that matches the specified filter in the request.", |
| "items": { |
| "$ref": "Operation" |
| }, |
| "type": "array" |
| } |
| }, |
| "type": "object" |
| }, |
| "Operation": { |
| "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.", |
| "id": "Operation", |
| "properties": { |
| "done": { |
| "description": "If the value is `false`, it means the operation is still in progress.\nIf `true`, the operation is completed, and either `error` or `response` is\navailable.", |
| "type": "boolean" |
| }, |
| "error": { |
| "$ref": "Status", |
| "description": "The error result of the operation in case of failure or cancellation." |
| }, |
| "metadata": { |
| "additionalProperties": { |
| "description": "Properties of the object. Contains field @type with type URL.", |
| "type": "any" |
| }, |
| "description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.", |
| "type": "object" |
| }, |
| "name": { |
| "description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should be a resource name ending with `operations/{unique_id}`.", |
| "type": "string" |
| }, |
| "response": { |
| "additionalProperties": { |
| "description": "Properties of the object. Contains field @type with type URL.", |
| "type": "any" |
| }, |
| "description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.", |
| "type": "object" |
| } |
| }, |
| "type": "object" |
| }, |
| "PublicKey": { |
| "description": "A public SSH key, corresponding to a private SSH key held by the client.", |
| "id": "PublicKey", |
| "properties": { |
| "format": { |
| "description": "Required. Format of this key's content.", |
| "enum": [ |
| "FORMAT_UNSPECIFIED", |
| "SSH_DSS", |
| "SSH_RSA", |
| "ECDSA_SHA2_NISTP256", |
| "ECDSA_SHA2_NISTP384", |
| "ECDSA_SHA2_NISTP521" |
| ], |
| "enumDescriptions": [ |
| "Unknown format. Do not use.", |
| "`ssh-dss` key format (see RFC4253).", |
| "`ssh-rsa` key format (see RFC4253).", |
| "`ecdsa-sha2-nistp256` key format (see RFC5656).", |
| "`ecdsa-sha2-nistp384` key format (see RFC5656).", |
| "`ecdsa-sha2-nistp521` key format (see RFC5656)." |
| ], |
| "type": "string" |
| }, |
| "key": { |
| "description": "Required. Content of this key.", |
| "format": "byte", |
| "type": "string" |
| }, |
| "name": { |
| "description": "Output only. Full name of this resource, in the format\n`users/{owner_email}/environments/{environment_id}/publicKeys/{key_id}`.\n`{owner_email}` is the email address of the user to whom the key belongs.\n`{environment_id}` is the identifier of the environment to which the key\ngrants access. `{key_id}` is the unique identifier of the key. For example,\n`users/someone@example.com/environments/default/publicKeys/myKey`.", |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "StartEnvironmentMetadata": { |
| "description": "Message included in the metadata field of operations returned from\nStartEnvironment.", |
| "id": "StartEnvironmentMetadata", |
| "properties": { |
| "state": { |
| "description": "Current state of the environment being started.", |
| "enum": [ |
| "STATE_UNSPECIFIED", |
| "STARTING", |
| "UNARCHIVING_DISK", |
| "FINISHED" |
| ], |
| "enumDescriptions": [ |
| "The environment's start state is unknown.", |
| "The environment is in the process of being started, but no additional\ndetails are available.", |
| "Startup is waiting for the user's disk to be unarchived. This can happen\nwhen the user returns to Cloud Shell after not having used it for a\nwhile, and suggests that startup will take longer than normal.", |
| "Startup is complete and the user should be able to establish an SSH\nconnection to their environment." |
| ], |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "StartEnvironmentResponse": { |
| "description": "Message included in the response field of operations returned from\nStartEnvironment once the\noperation is complete.", |
| "id": "StartEnvironmentResponse", |
| "properties": { |
| "environment": { |
| "$ref": "Environment", |
| "description": "Environment that was started." |
| } |
| }, |
| "type": "object" |
| }, |
| "Status": { |
| "description": "The `Status` type defines a logical error model that is suitable for\ndifferent programming environments, including REST APIs and RPC APIs. It is\nused by [gRPC](https://github.com/grpc). Each `Status` message contains\nthree pieces of data: error code, error message, and error details.\n\nYou can find out more about this error model and how to work with it in the\n[API Design Guide](https://cloud.google.com/apis/design/errors).", |
| "id": "Status", |
| "properties": { |
| "code": { |
| "description": "The status code, which should be an enum value of google.rpc.Code.", |
| "format": "int32", |
| "type": "integer" |
| }, |
| "details": { |
| "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.", |
| "items": { |
| "additionalProperties": { |
| "description": "Properties of the object. Contains field @type with type URL.", |
| "type": "any" |
| }, |
| "type": "object" |
| }, |
| "type": "array" |
| }, |
| "message": { |
| "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.", |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| } |
| }, |
| "servicePath": "", |
| "title": "Cloud Shell API", |
| "version": "v1", |
| "version_module": true |
| } |
