Copyright | (c) 2015-2016 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Synopsis
- cloudShellService :: ServiceConfig
- cloudPlatformScope :: Proxy '["https://www.googleapis.com/auth/cloud-platform"]
- data Status
- status :: Status
- sDetails :: Lens' Status [StatusDetailsItem]
- sCode :: Lens' Status (Maybe Int32)
- sMessage :: Lens' Status (Maybe Text)
- data ListOperationsResponse
- listOperationsResponse :: ListOperationsResponse
- lorNextPageToken :: Lens' ListOperationsResponse (Maybe Text)
- lorOperations :: Lens' ListOperationsResponse [Operation]
- data CancelOperationRequest
- cancelOperationRequest :: CancelOperationRequest
- data Operation
- operation :: Operation
- oDone :: Lens' Operation (Maybe Bool)
- oError :: Lens' Operation (Maybe Status)
- oResponse :: Lens' Operation (Maybe OperationResponse)
- oName :: Lens' Operation (Maybe Text)
- oMetadata :: Lens' Operation (Maybe OperationMetadata)
- data Empty
- empty :: Empty
- data Environment
- environment :: Environment
- eState :: Lens' Environment (Maybe EnvironmentState)
- ePublicKeys :: Lens' Environment [PublicKey]
- eSSHUsername :: Lens' Environment (Maybe Text)
- eName :: Lens' Environment (Maybe Text)
- eId :: Lens' Environment (Maybe Text)
- eSSHHost :: Lens' Environment (Maybe Text)
- eDockerImage :: Lens' Environment (Maybe Text)
- eSSHPort :: Lens' Environment (Maybe Int32)
- data StatusDetailsItem
- statusDetailsItem :: HashMap Text JSONValue -> StatusDetailsItem
- sdiAddtional :: Lens' StatusDetailsItem (HashMap Text JSONValue)
- data PublicKey
- publicKey :: PublicKey
- pkFormat :: Lens' PublicKey (Maybe PublicKeyFormat)
- pkKey :: Lens' PublicKey (Maybe ByteString)
- pkName :: Lens' PublicKey (Maybe Text)
- data StartEnvironmentMetadataState
- data EnvironmentState
- data Xgafv
- data PublicKeyFormat
- data StartEnvironmentMetadata
- startEnvironmentMetadata :: StartEnvironmentMetadata
- semState :: Lens' StartEnvironmentMetadata (Maybe StartEnvironmentMetadataState)
- data OperationMetadata
- operationMetadata :: HashMap Text JSONValue -> OperationMetadata
- omAddtional :: Lens' OperationMetadata (HashMap Text JSONValue)
- data StartEnvironmentResponse
- startEnvironmentResponse :: StartEnvironmentResponse
- serEnvironment :: Lens' StartEnvironmentResponse (Maybe Environment)
- data OperationResponse
- operationResponse :: HashMap Text JSONValue -> OperationResponse
- orAddtional :: Lens' OperationResponse (HashMap Text JSONValue)
Service Configuration
cloudShellService :: ServiceConfig Source #
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.
OAuth Scopes
cloudPlatformScope :: Proxy '["https://www.googleapis.com/auth/cloud-platform"] Source #
View and manage your data across Google Cloud Platform services
Status
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.
Instances
Eq Status Source # | |
Data Status Source # | |
Defined in Network.Google.CloudShell.Types.Product gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Status -> c Status # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Status # toConstr :: Status -> Constr # dataTypeOf :: Status -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Status) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Status) # gmapT :: (forall b. Data b => b -> b) -> Status -> Status # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Status -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Status -> r # gmapQ :: (forall d. Data d => d -> u) -> Status -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Status -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Status -> m Status # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Status -> m Status # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Status -> m Status # | |
Show Status Source # | |
Generic Status Source # | |
ToJSON Status Source # | |
Defined in Network.Google.CloudShell.Types.Product | |
FromJSON Status Source # | |
type Rep Status Source # | |
Defined in Network.Google.CloudShell.Types.Product type Rep Status = D1 (MetaData "Status" "Network.Google.CloudShell.Types.Product" "gogol-cloudshell-0.5.0-K4s4rFmTUK5cFOLnOedD0" False) (C1 (MetaCons "Status'" PrefixI True) (S1 (MetaSel (Just "_sDetails") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [StatusDetailsItem])) :*: (S1 (MetaSel (Just "_sCode") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int32))) :*: S1 (MetaSel (Just "_sMessage") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) |
sDetails :: Lens' Status [StatusDetailsItem] Source #
A list of messages that carry the error details. There is a common set of message types for APIs to use.
sCode :: Lens' Status (Maybe Int32) Source #
The status code, which should be an enum value of google.rpc.Code.
sMessage :: Lens' Status (Maybe Text) Source #
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.
ListOperationsResponse
data ListOperationsResponse Source #
The response message for Operations.ListOperations.
See: listOperationsResponse
smart constructor.
Instances
listOperationsResponse :: ListOperationsResponse Source #
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:
lorNextPageToken :: Lens' ListOperationsResponse (Maybe Text) Source #
The standard List next-page token.
lorOperations :: Lens' ListOperationsResponse [Operation] Source #
A list of operations that matches the specified filter in the request.
CancelOperationRequest
data CancelOperationRequest Source #
The request message for Operations.CancelOperation.
See: cancelOperationRequest
smart constructor.
Instances
cancelOperationRequest :: CancelOperationRequest Source #
Creates a value of CancelOperationRequest
with the minimum fields required to make a request.
Operation
This resource represents a long-running operation that is the result of a network API call.
See: operation
smart constructor.
Instances
oDone :: Lens' Operation (Maybe Bool) Source #
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.
oError :: Lens' Operation (Maybe Status) Source #
The error result of the operation in case of failure or cancellation.
oResponse :: Lens' Operation (Maybe OperationResponse) Source #
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`.
oName :: Lens' Operation (Maybe Text) Source #
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`.
oMetadata :: Lens' Operation (Maybe OperationMetadata) Source #
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.
Empty
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.
Instances
Eq Empty Source # | |
Data Empty Source # | |
Defined in Network.Google.CloudShell.Types.Product gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Empty -> c Empty # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Empty # dataTypeOf :: Empty -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Empty) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Empty) # gmapT :: (forall b. Data b => b -> b) -> Empty -> Empty # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Empty -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Empty -> r # gmapQ :: (forall d. Data d => d -> u) -> Empty -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Empty -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Empty -> m Empty # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Empty -> m Empty # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Empty -> m Empty # | |
Show Empty Source # | |
Generic Empty Source # | |
ToJSON Empty Source # | |
Defined in Network.Google.CloudShell.Types.Product | |
FromJSON Empty Source # | |
type Rep Empty Source # | |
Environment
data Environment Source #
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.
Instances
environment :: Environment Source #
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:
eState :: Lens' Environment (Maybe EnvironmentState) Source #
Output only. Current execution state of this environment.
ePublicKeys :: Lens' Environment [PublicKey] Source #
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.
eSSHUsername :: Lens' Environment (Maybe Text) Source #
Output only. Username that clients should use when initiating SSH sessions with the environment.
eName :: Lens' Environment (Maybe Text) Source #
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`.
eId :: Lens' Environment (Maybe Text) Source #
Output only. The environment's identifier, which is always "default".
eSSHHost :: Lens' Environment (Maybe Text) Source #
Output only. Host to which clients can connect to initiate SSH sessions with the environment.
eDockerImage :: Lens' Environment (Maybe Text) Source #
Required. Full path to the Docker image used to run this environment, e.g. "gcr.io/dev-con/cloud-devshell:latest".
eSSHPort :: Lens' Environment (Maybe Int32) Source #
Output only. Port to which clients can connect to initiate SSH sessions with the environment.
StatusDetailsItem
data StatusDetailsItem Source #
Instances
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:
sdiAddtional :: Lens' StatusDetailsItem (HashMap Text JSONValue) Source #
Properties of the object. Contains field 'type with type URL.
PublicKey
A public SSH key, corresponding to a private SSH key held by the client.
See: publicKey
smart constructor.
Instances
Eq PublicKey Source # | |
Data PublicKey Source # | |
Defined in Network.Google.CloudShell.Types.Product gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> PublicKey -> c PublicKey # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c PublicKey # toConstr :: PublicKey -> Constr # dataTypeOf :: PublicKey -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c PublicKey) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c PublicKey) # gmapT :: (forall b. Data b => b -> b) -> PublicKey -> PublicKey # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> PublicKey -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> PublicKey -> r # gmapQ :: (forall d. Data d => d -> u) -> PublicKey -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> PublicKey -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> PublicKey -> m PublicKey # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> PublicKey -> m PublicKey # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> PublicKey -> m PublicKey # | |
Show PublicKey Source # | |
Generic PublicKey Source # | |
ToJSON PublicKey Source # | |
Defined in Network.Google.CloudShell.Types.Product | |
FromJSON PublicKey Source # | |
type Rep PublicKey Source # | |
Defined in Network.Google.CloudShell.Types.Product type Rep PublicKey = D1 (MetaData "PublicKey" "Network.Google.CloudShell.Types.Product" "gogol-cloudshell-0.5.0-K4s4rFmTUK5cFOLnOedD0" False) (C1 (MetaCons "PublicKey'" PrefixI True) (S1 (MetaSel (Just "_pkFormat") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe PublicKeyFormat)) :*: (S1 (MetaSel (Just "_pkKey") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bytes)) :*: S1 (MetaSel (Just "_pkName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) |
pkName :: Lens' PublicKey (Maybe Text) Source #
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`.
StartEnvironmentMetadataState
data StartEnvironmentMetadataState Source #
Current state of the environment being started.
StateUnspecified |
|
Starting |
|
UnarchivingDisk |
|
Finished |
|
Instances
EnvironmentState
data EnvironmentState Source #
Output only. Current execution state of this environment.
ESStateUnspecified |
|
ESDisabled |
|
ESStarting |
|
ESRunning |
|
Instances
Xgafv
V1 error format.
Instances
PublicKeyFormat
data PublicKeyFormat Source #
Required. Format of this key's content.
FormatUnspecified |
|
SSHDss |
|
SSHRsa |
|
EcdsaSHA2NISTP256 |
|
EcdsaSHA2NISTP384 |
|
EcdsaSHA2NISTP521 |
|
Instances
StartEnvironmentMetadata
data StartEnvironmentMetadata Source #
Message included in the metadata field of operations returned from StartEnvironment.
See: startEnvironmentMetadata
smart constructor.
Instances
startEnvironmentMetadata :: StartEnvironmentMetadata Source #
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:
semState :: Lens' StartEnvironmentMetadata (Maybe StartEnvironmentMetadataState) Source #
Current state of the environment being started.
OperationMetadata
data OperationMetadata Source #
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.
Instances
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:
omAddtional :: Lens' OperationMetadata (HashMap Text JSONValue) Source #
Properties of the object. Contains field 'type with type URL.
StartEnvironmentResponse
data StartEnvironmentResponse Source #
Message included in the response field of operations returned from StartEnvironment once the operation is complete.
See: startEnvironmentResponse
smart constructor.
Instances
startEnvironmentResponse :: StartEnvironmentResponse Source #
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:
serEnvironment :: Lens' StartEnvironmentResponse (Maybe Environment) Source #
Environment that was started.
OperationResponse
data OperationResponse Source #
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.
Instances
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:
orAddtional :: Lens' OperationResponse (HashMap Text JSONValue) Source #
Properties of the object. Contains field 'type with type URL.