getKxCluster method

Future<GetKxClusterResponse> getKxCluster({
  1. required String clusterName,
  2. required String environmentId,
})

Retrieves information about a kdb cluster.

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

Parameter clusterName : The name of the cluster that you want to retrieve.

Parameter environmentId : A unique identifier for the kdb environment.

Implementation

Future<GetKxClusterResponse> getKxCluster({
  required String clusterName,
  required String environmentId,
}) async {
  final response = await _protocol.send(
    payload: null,
    method: 'GET',
    requestUri:
        '/kx/environments/${Uri.encodeComponent(environmentId)}/clusters/${Uri.encodeComponent(clusterName)}',
    exceptionFnMap: _exceptionFns,
  );
  return GetKxClusterResponse.fromJson(response);
}