Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Retrieves information about a component type.
Synopsis
- data GetComponentType = GetComponentType' {}
- newGetComponentType :: Text -> Text -> GetComponentType
- getComponentType_workspaceId :: Lens' GetComponentType Text
- getComponentType_componentTypeId :: Lens' GetComponentType Text
- data GetComponentTypeResponse = GetComponentTypeResponse' {
- componentTypeName :: Maybe Text
- description :: Maybe Text
- extendsFrom :: Maybe [Text]
- functions :: Maybe (HashMap Text FunctionResponse)
- isAbstract :: Maybe Bool
- isSchemaInitialized :: Maybe Bool
- isSingleton :: Maybe Bool
- propertyDefinitions :: Maybe (HashMap Text PropertyDefinitionResponse)
- propertyGroups :: Maybe (HashMap Text PropertyGroupResponse)
- status :: Maybe Status
- syncSource :: Maybe Text
- httpStatus :: Int
- workspaceId :: Text
- componentTypeId :: Text
- creationDateTime :: POSIX
- updateDateTime :: POSIX
- arn :: Text
- newGetComponentTypeResponse :: Int -> Text -> Text -> UTCTime -> UTCTime -> Text -> GetComponentTypeResponse
- getComponentTypeResponse_componentTypeName :: Lens' GetComponentTypeResponse (Maybe Text)
- getComponentTypeResponse_description :: Lens' GetComponentTypeResponse (Maybe Text)
- getComponentTypeResponse_extendsFrom :: Lens' GetComponentTypeResponse (Maybe [Text])
- getComponentTypeResponse_functions :: Lens' GetComponentTypeResponse (Maybe (HashMap Text FunctionResponse))
- getComponentTypeResponse_isAbstract :: Lens' GetComponentTypeResponse (Maybe Bool)
- getComponentTypeResponse_isSchemaInitialized :: Lens' GetComponentTypeResponse (Maybe Bool)
- getComponentTypeResponse_isSingleton :: Lens' GetComponentTypeResponse (Maybe Bool)
- getComponentTypeResponse_propertyDefinitions :: Lens' GetComponentTypeResponse (Maybe (HashMap Text PropertyDefinitionResponse))
- getComponentTypeResponse_propertyGroups :: Lens' GetComponentTypeResponse (Maybe (HashMap Text PropertyGroupResponse))
- getComponentTypeResponse_status :: Lens' GetComponentTypeResponse (Maybe Status)
- getComponentTypeResponse_syncSource :: Lens' GetComponentTypeResponse (Maybe Text)
- getComponentTypeResponse_httpStatus :: Lens' GetComponentTypeResponse Int
- getComponentTypeResponse_workspaceId :: Lens' GetComponentTypeResponse Text
- getComponentTypeResponse_componentTypeId :: Lens' GetComponentTypeResponse Text
- getComponentTypeResponse_creationDateTime :: Lens' GetComponentTypeResponse UTCTime
- getComponentTypeResponse_updateDateTime :: Lens' GetComponentTypeResponse UTCTime
- getComponentTypeResponse_arn :: Lens' GetComponentTypeResponse Text
Creating a Request
data GetComponentType Source #
See: newGetComponentType
smart constructor.
GetComponentType' | |
|
Instances
Create a value of GetComponentType
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetComponentType
, getComponentType_workspaceId
- The ID of the workspace that contains the component type.
GetComponentType
, getComponentType_componentTypeId
- The ID of the component type.
Request Lenses
getComponentType_workspaceId :: Lens' GetComponentType Text Source #
The ID of the workspace that contains the component type.
getComponentType_componentTypeId :: Lens' GetComponentType Text Source #
The ID of the component type.
Destructuring the Response
data GetComponentTypeResponse Source #
See: newGetComponentTypeResponse
smart constructor.
GetComponentTypeResponse' | |
|
Instances
newGetComponentTypeResponse Source #
Create a value of GetComponentTypeResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetComponentTypeResponse
, getComponentTypeResponse_componentTypeName
- The component type name.
GetComponentTypeResponse
, getComponentTypeResponse_description
- The description of the component type.
GetComponentTypeResponse
, getComponentTypeResponse_extendsFrom
- The name of the parent component type that this component type extends.
$sel:functions:GetComponentTypeResponse'
, getComponentTypeResponse_functions
- An object that maps strings to the functions in the component type. Each
string in the mapping must be unique to this object.
GetComponentTypeResponse
, getComponentTypeResponse_isAbstract
- A Boolean value that specifies whether the component type is abstract.
$sel:isSchemaInitialized:GetComponentTypeResponse'
, getComponentTypeResponse_isSchemaInitialized
- A Boolean value that specifies whether the component type has a schema
initializer and that the schema initializer has run.
$sel:isSingleton:GetComponentTypeResponse'
, getComponentTypeResponse_isSingleton
- A Boolean value that specifies whether an entity can have more than one
component of this type.
$sel:propertyDefinitions:GetComponentTypeResponse'
, getComponentTypeResponse_propertyDefinitions
- An object that maps strings to the property definitions in the component
type. Each string in the mapping must be unique to this object.
GetComponentTypeResponse
, getComponentTypeResponse_propertyGroups
- The maximum number of results to return at one time. The default is 25.
Valid Range: Minimum value of 1. Maximum value of 250.
GetComponentTypeResponse
, getComponentTypeResponse_status
- The current status of the component type.
GetComponentTypeResponse
, getComponentTypeResponse_syncSource
- The syncSource of the sync job, if this entity was created by a sync
job.
$sel:httpStatus:GetComponentTypeResponse'
, getComponentTypeResponse_httpStatus
- The response's http status code.
GetComponentType
, getComponentTypeResponse_workspaceId
- The ID of the workspace that contains the component type.
GetComponentType
, getComponentTypeResponse_componentTypeId
- The ID of the component type.
GetComponentTypeResponse
, getComponentTypeResponse_creationDateTime
- The date and time when the component type was created.
GetComponentTypeResponse
, getComponentTypeResponse_updateDateTime
- The date and time when the component was last updated.
GetComponentTypeResponse
, getComponentTypeResponse_arn
- The ARN of the component type.
Response Lenses
getComponentTypeResponse_componentTypeName :: Lens' GetComponentTypeResponse (Maybe Text) Source #
The component type name.
getComponentTypeResponse_description :: Lens' GetComponentTypeResponse (Maybe Text) Source #
The description of the component type.
getComponentTypeResponse_extendsFrom :: Lens' GetComponentTypeResponse (Maybe [Text]) Source #
The name of the parent component type that this component type extends.
getComponentTypeResponse_functions :: Lens' GetComponentTypeResponse (Maybe (HashMap Text FunctionResponse)) Source #
An object that maps strings to the functions in the component type. Each string in the mapping must be unique to this object.
getComponentTypeResponse_isAbstract :: Lens' GetComponentTypeResponse (Maybe Bool) Source #
A Boolean value that specifies whether the component type is abstract.
getComponentTypeResponse_isSchemaInitialized :: Lens' GetComponentTypeResponse (Maybe Bool) Source #
A Boolean value that specifies whether the component type has a schema initializer and that the schema initializer has run.
getComponentTypeResponse_isSingleton :: Lens' GetComponentTypeResponse (Maybe Bool) Source #
A Boolean value that specifies whether an entity can have more than one component of this type.
getComponentTypeResponse_propertyDefinitions :: Lens' GetComponentTypeResponse (Maybe (HashMap Text PropertyDefinitionResponse)) Source #
An object that maps strings to the property definitions in the component type. Each string in the mapping must be unique to this object.
getComponentTypeResponse_propertyGroups :: Lens' GetComponentTypeResponse (Maybe (HashMap Text PropertyGroupResponse)) Source #
The maximum number of results to return at one time. The default is 25.
Valid Range: Minimum value of 1. Maximum value of 250.
getComponentTypeResponse_status :: Lens' GetComponentTypeResponse (Maybe Status) Source #
The current status of the component type.
getComponentTypeResponse_syncSource :: Lens' GetComponentTypeResponse (Maybe Text) Source #
The syncSource of the sync job, if this entity was created by a sync job.
getComponentTypeResponse_httpStatus :: Lens' GetComponentTypeResponse Int Source #
The response's http status code.
getComponentTypeResponse_workspaceId :: Lens' GetComponentTypeResponse Text Source #
The ID of the workspace that contains the component type.
getComponentTypeResponse_componentTypeId :: Lens' GetComponentTypeResponse Text Source #
The ID of the component type.
getComponentTypeResponse_creationDateTime :: Lens' GetComponentTypeResponse UTCTime Source #
The date and time when the component type was created.
getComponentTypeResponse_updateDateTime :: Lens' GetComponentTypeResponse UTCTime Source #
The date and time when the component was last updated.
getComponentTypeResponse_arn :: Lens' GetComponentTypeResponse Text Source #
The ARN of the component type.