-- Hoogle documentation, generated by Haddock -- See Hoogle, http://www.haskell.org/hoogle/ -- | Google Cloud Shell SDK. -- -- Allows users to start, configure, and connect to interactive shell -- sessions running in the cloud. -- -- Warning: This is an experimental prototype/preview release -- which is still under exploratory development and not intended for -- public use, caveat emptor! -- -- This library is compatible with version v1 of the API. @package gogol-cloudshell @version 0.5.0 module Network.Google.CloudShell.Types -- | Default request referring to version v1 of the Cloud Shell -- API. This contains the host and root path used as a starting point for -- constructing service requests. cloudShellService :: ServiceConfig -- | View and manage your data across Google Cloud Platform services cloudPlatformScope :: Proxy '["https://www.googleapis.com/auth/cloud-platform"] -- | The `Status` type defines a logical error model that is suitable for -- different programming environments, including REST APIs and RPC APIs. -- It is used by gRPC. The error model is designed to be: - Simple -- to use and understand for most users - Flexible enough to meet -- unexpected needs # Overview The `Status` message contains three pieces -- of data: error code, error message, and error details. The error code -- should be an enum value of google.rpc.Code, but it may accept -- additional error codes if needed. The error message should be a -- developer-facing English message that helps developers *understand* -- and *resolve* the error. If a localized user-facing error message is -- needed, put the localized message in the error details or localize it -- in the client. The optional error details may contain arbitrary -- information about the error. There is a predefined set of error detail -- types in the package `google.rpc` that can be used for common error -- conditions. # Language mapping The `Status` message is the logical -- representation of the error model, but it is not necessarily the -- actual wire format. When the `Status` message is exposed in different -- client libraries and different wire protocols, it can be mapped -- differently. For example, it will likely be mapped to some exceptions -- in Java, but more likely mapped to some error codes in C. # Other uses -- The error model and the `Status` message can be used in a variety of -- environments, either with or without APIs, to provide a consistent -- developer experience across different environments. Example uses of -- this error model include: - Partial errors. If a service needs to -- return partial errors to the client, it may embed the `Status` in the -- normal response to indicate the partial errors. - Workflow errors. A -- typical workflow has multiple steps. Each step may have a `Status` -- message for error reporting. - Batch operations. If a client uses -- batch request and batch response, the `Status` message should be used -- directly inside batch response, one for each error sub-response. - -- Asynchronous operations. If an API call embeds asynchronous operation -- results in its response, the status of those operations should be -- represented directly using the `Status` message. - Logging. If some -- API errors are stored in logs, the message `Status` could be used -- directly after any stripping needed for security/privacy reasons. -- -- See: status smart constructor. data Status -- | Creates a value of Status with the minimum fields required to -- make a request. -- -- Use one of the following lenses to modify other fields as desired: -- -- status :: Status -- | A list of messages that carry the error details. There is a common set -- of message types for APIs to use. sDetails :: Lens' Status [StatusDetailsItem] -- | The status code, which should be an enum value of google.rpc.Code. sCode :: Lens' Status (Maybe Int32) -- | A developer-facing error message, which should be in English. Any -- user-facing error message should be localized and sent in the -- google.rpc.Status.details field, or localized by the client. sMessage :: Lens' Status (Maybe Text) -- | The response message for Operations.ListOperations. -- -- See: listOperationsResponse smart constructor. data ListOperationsResponse -- | Creates a value of ListOperationsResponse with the minimum -- fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: -- -- listOperationsResponse :: ListOperationsResponse -- | The standard List next-page token. lorNextPageToken :: Lens' ListOperationsResponse (Maybe Text) -- | A list of operations that matches the specified filter in the request. lorOperations :: Lens' ListOperationsResponse [Operation] -- | The request message for Operations.CancelOperation. -- -- See: cancelOperationRequest smart constructor. data CancelOperationRequest -- | Creates a value of CancelOperationRequest with the minimum -- fields required to make a request. cancelOperationRequest :: CancelOperationRequest -- | This resource represents a long-running operation that is the result -- of a network API call. -- -- See: operation smart constructor. data Operation -- | Creates a value of Operation with the minimum fields required -- to make a request. -- -- Use one of the following lenses to modify other fields as desired: -- -- operation :: Operation -- | If the value is `false`, it means the operation is still in progress. -- If `true`, the operation is completed, and either `error` or -- `response` is available. oDone :: Lens' Operation (Maybe Bool) -- | The error result of the operation in case of failure or cancellation. oError :: Lens' Operation (Maybe Status) -- | The normal response of the operation in case of success. If the -- original method returns no data on success, such as `Delete`, the -- response is `google.protobuf.Empty`. If the original method is -- standard `Get`/`Create`/`Update`, the response should be the resource. -- For other methods, the response should have the type `XxxResponse`, -- where `Xxx` is the original method name. For example, if the original -- method name is `TakeSnapshot()`, the inferred response type is -- `TakeSnapshotResponse`. oResponse :: Lens' Operation (Maybe OperationResponse) -- | The server-assigned name, which is only unique within the same service -- that originally returns it. If you use the default HTTP mapping, the -- `name` should have the format of `operations/some/unique/name`. oName :: Lens' Operation (Maybe Text) -- | Service-specific metadata associated with the operation. It typically -- contains progress information and common metadata such as create time. -- Some services might not provide such metadata. Any method that returns -- a long-running operation should document the metadata type, if any. oMetadata :: Lens' Operation (Maybe OperationMetadata) -- | A generic empty message that you can re-use to avoid defining -- duplicated empty messages in your APIs. A typical example is to use it -- as the request or the response type of an API method. For instance: -- service Foo { rpc Bar(google.protobuf.Empty) returns -- (google.protobuf.Empty); } The JSON representation for `Empty` is -- empty JSON object `{}`. -- -- See: empty smart constructor. data Empty -- | Creates a value of Empty with the minimum fields required to -- make a request. empty :: Empty -- | A Cloud Shell environment, which is defined as the combination of a -- Docker image specifying what is installed on the environment and a -- home directory containing the user's data that will remain across -- sessions. Each user has a single environment with the ID "default". -- -- See: environment smart constructor. data Environment -- | Creates a value of Environment with the minimum fields required -- to make a request. -- -- Use one of the following lenses to modify other fields as desired: -- -- environment :: Environment -- | Output only. Current execution state of this environment. eState :: Lens' Environment (Maybe EnvironmentState) -- | Output only. Public keys associated with the environment. Clients can -- connect to this environment via SSH only if they possess a private key -- corresponding to at least one of these public keys. Keys can be added -- to or removed from the environment using the CreatePublicKey and -- DeletePublicKey methods. ePublicKeys :: Lens' Environment [PublicKey] -- | Output only. Username that clients should use when initiating SSH -- sessions with the environment. eSSHUsername :: Lens' Environment (Maybe Text) -- | Output only. Full name of this resource, in the format -- `users/{owner_email}/environments/{environment_id}`. `{owner_email}` -- is the email address of the user to whom this environment belongs, and -- `{environment_id}` is the identifier of this environment. For example, -- `users/someone'example.com/environments/default`. eName :: Lens' Environment (Maybe Text) -- | Output only. The environment's identifier, which is always "default". eId :: Lens' Environment (Maybe Text) -- | Output only. Host to which clients can connect to initiate SSH -- sessions with the environment. eSSHHost :: Lens' Environment (Maybe Text) -- | Required. Full path to the Docker image used to run this environment, -- e.g. "gcr.io/dev-con/cloud-devshell:latest". eDockerImage :: Lens' Environment (Maybe Text) -- | Output only. Port to which clients can connect to initiate SSH -- sessions with the environment. eSSHPort :: Lens' Environment (Maybe Int32) data StatusDetailsItem -- | Creates a value of StatusDetailsItem with the minimum fields -- required to make a request. -- -- Use one of the following lenses to modify other fields as desired: -- -- statusDetailsItem :: HashMap Text JSONValue -> StatusDetailsItem -- | Properties of the object. Contains field 'type with type URL. sdiAddtional :: Lens' StatusDetailsItem (HashMap Text JSONValue) -- | A public SSH key, corresponding to a private SSH key held by the -- client. -- -- See: publicKey smart constructor. data PublicKey -- | Creates a value of PublicKey with the minimum fields required -- to make a request. -- -- Use one of the following lenses to modify other fields as desired: -- -- publicKey :: PublicKey -- | Required. Format of this key's content. pkFormat :: Lens' PublicKey (Maybe PublicKeyFormat) -- | Required. Content of this key. pkKey :: Lens' PublicKey (Maybe ByteString) -- | Output only. Full name of this resource, in the format -- `users/{owner_email}/environments/{environment_id}/publicKeys/{key_id}`. -- `{owner_email}` is the email address of the user to whom the key -- belongs. `{environment_id}` is the identifier of the environment to -- which the key grants access. `{key_id}` is the unique identifier of -- the key. For example, -- `users/someone'example.com/environments/default/publicKeys/myKey`. pkName :: Lens' PublicKey (Maybe Text) -- | Current state of the environment being started. data StartEnvironmentMetadataState -- | STATE_UNSPECIFIED The environment's start state is unknown. StateUnspecified :: StartEnvironmentMetadataState -- | STARTING The environment is in the process of being started, -- but no additional details are available. Starting :: StartEnvironmentMetadataState -- | UNARCHIVING_DISK Startup is waiting for the user's disk to be -- unarchived. This can happen when the user returns to Cloud Shell after -- not having used it for a while, and suggests that startup will take -- longer than normal. UnarchivingDisk :: StartEnvironmentMetadataState -- | FINISHED Startup is complete and the user should be able to -- establish an SSH connection to their environment. Finished :: StartEnvironmentMetadataState -- | Output only. Current execution state of this environment. data EnvironmentState -- | STATE_UNSPECIFIED The environment's states is unknown. ESStateUnspecified :: EnvironmentState -- | DISABLED The environment is not running and can't be -- connected to. Starting the environment will transition it to the -- STARTING state. ESDisabled :: EnvironmentState -- | STARTING The environment is being started but is not yet -- ready to accept connections. ESStarting :: EnvironmentState -- | RUNNING The environment is running and ready to accept -- connections. It will automatically transition back to DISABLED after a -- period of inactivity or if another environment is started. ESRunning :: EnvironmentState -- | V1 error format. data Xgafv -- | 1 v1 error format X1 :: Xgafv -- | 2 v2 error format X2 :: Xgafv -- | Required. Format of this key's content. data PublicKeyFormat -- | FORMAT_UNSPECIFIED Unknown format. Do not use. FormatUnspecified :: PublicKeyFormat -- | SSH_DSS `ssh-dss` key format (see RFC4253). SSHDss :: PublicKeyFormat -- | SSH_RSA `ssh-rsa` key format (see RFC4253). SSHRsa :: PublicKeyFormat -- | ECDSA_SHA2_NISTP256 `ecdsa-sha2-nistp256` key format (see -- RFC5656). EcdsaSHA2NISTP256 :: PublicKeyFormat -- | ECDSA_SHA2_NISTP384 `ecdsa-sha2-nistp384` key format (see -- RFC5656). EcdsaSHA2NISTP384 :: PublicKeyFormat -- | ECDSA_SHA2_NISTP521 `ecdsa-sha2-nistp521` key format (see -- RFC5656). EcdsaSHA2NISTP521 :: PublicKeyFormat -- | Message included in the metadata field of operations returned from -- StartEnvironment. -- -- See: startEnvironmentMetadata smart constructor. data StartEnvironmentMetadata -- | Creates a value of StartEnvironmentMetadata with the minimum -- fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: -- -- startEnvironmentMetadata :: StartEnvironmentMetadata -- | Current state of the environment being started. semState :: Lens' StartEnvironmentMetadata (Maybe StartEnvironmentMetadataState) -- | Service-specific metadata associated with the operation. It typically -- contains progress information and common metadata such as create time. -- Some services might not provide such metadata. Any method that returns -- a long-running operation should document the metadata type, if any. -- -- See: operationMetadata smart constructor. data OperationMetadata -- | Creates a value of OperationMetadata with the minimum fields -- required to make a request. -- -- Use one of the following lenses to modify other fields as desired: -- -- operationMetadata :: HashMap Text JSONValue -> OperationMetadata -- | Properties of the object. Contains field 'type with type URL. omAddtional :: Lens' OperationMetadata (HashMap Text JSONValue) -- | Message included in the response field of operations returned from -- StartEnvironment once the operation is complete. -- -- See: startEnvironmentResponse smart constructor. data StartEnvironmentResponse -- | Creates a value of StartEnvironmentResponse with the minimum -- fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: -- -- startEnvironmentResponse :: StartEnvironmentResponse -- | Environment that was started. serEnvironment :: Lens' StartEnvironmentResponse (Maybe Environment) -- | The normal response of the operation in case of success. If the -- original method returns no data on success, such as `Delete`, the -- response is `google.protobuf.Empty`. If the original method is -- standard `Get`/`Create`/`Update`, the response should be the resource. -- For other methods, the response should have the type `XxxResponse`, -- where `Xxx` is the original method name. For example, if the original -- method name is `TakeSnapshot()`, the inferred response type is -- `TakeSnapshotResponse`. -- -- See: operationResponse smart constructor. data OperationResponse -- | Creates a value of OperationResponse with the minimum fields -- required to make a request. -- -- Use one of the following lenses to modify other fields as desired: -- -- operationResponse :: HashMap Text JSONValue -> OperationResponse -- | Properties of the object. Contains field 'type with type URL. orAddtional :: Lens' OperationResponse (HashMap Text JSONValue) -- | 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`. -- -- See: Cloud Shell API Reference for -- cloudshell.operations.cancel. module Network.Google.Resource.CloudShell.Operations.Cancel -- | A resource alias for cloudshell.operations.cancel method -- which the OperationsCancel request conforms to. type OperationsCancelResource = "v1" :> CaptureMode "name" "cancel" Text :> QueryParam "$.xgafv" Xgafv :> QueryParam "upload_protocol" Text :> QueryParam "access_token" Text :> QueryParam "uploadType" Text :> QueryParam "callback" Text :> QueryParam "alt" AltJSON :> ReqBody '[JSON] CancelOperationRequest :> Post '[JSON] Empty -- | Creates a value of OperationsCancel with the minimum fields -- required to make a request. -- -- Use one of the following lenses to modify other fields as desired: -- -- operationsCancel :: CancelOperationRequest -> Text -> OperationsCancel -- | 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`. -- -- See: operationsCancel smart constructor. data OperationsCancel -- | V1 error format. ocXgafv :: Lens' OperationsCancel (Maybe Xgafv) -- | Upload protocol for media (e.g. "raw", "multipart"). ocUploadProtocol :: Lens' OperationsCancel (Maybe Text) -- | OAuth access token. ocAccessToken :: Lens' OperationsCancel (Maybe Text) -- | Legacy upload protocol for media (e.g. "media", "multipart"). ocUploadType :: Lens' OperationsCancel (Maybe Text) -- | Multipart request metadata. ocPayload :: Lens' OperationsCancel CancelOperationRequest -- | The name of the operation resource to be cancelled. ocName :: Lens' OperationsCancel Text -- | JSONP ocCallback :: Lens' OperationsCancel (Maybe Text) instance GHC.Generics.Generic Network.Google.Resource.CloudShell.Operations.Cancel.OperationsCancel instance Data.Data.Data Network.Google.Resource.CloudShell.Operations.Cancel.OperationsCancel instance GHC.Show.Show Network.Google.Resource.CloudShell.Operations.Cancel.OperationsCancel instance GHC.Classes.Eq Network.Google.Resource.CloudShell.Operations.Cancel.OperationsCancel instance Network.Google.Types.GoogleRequest Network.Google.Resource.CloudShell.Operations.Cancel.OperationsCancel -- | 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`. -- -- See: Cloud Shell API Reference for -- cloudshell.operations.delete. module Network.Google.Resource.CloudShell.Operations.Delete -- | A resource alias for cloudshell.operations.delete method -- which the OperationsDelete request conforms to. type OperationsDeleteResource = "v1" :> Capture "name" Text :> QueryParam "$.xgafv" Xgafv :> QueryParam "upload_protocol" Text :> QueryParam "access_token" Text :> QueryParam "uploadType" Text :> QueryParam "callback" Text :> QueryParam "alt" AltJSON :> Delete '[JSON] Empty -- | Creates a value of OperationsDelete with the minimum fields -- required to make a request. -- -- Use one of the following lenses to modify other fields as desired: -- -- operationsDelete :: Text -> OperationsDelete -- | 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`. -- -- See: operationsDelete smart constructor. data OperationsDelete -- | V1 error format. odXgafv :: Lens' OperationsDelete (Maybe Xgafv) -- | Upload protocol for media (e.g. "raw", "multipart"). odUploadProtocol :: Lens' OperationsDelete (Maybe Text) -- | OAuth access token. odAccessToken :: Lens' OperationsDelete (Maybe Text) -- | Legacy upload protocol for media (e.g. "media", "multipart"). odUploadType :: Lens' OperationsDelete (Maybe Text) -- | The name of the operation resource to be deleted. odName :: Lens' OperationsDelete Text -- | JSONP odCallback :: Lens' OperationsDelete (Maybe Text) instance GHC.Generics.Generic Network.Google.Resource.CloudShell.Operations.Delete.OperationsDelete instance Data.Data.Data Network.Google.Resource.CloudShell.Operations.Delete.OperationsDelete instance GHC.Show.Show Network.Google.Resource.CloudShell.Operations.Delete.OperationsDelete instance GHC.Classes.Eq Network.Google.Resource.CloudShell.Operations.Delete.OperationsDelete instance Network.Google.Types.GoogleRequest Network.Google.Resource.CloudShell.Operations.Delete.OperationsDelete -- | 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. -- -- See: Cloud Shell API Reference for -- cloudshell.operations.get. module Network.Google.Resource.CloudShell.Operations.Get -- | A resource alias for cloudshell.operations.get method which -- the OperationsGet request conforms to. type OperationsGetResource = "v1" :> Capture "name" Text :> QueryParam "$.xgafv" Xgafv :> QueryParam "upload_protocol" Text :> QueryParam "access_token" Text :> QueryParam "uploadType" Text :> QueryParam "callback" Text :> QueryParam "alt" AltJSON :> Get '[JSON] Operation -- | Creates a value of OperationsGet with the minimum fields -- required to make a request. -- -- Use one of the following lenses to modify other fields as desired: -- -- operationsGet :: Text -> OperationsGet -- | 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. -- -- See: operationsGet smart constructor. data OperationsGet -- | V1 error format. ogXgafv :: Lens' OperationsGet (Maybe Xgafv) -- | Upload protocol for media (e.g. "raw", "multipart"). ogUploadProtocol :: Lens' OperationsGet (Maybe Text) -- | OAuth access token. ogAccessToken :: Lens' OperationsGet (Maybe Text) -- | Legacy upload protocol for media (e.g. "media", "multipart"). ogUploadType :: Lens' OperationsGet (Maybe Text) -- | The name of the operation resource. ogName :: Lens' OperationsGet Text -- | JSONP ogCallback :: Lens' OperationsGet (Maybe Text) instance GHC.Generics.Generic Network.Google.Resource.CloudShell.Operations.Get.OperationsGet instance Data.Data.Data Network.Google.Resource.CloudShell.Operations.Get.OperationsGet instance GHC.Show.Show Network.Google.Resource.CloudShell.Operations.Get.OperationsGet instance GHC.Classes.Eq Network.Google.Resource.CloudShell.Operations.Get.OperationsGet instance Network.Google.Types.GoogleRequest Network.Google.Resource.CloudShell.Operations.Get.OperationsGet -- | 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. -- -- See: Cloud Shell API Reference for -- cloudshell.operations.list. module Network.Google.Resource.CloudShell.Operations.List -- | A resource alias for cloudshell.operations.list method which -- the OperationsList request conforms to. type OperationsListResource = "v1" :> Capture "name" Text :> QueryParam "$.xgafv" Xgafv :> QueryParam "upload_protocol" Text :> QueryParam "access_token" Text :> QueryParam "uploadType" Text :> QueryParam "filter" Text :> QueryParam "pageToken" Text :> QueryParam "pageSize" (Textual Int32) :> QueryParam "callback" Text :> QueryParam "alt" AltJSON :> Get '[JSON] ListOperationsResponse -- | Creates a value of OperationsList with the minimum fields -- required to make a request. -- -- Use one of the following lenses to modify other fields as desired: -- -- operationsList :: Text -> OperationsList -- | 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. -- -- See: operationsList smart constructor. data OperationsList -- | V1 error format. olXgafv :: Lens' OperationsList (Maybe Xgafv) -- | Upload protocol for media (e.g. "raw", "multipart"). olUploadProtocol :: Lens' OperationsList (Maybe Text) -- | OAuth access token. olAccessToken :: Lens' OperationsList (Maybe Text) -- | Legacy upload protocol for media (e.g. "media", "multipart"). olUploadType :: Lens' OperationsList (Maybe Text) -- | The name of the operation's parent resource. olName :: Lens' OperationsList Text -- | The standard list filter. olFilter :: Lens' OperationsList (Maybe Text) -- | The standard list page token. olPageToken :: Lens' OperationsList (Maybe Text) -- | The standard list page size. olPageSize :: Lens' OperationsList (Maybe Int32) -- | JSONP olCallback :: Lens' OperationsList (Maybe Text) instance GHC.Generics.Generic Network.Google.Resource.CloudShell.Operations.List.OperationsList instance Data.Data.Data Network.Google.Resource.CloudShell.Operations.List.OperationsList instance GHC.Show.Show Network.Google.Resource.CloudShell.Operations.List.OperationsList instance GHC.Classes.Eq Network.Google.Resource.CloudShell.Operations.List.OperationsList instance Network.Google.Types.GoogleRequest Network.Google.Resource.CloudShell.Operations.List.OperationsList -- | Allows users to start, configure, and connect to interactive shell -- sessions running in the cloud. -- -- See: Cloud Shell API Reference module Network.Google.CloudShell -- | Default request referring to version v1 of the Cloud Shell -- API. This contains the host and root path used as a starting point for -- constructing service requests. cloudShellService :: ServiceConfig -- | View and manage your data across Google Cloud Platform services cloudPlatformScope :: Proxy '["https://www.googleapis.com/auth/cloud-platform"] -- | Represents the entirety of the methods and resources available for the -- Cloud Shell API service. type CloudShellAPI = OperationsListResource :<|> OperationsGetResource :<|> OperationsCancelResource :<|> OperationsDeleteResource -- | The `Status` type defines a logical error model that is suitable for -- different programming environments, including REST APIs and RPC APIs. -- It is used by gRPC. The error model is designed to be: - Simple -- to use and understand for most users - Flexible enough to meet -- unexpected needs # Overview The `Status` message contains three pieces -- of data: error code, error message, and error details. The error code -- should be an enum value of google.rpc.Code, but it may accept -- additional error codes if needed. The error message should be a -- developer-facing English message that helps developers *understand* -- and *resolve* the error. If a localized user-facing error message is -- needed, put the localized message in the error details or localize it -- in the client. The optional error details may contain arbitrary -- information about the error. There is a predefined set of error detail -- types in the package `google.rpc` that can be used for common error -- conditions. # Language mapping The `Status` message is the logical -- representation of the error model, but it is not necessarily the -- actual wire format. When the `Status` message is exposed in different -- client libraries and different wire protocols, it can be mapped -- differently. For example, it will likely be mapped to some exceptions -- in Java, but more likely mapped to some error codes in C. # Other uses -- The error model and the `Status` message can be used in a variety of -- environments, either with or without APIs, to provide a consistent -- developer experience across different environments. Example uses of -- this error model include: - Partial errors. If a service needs to -- return partial errors to the client, it may embed the `Status` in the -- normal response to indicate the partial errors. - Workflow errors. A -- typical workflow has multiple steps. Each step may have a `Status` -- message for error reporting. - Batch operations. If a client uses -- batch request and batch response, the `Status` message should be used -- directly inside batch response, one for each error sub-response. - -- Asynchronous operations. If an API call embeds asynchronous operation -- results in its response, the status of those operations should be -- represented directly using the `Status` message. - Logging. If some -- API errors are stored in logs, the message `Status` could be used -- directly after any stripping needed for security/privacy reasons. -- -- See: status smart constructor. data Status -- | Creates a value of Status with the minimum fields required to -- make a request. -- -- Use one of the following lenses to modify other fields as desired: -- -- status :: Status -- | A list of messages that carry the error details. There is a common set -- of message types for APIs to use. sDetails :: Lens' Status [StatusDetailsItem] -- | The status code, which should be an enum value of google.rpc.Code. sCode :: Lens' Status (Maybe Int32) -- | A developer-facing error message, which should be in English. Any -- user-facing error message should be localized and sent in the -- google.rpc.Status.details field, or localized by the client. sMessage :: Lens' Status (Maybe Text) -- | The response message for Operations.ListOperations. -- -- See: listOperationsResponse smart constructor. data ListOperationsResponse -- | Creates a value of ListOperationsResponse with the minimum -- fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: -- -- listOperationsResponse :: ListOperationsResponse -- | The standard List next-page token. lorNextPageToken :: Lens' ListOperationsResponse (Maybe Text) -- | A list of operations that matches the specified filter in the request. lorOperations :: Lens' ListOperationsResponse [Operation] -- | The request message for Operations.CancelOperation. -- -- See: cancelOperationRequest smart constructor. data CancelOperationRequest -- | Creates a value of CancelOperationRequest with the minimum -- fields required to make a request. cancelOperationRequest :: CancelOperationRequest -- | This resource represents a long-running operation that is the result -- of a network API call. -- -- See: operation smart constructor. data Operation -- | Creates a value of Operation with the minimum fields required -- to make a request. -- -- Use one of the following lenses to modify other fields as desired: -- -- operation :: Operation -- | If the value is `false`, it means the operation is still in progress. -- If `true`, the operation is completed, and either `error` or -- `response` is available. oDone :: Lens' Operation (Maybe Bool) -- | The error result of the operation in case of failure or cancellation. oError :: Lens' Operation (Maybe Status) -- | The normal response of the operation in case of success. If the -- original method returns no data on success, such as `Delete`, the -- response is `google.protobuf.Empty`. If the original method is -- standard `Get`/`Create`/`Update`, the response should be the resource. -- For other methods, the response should have the type `XxxResponse`, -- where `Xxx` is the original method name. For example, if the original -- method name is `TakeSnapshot()`, the inferred response type is -- `TakeSnapshotResponse`. oResponse :: Lens' Operation (Maybe OperationResponse) -- | The server-assigned name, which is only unique within the same service -- that originally returns it. If you use the default HTTP mapping, the -- `name` should have the format of `operations/some/unique/name`. oName :: Lens' Operation (Maybe Text) -- | Service-specific metadata associated with the operation. It typically -- contains progress information and common metadata such as create time. -- Some services might not provide such metadata. Any method that returns -- a long-running operation should document the metadata type, if any. oMetadata :: Lens' Operation (Maybe OperationMetadata) -- | A generic empty message that you can re-use to avoid defining -- duplicated empty messages in your APIs. A typical example is to use it -- as the request or the response type of an API method. For instance: -- service Foo { rpc Bar(google.protobuf.Empty) returns -- (google.protobuf.Empty); } The JSON representation for `Empty` is -- empty JSON object `{}`. -- -- See: empty smart constructor. data Empty -- | Creates a value of Empty with the minimum fields required to -- make a request. empty :: Empty -- | A Cloud Shell environment, which is defined as the combination of a -- Docker image specifying what is installed on the environment and a -- home directory containing the user's data that will remain across -- sessions. Each user has a single environment with the ID "default". -- -- See: environment smart constructor. data Environment -- | Creates a value of Environment with the minimum fields required -- to make a request. -- -- Use one of the following lenses to modify other fields as desired: -- -- environment :: Environment -- | Output only. Current execution state of this environment. eState :: Lens' Environment (Maybe EnvironmentState) -- | Output only. Public keys associated with the environment. Clients can -- connect to this environment via SSH only if they possess a private key -- corresponding to at least one of these public keys. Keys can be added -- to or removed from the environment using the CreatePublicKey and -- DeletePublicKey methods. ePublicKeys :: Lens' Environment [PublicKey] -- | Output only. Username that clients should use when initiating SSH -- sessions with the environment. eSSHUsername :: Lens' Environment (Maybe Text) -- | Output only. Full name of this resource, in the format -- `users/{owner_email}/environments/{environment_id}`. `{owner_email}` -- is the email address of the user to whom this environment belongs, and -- `{environment_id}` is the identifier of this environment. For example, -- `users/someone'example.com/environments/default`. eName :: Lens' Environment (Maybe Text) -- | Output only. The environment's identifier, which is always "default". eId :: Lens' Environment (Maybe Text) -- | Output only. Host to which clients can connect to initiate SSH -- sessions with the environment. eSSHHost :: Lens' Environment (Maybe Text) -- | Required. Full path to the Docker image used to run this environment, -- e.g. "gcr.io/dev-con/cloud-devshell:latest". eDockerImage :: Lens' Environment (Maybe Text) -- | Output only. Port to which clients can connect to initiate SSH -- sessions with the environment. eSSHPort :: Lens' Environment (Maybe Int32) data StatusDetailsItem -- | Creates a value of StatusDetailsItem with the minimum fields -- required to make a request. -- -- Use one of the following lenses to modify other fields as desired: -- -- statusDetailsItem :: HashMap Text JSONValue -> StatusDetailsItem -- | Properties of the object. Contains field 'type with type URL. sdiAddtional :: Lens' StatusDetailsItem (HashMap Text JSONValue) -- | A public SSH key, corresponding to a private SSH key held by the -- client. -- -- See: publicKey smart constructor. data PublicKey -- | Creates a value of PublicKey with the minimum fields required -- to make a request. -- -- Use one of the following lenses to modify other fields as desired: -- -- publicKey :: PublicKey -- | Required. Format of this key's content. pkFormat :: Lens' PublicKey (Maybe PublicKeyFormat) -- | Required. Content of this key. pkKey :: Lens' PublicKey (Maybe ByteString) -- | Output only. Full name of this resource, in the format -- `users/{owner_email}/environments/{environment_id}/publicKeys/{key_id}`. -- `{owner_email}` is the email address of the user to whom the key -- belongs. `{environment_id}` is the identifier of the environment to -- which the key grants access. `{key_id}` is the unique identifier of -- the key. For example, -- `users/someone'example.com/environments/default/publicKeys/myKey`. pkName :: Lens' PublicKey (Maybe Text) -- | Current state of the environment being started. data StartEnvironmentMetadataState -- | STATE_UNSPECIFIED The environment's start state is unknown. StateUnspecified :: StartEnvironmentMetadataState -- | STARTING The environment is in the process of being started, -- but no additional details are available. Starting :: StartEnvironmentMetadataState -- | UNARCHIVING_DISK Startup is waiting for the user's disk to be -- unarchived. This can happen when the user returns to Cloud Shell after -- not having used it for a while, and suggests that startup will take -- longer than normal. UnarchivingDisk :: StartEnvironmentMetadataState -- | FINISHED Startup is complete and the user should be able to -- establish an SSH connection to their environment. Finished :: StartEnvironmentMetadataState -- | Output only. Current execution state of this environment. data EnvironmentState -- | STATE_UNSPECIFIED The environment's states is unknown. ESStateUnspecified :: EnvironmentState -- | DISABLED The environment is not running and can't be -- connected to. Starting the environment will transition it to the -- STARTING state. ESDisabled :: EnvironmentState -- | STARTING The environment is being started but is not yet -- ready to accept connections. ESStarting :: EnvironmentState -- | RUNNING The environment is running and ready to accept -- connections. It will automatically transition back to DISABLED after a -- period of inactivity or if another environment is started. ESRunning :: EnvironmentState -- | V1 error format. data Xgafv -- | 1 v1 error format X1 :: Xgafv -- | 2 v2 error format X2 :: Xgafv -- | Required. Format of this key's content. data PublicKeyFormat -- | FORMAT_UNSPECIFIED Unknown format. Do not use. FormatUnspecified :: PublicKeyFormat -- | SSH_DSS `ssh-dss` key format (see RFC4253). SSHDss :: PublicKeyFormat -- | SSH_RSA `ssh-rsa` key format (see RFC4253). SSHRsa :: PublicKeyFormat -- | ECDSA_SHA2_NISTP256 `ecdsa-sha2-nistp256` key format (see -- RFC5656). EcdsaSHA2NISTP256 :: PublicKeyFormat -- | ECDSA_SHA2_NISTP384 `ecdsa-sha2-nistp384` key format (see -- RFC5656). EcdsaSHA2NISTP384 :: PublicKeyFormat -- | ECDSA_SHA2_NISTP521 `ecdsa-sha2-nistp521` key format (see -- RFC5656). EcdsaSHA2NISTP521 :: PublicKeyFormat -- | Message included in the metadata field of operations returned from -- StartEnvironment. -- -- See: startEnvironmentMetadata smart constructor. data StartEnvironmentMetadata -- | Creates a value of StartEnvironmentMetadata with the minimum -- fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: -- -- startEnvironmentMetadata :: StartEnvironmentMetadata -- | Current state of the environment being started. semState :: Lens' StartEnvironmentMetadata (Maybe StartEnvironmentMetadataState) -- | Service-specific metadata associated with the operation. It typically -- contains progress information and common metadata such as create time. -- Some services might not provide such metadata. Any method that returns -- a long-running operation should document the metadata type, if any. -- -- See: operationMetadata smart constructor. data OperationMetadata -- | Creates a value of OperationMetadata with the minimum fields -- required to make a request. -- -- Use one of the following lenses to modify other fields as desired: -- -- operationMetadata :: HashMap Text JSONValue -> OperationMetadata -- | Properties of the object. Contains field 'type with type URL. omAddtional :: Lens' OperationMetadata (HashMap Text JSONValue) -- | Message included in the response field of operations returned from -- StartEnvironment once the operation is complete. -- -- See: startEnvironmentResponse smart constructor. data StartEnvironmentResponse -- | Creates a value of StartEnvironmentResponse with the minimum -- fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: -- -- startEnvironmentResponse :: StartEnvironmentResponse -- | Environment that was started. serEnvironment :: Lens' StartEnvironmentResponse (Maybe Environment) -- | The normal response of the operation in case of success. If the -- original method returns no data on success, such as `Delete`, the -- response is `google.protobuf.Empty`. If the original method is -- standard `Get`/`Create`/`Update`, the response should be the resource. -- For other methods, the response should have the type `XxxResponse`, -- where `Xxx` is the original method name. For example, if the original -- method name is `TakeSnapshot()`, the inferred response type is -- `TakeSnapshotResponse`. -- -- See: operationResponse smart constructor. data OperationResponse -- | Creates a value of OperationResponse with the minimum fields -- required to make a request. -- -- Use one of the following lenses to modify other fields as desired: -- -- operationResponse :: HashMap Text JSONValue -> OperationResponse -- | Properties of the object. Contains field 'type with type URL. orAddtional :: Lens' OperationResponse (HashMap Text JSONValue)