describePlacement method

Future<DescribePlacementResponse> describePlacement({
  1. required String placementName,
  2. required String projectName,
})

Describes a placement in a project.

May throw InternalFailureException. May throw InvalidRequestException. May throw ResourceNotFoundException.

Parameter placementName : The name of the placement within a project.

Parameter projectName : The project containing the placement to be described.

Implementation

Future<DescribePlacementResponse> describePlacement({
  required String placementName,
  required String projectName,
}) async {
  ArgumentError.checkNotNull(placementName, 'placementName');
  _s.validateStringLength(
    'placementName',
    placementName,
    1,
    128,
    isRequired: true,
  );
  ArgumentError.checkNotNull(projectName, 'projectName');
  _s.validateStringLength(
    'projectName',
    projectName,
    1,
    128,
    isRequired: true,
  );
  final response = await _protocol.send(
    payload: null,
    method: 'GET',
    requestUri:
        '/projects/${Uri.encodeComponent(projectName)}/placements/${Uri.encodeComponent(placementName)}',
    exceptionFnMap: _exceptionFns,
  );
  return DescribePlacementResponse.fromJson(response);
}