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 |
- Service Configuration
- OAuth Scopes
- Status
- OperationSchema
- ListImageVersionsResponse
- ListEnvironmentsResponse
- EnvironmentConfig
- ListOperationsResponse
- NodeConfig
- Operation
- Empty
- OperationMetadataOperationType
- SoftwareConfigEnvVariables
- ImageVersion
- Environment
- SoftwareConfigAirflowConfigOverrides
- StatusDetailsItem
- SoftwareConfigPypiPackages
- OperationMetadataState
- EnvironmentState
- Xgafv
- SoftwareConfig
- EnvironmentLabels
- OperationMetadata
- OperationResponse
Synopsis
- composerService :: 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 OperationSchema
- operationSchema :: HashMap Text JSONValue -> OperationSchema
- osAddtional :: Lens' OperationSchema (HashMap Text JSONValue)
- data ListImageVersionsResponse
- listImageVersionsResponse :: ListImageVersionsResponse
- livrNextPageToken :: Lens' ListImageVersionsResponse (Maybe Text)
- livrImageVersions :: Lens' ListImageVersionsResponse [ImageVersion]
- data ListEnvironmentsResponse
- listEnvironmentsResponse :: ListEnvironmentsResponse
- lerNextPageToken :: Lens' ListEnvironmentsResponse (Maybe Text)
- lerEnvironments :: Lens' ListEnvironmentsResponse [Environment]
- data EnvironmentConfig
- environmentConfig :: EnvironmentConfig
- ecNodeConfig :: Lens' EnvironmentConfig (Maybe NodeConfig)
- ecNodeCount :: Lens' EnvironmentConfig (Maybe Int32)
- ecSoftwareConfig :: Lens' EnvironmentConfig (Maybe SoftwareConfig)
- ecDagGcsPrefix :: Lens' EnvironmentConfig (Maybe Text)
- ecGkeCluster :: Lens' EnvironmentConfig (Maybe Text)
- ecAirflowURI :: Lens' EnvironmentConfig (Maybe Text)
- data ListOperationsResponse
- listOperationsResponse :: ListOperationsResponse
- lorNextPageToken :: Lens' ListOperationsResponse (Maybe Text)
- lorOperations :: Lens' ListOperationsResponse [Operation]
- data NodeConfig
- nodeConfig :: NodeConfig
- ncDiskSizeGb :: Lens' NodeConfig (Maybe Int32)
- ncLocation :: Lens' NodeConfig (Maybe Text)
- ncNetwork :: Lens' NodeConfig (Maybe Text)
- ncOAuthScopes :: Lens' NodeConfig [Text]
- ncServiceAccount :: Lens' NodeConfig (Maybe Text)
- ncSubnetwork :: Lens' NodeConfig (Maybe Text)
- ncMachineType :: Lens' NodeConfig (Maybe Text)
- ncTags :: Lens' NodeConfig [Text]
- 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 OperationSchema)
- data Empty
- empty :: Empty
- data OperationMetadataOperationType
- data SoftwareConfigEnvVariables
- softwareConfigEnvVariables :: HashMap Text Text -> SoftwareConfigEnvVariables
- scevAddtional :: Lens' SoftwareConfigEnvVariables (HashMap Text Text)
- data ImageVersion
- imageVersion :: ImageVersion
- ivImageVersionId :: Lens' ImageVersion (Maybe Text)
- ivSupportedPythonVersions :: Lens' ImageVersion [Text]
- ivIsDefault :: Lens' ImageVersion (Maybe Bool)
- data Environment
- environment :: Environment
- eState :: Lens' Environment (Maybe EnvironmentState)
- eConfig :: Lens' Environment (Maybe EnvironmentConfig)
- eUuid :: Lens' Environment (Maybe Text)
- eUpdateTime :: Lens' Environment (Maybe UTCTime)
- eName :: Lens' Environment (Maybe Text)
- eLabels :: Lens' Environment (Maybe EnvironmentLabels)
- eCreateTime :: Lens' Environment (Maybe UTCTime)
- data SoftwareConfigAirflowConfigOverrides
- softwareConfigAirflowConfigOverrides :: HashMap Text Text -> SoftwareConfigAirflowConfigOverrides
- scacoAddtional :: Lens' SoftwareConfigAirflowConfigOverrides (HashMap Text Text)
- data StatusDetailsItem
- statusDetailsItem :: HashMap Text JSONValue -> StatusDetailsItem
- sdiAddtional :: Lens' StatusDetailsItem (HashMap Text JSONValue)
- data SoftwareConfigPypiPackages
- softwareConfigPypiPackages :: HashMap Text Text -> SoftwareConfigPypiPackages
- scppAddtional :: Lens' SoftwareConfigPypiPackages (HashMap Text Text)
- data OperationMetadataState
- data EnvironmentState
- data Xgafv
- data SoftwareConfig
- softwareConfig :: SoftwareConfig
- scImageVersion :: Lens' SoftwareConfig (Maybe Text)
- scPythonVersion :: Lens' SoftwareConfig (Maybe Text)
- scPypiPackages :: Lens' SoftwareConfig (Maybe SoftwareConfigPypiPackages)
- scAirflowConfigOverrides :: Lens' SoftwareConfig (Maybe SoftwareConfigAirflowConfigOverrides)
- scEnvVariables :: Lens' SoftwareConfig (Maybe SoftwareConfigEnvVariables)
- data EnvironmentLabels
- environmentLabels :: HashMap Text Text -> EnvironmentLabels
- elAddtional :: Lens' EnvironmentLabels (HashMap Text Text)
- data OperationMetadata
- operationMetadata :: OperationMetadata
- omState :: Lens' OperationMetadata (Maybe OperationMetadataState)
- omResourceUuid :: Lens' OperationMetadata (Maybe Text)
- omResource :: Lens' OperationMetadata (Maybe Text)
- omEndTime :: Lens' OperationMetadata (Maybe UTCTime)
- omOperationType :: Lens' OperationMetadata (Maybe OperationMetadataOperationType)
- omCreateTime :: Lens' OperationMetadata (Maybe UTCTime)
- data OperationResponse
- operationResponse :: HashMap Text JSONValue -> OperationResponse
- orAddtional :: Lens' OperationResponse (HashMap Text JSONValue)
Service Configuration
composerService :: ServiceConfig Source #
Default request referring to version v1
of the Cloud Composer 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.Composer.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.Composer.Types.Product | |
FromJSON Status Source # | |
type Rep Status Source # | |
Defined in Network.Google.Composer.Types.Product type Rep Status = D1 (MetaData "Status" "Network.Google.Composer.Types.Product" "gogol-composer-0.5.0-63fJVe3xjPeEyHID2kP8MA" 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.
OperationSchema
data OperationSchema 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: operationSchema
smart constructor.
Instances
Creates a value of OperationSchema
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
osAddtional :: Lens' OperationSchema (HashMap Text JSONValue) Source #
Properties of the object. Contains field 'type with type URL.
ListImageVersionsResponse
data ListImageVersionsResponse Source #
The ImageVersions in a project and location.
See: listImageVersionsResponse
smart constructor.
Instances
listImageVersionsResponse :: ListImageVersionsResponse Source #
Creates a value of ListImageVersionsResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
livrNextPageToken :: Lens' ListImageVersionsResponse (Maybe Text) Source #
The page token used to query for the next page if one exists.
livrImageVersions :: Lens' ListImageVersionsResponse [ImageVersion] Source #
The list of supported ImageVersions in a location.
ListEnvironmentsResponse
data ListEnvironmentsResponse Source #
The environments in a project and location.
See: listEnvironmentsResponse
smart constructor.
Instances
listEnvironmentsResponse :: ListEnvironmentsResponse Source #
Creates a value of ListEnvironmentsResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lerNextPageToken :: Lens' ListEnvironmentsResponse (Maybe Text) Source #
The page token used to query for the next page if one exists.
lerEnvironments :: Lens' ListEnvironmentsResponse [Environment] Source #
The list of environments returned by a ListEnvironmentsRequest.
EnvironmentConfig
data EnvironmentConfig Source #
Configuration information for an environment.
See: environmentConfig
smart constructor.
Instances
environmentConfig :: EnvironmentConfig Source #
Creates a value of EnvironmentConfig
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ecNodeConfig :: Lens' EnvironmentConfig (Maybe NodeConfig) Source #
The configuration used for the Kubernetes Engine cluster.
ecNodeCount :: Lens' EnvironmentConfig (Maybe Int32) Source #
The number of nodes in the Kubernetes Engine cluster that will be used to run this environment.
ecSoftwareConfig :: Lens' EnvironmentConfig (Maybe SoftwareConfig) Source #
The configuration settings for software inside the environment.
ecDagGcsPrefix :: Lens' EnvironmentConfig (Maybe Text) Source #
Output only. The Cloud Storage prefix of the DAGs for this environment. Although Cloud Storage objects reside in a flat namespace, a hierarchical file tree can be simulated using "/"-delimited object name prefixes. DAG objects for this environment reside in a simulated directory with the given prefix.
ecGkeCluster :: Lens' EnvironmentConfig (Maybe Text) Source #
Output only. The Kubernetes Engine cluster used to run this environment.
ecAirflowURI :: Lens' EnvironmentConfig (Maybe Text) Source #
Output only. The URI of the Apache Airflow Web UI hosted within this environment (see Airflow web interface).
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.
NodeConfig
data NodeConfig Source #
The configuration information for the Kubernetes Engine nodes running the Apache Airflow software.
See: nodeConfig
smart constructor.
Instances
nodeConfig :: NodeConfig Source #
Creates a value of NodeConfig
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ncDiskSizeGb :: Lens' NodeConfig (Maybe Int32) Source #
Optional. The disk size in GB used for node VMs. Minimum size is 20GB. If unspecified, defaults to 100GB. Cannot be updated.
ncLocation :: Lens' NodeConfig (Maybe Text) Source #
Optional. The Compute Engine zone in which to deploy the VMs used to run the Apache Airflow software, specified as a relative resource name. For example: "projects/{projectId}/zones/{zoneId}". This `location` must belong to the enclosing environment's project and location. If both this field and `nodeConfig.machineType` are specified, `nodeConfig.machineType` must belong to this `location`; if both are unspecified, the service will pick a zone in the Compute Engine region corresponding to the Cloud Composer location, and propagate that choice to both fields. If only one field (`location` or `nodeConfig.machineType`) is specified, the location information from the specified field will be propagated to the unspecified field.
ncNetwork :: Lens' NodeConfig (Maybe Text) Source #
Optional. The Compute Engine network to be used for machine communications, specified as a relative resource name. For example: "projects/{projectId}/global/networks/{networkId}". Shared VPC is not currently supported. The network must belong to the environment's project. If unspecified, the "default" network ID in the environment's project is used. If a Custom Subnet Network is provided, `nodeConfig.subnetwork` must also be provided.
ncOAuthScopes :: Lens' NodeConfig [Text] Source #
Optional. The set of Google API scopes to be made available on all node VMs. If `oauth_scopes` is empty, defaults to ["https://www.googleapis.com/auth/cloud-platform"]. Cannot be updated.
ncServiceAccount :: Lens' NodeConfig (Maybe Text) Source #
Optional. The Google Cloud Platform Service Account to be used by the node VMs. If a service account is not specified, the "default" Compute Engine service account is used. Cannot be updated.
ncSubnetwork :: Lens' NodeConfig (Maybe Text) Source #
Optional. The Compute Engine subnetwork to be used for machine communications, specified as a relative resource name. For example: "projects/{projectId}/regions/{regionId}/subnetworks/{subnetworkId}" If a subnetwork is provided, `nodeConfig.network` must also be provided, and the subnetwork must belong to the enclosing environment's project and location.
ncMachineType :: Lens' NodeConfig (Maybe Text) Source #
Optional. The Compute Engine machine type used for cluster instances, specified as a relative resource name. For example: "projects/{projectId}/zones/{zoneId}/machineTypes/{machineTypeId}". The `machineType` must belong to the enclosing environment's project and location. If both this field and `nodeConfig.location` are specified, this `machineType` must belong to the `nodeConfig.location`; if both are unspecified, the service will pick a zone in the Compute Engine region corresponding to the Cloud Composer location, and propagate that choice to both fields. If exactly one of this field and `nodeConfig.location` is specified, the location information from the specified field will be propagated to the unspecified field. If this field is unspecified, the `machineTypeId` defaults to "n1-standard-1".
ncTags :: Lens' NodeConfig [Text] Source #
Optional. The list of instance tags applied to all node VMs. Tags are used to identify valid sources or targets for network firewalls. Each tag within the list must comply with RFC1035. Cannot be updated.
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 OperationSchema) 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.Composer.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.Composer.Types.Product | |
FromJSON Empty Source # | |
type Rep Empty Source # | |
OperationMetadataOperationType
data OperationMetadataOperationType Source #
Output only. The type of operation being performed.
TypeUnspecified |
|
Create |
|
Delete' |
|
Update |
|
Instances
SoftwareConfigEnvVariables
data SoftwareConfigEnvVariables Source #
Optional. Additional environment variables to provide to the Apache Airflow scheduler, worker, and webserver processes. Environment variable names must match the regular expression `a-zA-Z_*`. They cannot specify Apache Airflow software configuration overrides (they cannot match the regular expression `AIRFLOW[A-Z0-9_]+[A-Z0-9_]+`), and they cannot match any of the following reserved names: * `AIRFLOW_HOME` * `C_FORCE_ROOT` * `CONTAINER_NAME` * `DAGS_FOLDER` * `GCP_PROJECT` * `GCS_BUCKET` * `GKE_CLUSTER_NAME` * `SQL_DATABASE` * `SQL_INSTANCE` * `SQL_PASSWORD` * `SQL_PROJECT` * `SQL_REGION` * `SQL_USER`
See: softwareConfigEnvVariables
smart constructor.
Instances
softwareConfigEnvVariables Source #
Creates a value of SoftwareConfigEnvVariables
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ImageVersion
data ImageVersion Source #
ImageVersion information
See: imageVersion
smart constructor.
Instances
imageVersion :: ImageVersion Source #
Creates a value of ImageVersion
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ivImageVersionId :: Lens' ImageVersion (Maybe Text) Source #
The string identifier of the ImageVersion, in the form: "composer-x.y.z-airflow-a.b(.c)"
ivSupportedPythonVersions :: Lens' ImageVersion [Text] Source #
supported python versions
ivIsDefault :: Lens' ImageVersion (Maybe Bool) Source #
Whether this is the default ImageVersion used by Composer during environment creation if no input ImageVersion is specified.
Environment
data Environment Source #
An environment for running orchestration tasks.
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 #
The current state of the environment.
eConfig :: Lens' Environment (Maybe EnvironmentConfig) Source #
Configuration parameters for this environment.
eUuid :: Lens' Environment (Maybe Text) Source #
Output only. The UUID (Universally Unique IDentifier) associated with this environment. This value is generated when the environment is created.
eUpdateTime :: Lens' Environment (Maybe UTCTime) Source #
Output only. The time at which this environment was last modified.
eName :: Lens' Environment (Maybe Text) Source #
The resource name of the environment, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}"
eLabels :: Lens' Environment (Maybe EnvironmentLabels) Source #
Optional. User-defined labels for this environment. The labels map can contain no more than 64 entries. Entries of the labels map are UTF8 strings that comply with the following restrictions: * Keys must conform to regexp: \p{Ll}\p{Lo}{0,62} * Values must conform to regexp: [\p{Ll}\p{Lo}\p{N}_-]{0,63} * Both keys and values are additionally constrained to be <= 128 bytes in size.
eCreateTime :: Lens' Environment (Maybe UTCTime) Source #
Output only. The time at which this environment was created.
SoftwareConfigAirflowConfigOverrides
data SoftwareConfigAirflowConfigOverrides Source #
Optional. Apache Airflow configuration properties to override. Property keys contain the section and property names, separated by a hyphen, for example "core-dags_are_paused_at_creation". Section names must not contain hyphens ("-"), opening square brackets ("["), or closing square brackets ("]"). The property name must not be empty and must not contain an equals sign ("=") or semicolon (";"). Section and property names must not contain a period ("."). Apache Airflow configuration property names must be written in snake_case. Property values can contain any character, and can be written in any lower/upper case format. Certain Apache Airflow configuration property values are blacklisted, and cannot be overridden.
See: softwareConfigAirflowConfigOverrides
smart constructor.
Instances
softwareConfigAirflowConfigOverrides Source #
Creates a value of SoftwareConfigAirflowConfigOverrides
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
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.
SoftwareConfigPypiPackages
data SoftwareConfigPypiPackages Source #
Optional. Custom Python Package Index (PyPI) packages to be installed in the environment. Keys refer to the lowercase package name such as "numpy" and values are the lowercase extras and version specifier such as "==1.12.0", "[devel,gcp_api]", or "[devel]>=1.8.2, <1.9.2". To specify a package without pinning it to a version specifier, use the empty string as the value.
See: softwareConfigPypiPackages
smart constructor.
Instances
softwareConfigPypiPackages Source #
Creates a value of SoftwareConfigPypiPackages
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
OperationMetadataState
data OperationMetadataState Source #
Output only. The current operation state.
StateUnspecified |
|
Pending |
|
Running |
|
Succeeded |
|
Successful | SUCCESSFUL |
Failed |
|
Instances
EnvironmentState
data EnvironmentState Source #
The current state of the environment.
ESStateUnspecified |
|
ESCreating |
|
ESRunning |
|
ESUpdating |
|
ESDeleting |
|
ESError' |
|
Instances
Xgafv
V1 error format.
Instances
SoftwareConfig
data SoftwareConfig Source #
Specifies the selection and configuration of software inside the environment.
See: softwareConfig
smart constructor.
Instances
softwareConfig :: SoftwareConfig Source #
Creates a value of SoftwareConfig
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
scImageVersion :: Lens' SoftwareConfig (Maybe Text) Source #
The version of the software running in the environment. This encapsulates both the version of Cloud Composer functionality and the version of Apache Airflow. It must match the regular expression `composer-([0-9]+\.[0-9]+\.[0-9]+|latest)-airflow-[0-9]+\.[0-9]+(\.[0-9]+.*)?`. When used as input, the server also checks if the provided version is supported and denies the request for an unsupported version. The Cloud Composer portion of the version is a semantic version or `latest`. When the patch version is omitted, the current Cloud Composer patch version is selected. When `latest` is provided instead of an explicit version number, the server replaces `latest` with the current Cloud Composer version and stores that version number in the same field. The portion of the image version that follows airflow- is an official Apache Airflow repository release name. See also Version List.
scPythonVersion :: Lens' SoftwareConfig (Maybe Text) Source #
Optional. The major version of Python used to run the Apache Airflow scheduler, worker, and webserver processes. Can be set to '2' or '3'. If not specified, the default is '2'. Cannot be updated.
scPypiPackages :: Lens' SoftwareConfig (Maybe SoftwareConfigPypiPackages) Source #
Optional. Custom Python Package Index (PyPI) packages to be installed in the environment. Keys refer to the lowercase package name such as "numpy" and values are the lowercase extras and version specifier such as "==1.12.0", "[devel,gcp_api]", or "[devel]>=1.8.2, <1.9.2". To specify a package without pinning it to a version specifier, use the empty string as the value.
scAirflowConfigOverrides :: Lens' SoftwareConfig (Maybe SoftwareConfigAirflowConfigOverrides) Source #
Optional. Apache Airflow configuration properties to override. Property keys contain the section and property names, separated by a hyphen, for example "core-dags_are_paused_at_creation". Section names must not contain hyphens ("-"), opening square brackets ("["), or closing square brackets ("]"). The property name must not be empty and must not contain an equals sign ("=") or semicolon (";"). Section and property names must not contain a period ("."). Apache Airflow configuration property names must be written in snake_case. Property values can contain any character, and can be written in any lower/upper case format. Certain Apache Airflow configuration property values are blacklisted, and cannot be overridden.
scEnvVariables :: Lens' SoftwareConfig (Maybe SoftwareConfigEnvVariables) Source #
Optional. Additional environment variables to provide to the Apache Airflow scheduler, worker, and webserver processes. Environment variable names must match the regular expression `a-zA-Z_*`. They cannot specify Apache Airflow software configuration overrides (they cannot match the regular expression `AIRFLOW[A-Z0-9_]+[A-Z0-9_]+`), and they cannot match any of the following reserved names: * `AIRFLOW_HOME` * `C_FORCE_ROOT` * `CONTAINER_NAME` * `DAGS_FOLDER` * `GCP_PROJECT` * `GCS_BUCKET` * `GKE_CLUSTER_NAME` * `SQL_DATABASE` * `SQL_INSTANCE` * `SQL_PASSWORD` * `SQL_PROJECT` * `SQL_REGION` * `SQL_USER`
EnvironmentLabels
data EnvironmentLabels Source #
Optional. User-defined labels for this environment. The labels map can contain no more than 64 entries. Entries of the labels map are UTF8 strings that comply with the following restrictions: * Keys must conform to regexp: \p{Ll}\p{Lo}{0,62} * Values must conform to regexp: [\p{Ll}\p{Lo}\p{N}_-]{0,63} * Both keys and values are additionally constrained to be <= 128 bytes in size.
See: environmentLabels
smart constructor.
Instances
Creates a value of EnvironmentLabels
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
OperationMetadata
data OperationMetadata Source #
Metadata describing an operation.
See: operationMetadata
smart constructor.
Instances
operationMetadata :: OperationMetadata Source #
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:
omState :: Lens' OperationMetadata (Maybe OperationMetadataState) Source #
Output only. The current operation state.
omResourceUuid :: Lens' OperationMetadata (Maybe Text) Source #
Output only. The UUID of the resource being operated on.
omResource :: Lens' OperationMetadata (Maybe Text) Source #
Output only. The resource being operated on, as a [relative resource name]( /apis/design/resource_names#relative_resource_name).
omEndTime :: Lens' OperationMetadata (Maybe UTCTime) Source #
Output only. The time when the operation terminated, regardless of its success. This field is unset if the operation is still ongoing.
omOperationType :: Lens' OperationMetadata (Maybe OperationMetadataOperationType) Source #
Output only. The type of operation being performed.
omCreateTime :: Lens' OperationMetadata (Maybe UTCTime) Source #
Output only. The time the operation was submitted to the server.
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.