listProperties method

Future<ListPropertiesResponse> listProperties({
  1. required String entityId,
  2. required String workspaceId,
  3. String? componentName,
  4. String? componentPath,
  5. int? maxResults,
  6. String? nextToken,
})

This API lists the properties of a component.

May throw AccessDeniedException. May throw InternalServerException. May throw ResourceNotFoundException. May throw ThrottlingException. May throw ValidationException.

Parameter entityId : The ID for the entity whose metadata (component/properties) is returned by the operation.

Parameter workspaceId : The workspace ID.

Parameter componentName : The name of the component whose properties are returned by the operation.

Parameter componentPath : This string specifies the path to the composite component, starting from the top-level component.

Parameter maxResults : The maximum number of results returned at one time. The default is 25.

Parameter nextToken : The string that specifies the next page of results.

Implementation

Future<ListPropertiesResponse> listProperties({
  required String entityId,
  required String workspaceId,
  String? componentName,
  String? componentPath,
  int? maxResults,
  String? nextToken,
}) async {
  _s.validateNumRange(
    'maxResults',
    maxResults,
    0,
    200,
  );
  final $payload = <String, dynamic>{
    'entityId': entityId,
    if (componentName != null) 'componentName': componentName,
    if (componentPath != null) 'componentPath': componentPath,
    if (maxResults != null) 'maxResults': maxResults,
    if (nextToken != null) 'nextToken': nextToken,
  };
  final response = await _protocol.send(
    payload: $payload,
    method: 'POST',
    requestUri:
        '/workspaces/${Uri.encodeComponent(workspaceId)}/properties-list',
    hostPrefix: 'api.',
    exceptionFnMap: _exceptionFns,
  );
  return ListPropertiesResponse.fromJson(response);
}