java.lang.Object
- com.baidubce.AbstractBceClient
- - com.baidubce.services.bmr.BmrClient

```
public class BmrClient
extends AbstractBceClient
```
Provides the client for accessing the Baidu MapReduce service.

字段概要
- 从类继承的字段 com.baidubce.AbstractBceClient
  config, DEFAULT_CONTENT_TYPE, DEFAULT_ENCODING, DEFAULT_SERVICE_DOMAIN, URL_PREFIX

构造器概要

构造器
构造器	说明
`BmrClient()`	Constructs a new client to invoke service methods on BMR.
`BmrClient(BceClientConfiguration clientConfiguration)`	Constructs a new BMR client using the client configuration to access BMR.

方法概要

所有方法实例方法具体方法
修饰符和类型	方法	说明
`void`	`addEip(EipRequest request)`	add an EIP of the master node of a cluster
`AddStepsResponse`	`addSteps(AddStepsRequest request)`	Add steps to a BMR cluster.
`void`	`bindEip(EipBindRequest request)`	bind EIP for the bmr instance of a cluster
`void`	`cancelSteps(GetStepRequest request)`
`CreateClusterResponse`	`createCluster(CreateClusterRequest request)`	Create a cluster with the specified options.
`CreateClusterResponse`	`createclusterByTemplate(CreateClusterByTemplateRequest request)`	create a cluster by a template
`ScheduleCreateResponse`	`createSchedulePlan(CreateSchedulePlanRequest request)`	create a scheduleplan
`CreateTemplateResponse`	`createTemplate(CreateTemplateRequest request)`	create a Template
`void`	`deleteEip(EipRequest request)`	Delete the master of a cluster 's EIP
`ScheduleResultResponse`	`deleteSchedulePlan(SchedulePlanRequest request)`	delete scheduleplan id
`NormalResponse`	`deleteTemplate(TemplateIdRequest request)`	delete template by id
`CluseterDetailInfoResponse`	`getCluseterDetail(GetClusterRequest request)`	get a cluster's detail
`GetClusterResponse`	`getCluster(GetClusterRequest request)`	Describe the detail information of the target cluster.
`GetClusterResponse`	`getCluster(String clusterId)`	Describe the detail information of the target cluster.
`AmbariResponse`	`getClusterAmbariPassword(String clusterId)`	Describe the Ambari Password information of the target cluster.
`SchedulePlanDetailResponse`	`getSchedulePlanDetail(SchedulePlanRequest request)`	get a schedulePlan's detail
`GetStepResponse`	`getStep(GetStepRequest request)`	Describe the detail information of the target step.
`GetStepResponse`	`getStep(String clusterId, String stepId)`	Describe the detail information of the target step.
`TemplateInfoResponse`	`getTemplateInfo(TemplateIdRequest request)`	get the TemplateInfo
`ListClusterHostsResponse`	`listClusterHosts(String clusterId)`	List host info for a cluster
`ListClustersResponse`	`listClusters()`	List BMR clusters owned by the authenticated user.
`ListClustersResponse`	`listClusters(int maxKeys)`	List BMR clusters owned by the authenticated user.
`ListClustersResponse`	`listClusters(ListClustersRequest request)`	List BMR clusters owned by the authenticated user.
`ListClustersResponse`	`listClusters(String marker, int maxKeys)`	List BMR clusters owned by the authenticated user.
`ListHistorySchedulePlanResponse`	`listHistory(SchedulePlanRequest request)`	list history steps of a shcduleplan
`ListInstanceGroupsResponse`	`listInstanceGroups(ListInstanceGroupsRequest request)`	List the instance groups of the target BMR cluster.
`ListInstanceGroupsResponse`	`listInstanceGroups(String clusterId)`	List the instance groups of the target BMR cluster.
`ListInstancesResponse`	`listInstances(ListInstancesRequest request)`	List the instances belonging to the target instance group in the BMR cluster.
`ListInstancesResponse`	`listInstances(String clusterId, String instanceGroupId)`	List the instances belonging to the target instance in the BMR cluster.
`SchedulePlanDetailListResponse`	`listSchedulePlanDetail(ListScheduleDetailRequest request)`	list the detail of a schedulePlan
`ListStepsResponse`	`listSteps(ListStepsRequest request)`	List all the steps of the target BMR cluster.
`ListStepsResponse`	`listSteps(String clusterId)`	List all the steps of the target BMR cluster.
`ListStepsResponse`	`listSteps(String clusterId, int maxKeys)`	List all the steps of the target BMR cluster.
`ListStepsResponse`	`listSteps(String clusterId, String marker, int maxKeys)`	List all the steps of the target BMR cluster.
`TemplateListResponse`	`listTemplate(TemplateListRequest request)`	list all of template of an user
`void`	`modifyInstanceGroups(ModifyInstanceGroupsRequest request)`	Modify the instance groups of the target cluster.
`NormalResponse`	`renameCluster(RenameCluseterRequest request)`	rename a cluster's name
`TemplateClusterResponse`	`saveTemplateByCluster(TemplateClusterRequest request)`	save a template by clusterID
`ScheduleResultResponse`	`startSchedulePlan(SchedulePlanRequest request)`	start a scheduleplan
`ScheduleResultResponse`	`stopSchedulePlan(SchedulePlanRequest request)`	stip scheduleplan
`void`	`terminateCluster(TerminateClusterRequest request)`	Terminate a BMR cluster and release all the virtual machine instances.
`void`	`terminateCluster(String clusterId)`	Terminate a BMR cluster and release all the virtual machine instances.
`void`	`unBindEip(EipUnBindRequest request)`	unbind EIP for the bmr instance of a cluster
`ScheduleResultResponse`	`updateSchedulePlan(UpdateSchedulePlanRequest request)`	update a schedulePlan

从类继承的方法 com.baidubce.AbstractBceClient
computeServiceId, getClient, getEndpoint, getServiceId, invokeHttpClient, isRegionSupported, setClient, shutdown

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - BmrClient
```
public BmrClient()
```
    Constructs a new client to invoke service methods on BMR.
  - BmrClient
```
public BmrClient(BceClientConfiguration clientConfiguration)
```
    Constructs a new BMR client using the client configuration to access BMR.
    
    参数:
    
    clientConfiguration - The BCE client configuration options.
- 方法详细资料
  - listClusters
```
public ListClustersResponse listClusters(ListClustersRequest request)
```
    List BMR clusters owned by the authenticated user. Users must authenticate with a valid BCE Access Key ID, and the response contains all the BMR clusters owned by the user.
    
    参数:
    
    request - The request containing valid query parameters.
    
    返回:
    
    The response containing a list of the BMR clusters owned by the authenticated sender of the request.
  - listClusters
```
public ListClustersResponse listClusters()
```
    List BMR clusters owned by the authenticated user.
    
    返回:
    
    The response containing a list of the BMR clusters owned by the authenticated sender of the request.
  - listClusters
```
public ListClustersResponse listClusters(int maxKeys)
```
    List BMR clusters owned by the authenticated user.
    
    参数:
    
    maxKeys - The maximum number of clusters returned.
    
    返回:
    
    The response containing a list of the BMR clusters owned by the authenticated sender of the request. And the size of list is limited below maxKeys.
  - listClusters
```
public ListClustersResponse listClusters(String marker,
                                         int maxKeys)
```
    List BMR clusters owned by the authenticated user.
    
    参数:
    
    marker - The start record of clusters.
    
    maxKeys - The maximum number of clusters returned.
    
    返回:
    
    The response containing a list of the BMR clusters owned by the authenticated sender of the request. The clusters' records start from the marker and the size of list is limited below maxKeys.
  - getCluster
```
public GetClusterResponse getCluster(GetClusterRequest request)
```
    Describe the detail information of the target cluster.
    
    参数:
    
    request - The request object containing the ID of the target cluster.
    
    返回:
    
    response containing the detail information of the target cluster.
  - getClusterAmbariPassword
```
public AmbariResponse getClusterAmbariPassword(String clusterId)
```
    Describe the Ambari Password information of the target cluster.
    
    参数:
    
    clusterId - ID of the target cluster.
    
    返回:
    
    response containing the Ambari Password information of the target cluster.
  - saveTemplateByCluster
```
public TemplateClusterResponse saveTemplateByCluster(TemplateClusterRequest request)
```
    save a template by clusterID
    
    参数:
    
    request - The request object containing the ID of the target cluster
    
    返回:
    
    response containing the ID of the new template
  - getCluster
```
public GetClusterResponse getCluster(String clusterId)
```
    Describe the detail information of the target cluster.
    
    参数:
    
    clusterId - The ID of the target cluster.
    
    返回:
    
    The response containing the detail information of the target cluster.
  - createCluster
```
public CreateClusterResponse createCluster(CreateClusterRequest request)
```
    Create a cluster with the specified options.
    
    参数:
    
    request - The request containing all options for creating a BMR cluster.
    
    返回:
    
    The response containing the ID of the newly created cluster.
  - createTemplate
```
public CreateTemplateResponse createTemplate(CreateTemplateRequest request)
```
    create a Template
    
    参数:
    
    request - the request contains all of a cluster's config
    
    返回:
    
    a new TemplateId
  - getCluseterDetail
```
public CluseterDetailInfoResponse getCluseterDetail(GetClusterRequest request)
```
    get a cluster's detail
    
    参数:
    
    request - a cluster's id
    
    返回:
    
    get a cluster's config
  - createclusterByTemplate
```
public CreateClusterResponse createclusterByTemplate(CreateClusterByTemplateRequest request)
```
    create a cluster by a template
    
    参数:
    
    request - a template,a loguril,an adminPasswod
    
    返回:
    
    the cluster's Id
  - modifyInstanceGroups
```
public void modifyInstanceGroups(ModifyInstanceGroupsRequest request)
```
    Modify the instance groups of the target cluster.
    
    参数:
    
    request - The request containing the ID of BMR cluster and the instance groups to be modified.
  - terminateCluster
```
public void terminateCluster(TerminateClusterRequest request)
```
    Terminate a BMR cluster and release all the virtual machine instances.
    
    参数:
    
    request - The request containing the ID of the cluster to be terminated.
  - terminateCluster
```
public void terminateCluster(String clusterId)
```
    Terminate a BMR cluster and release all the virtual machine instances.
    
    参数:
    
    clusterId - The ID of the cluster to be terminated.
  - listInstanceGroups
```
public ListInstanceGroupsResponse listInstanceGroups(ListInstanceGroupsRequest request)
```
    List the instance groups of the target BMR cluster.
    
    参数:
    
    request - containing the ID of target BMR cluster.
    
    返回:
    
    The response containing a list of InstanceGroup objects.
  - listInstanceGroups
```
public ListInstanceGroupsResponse listInstanceGroups(String clusterId)
```
    List the instance groups of the target BMR cluster.
    
    参数:
    
    clusterId - the ID of target BMR cluster.
    
    返回:
    
    The response containing a list of InstanceGroup objects.
  - listInstances
```
public ListInstancesResponse listInstances(ListInstancesRequest request)
```
    List the instances belonging to the target instance group in the BMR cluster.
    
    参数:
    
    request - containing the ID of target BMR cluster and the ID of the instance group.
    
    返回:
    
    The response containing a list of Instance objects.
  - listInstances
```
public ListInstancesResponse listInstances(String clusterId,
                                           String instanceGroupId)
```
    List the instances belonging to the target instance in the BMR cluster.
    
    参数:
    
    clusterId - the ID of target BMR cluster.
    
    instanceGroupId - the ID of target instance group.
    
    返回:
    
    The response containing a list of Instance objects.
  - addSteps
```
public AddStepsResponse addSteps(AddStepsRequest request)
```
    Add steps to a BMR cluster.
    
    参数:
    
    request - containing the ID of target BMR cluster and several steps to be added.
    
    返回:
    
    The response containing a list of IDs of newly added steps.
  - cancelSteps
```
public void cancelSteps(GetStepRequest request)
```
  - listSteps
```
public ListStepsResponse listSteps(ListStepsRequest request)
```
    List all the steps of the target BMR cluster.
    
    参数:
    
    request - The request containing the ID of target BMR cluster.
    
    返回:
    
    The response containing the list of steps owned by the cluster.
  - listSteps
```
public ListStepsResponse listSteps(String clusterId)
```
    List all the steps of the target BMR cluster.
    
    参数:
    
    clusterId - The ID of the target BMR cluster.
    
    返回:
    
    The response containing the list of steps owned by the cluster.
  - listSteps
```
public ListStepsResponse listSteps(String clusterId,
                                   int maxKeys)
```
    List all the steps of the target BMR cluster.
    
    参数:
    
    clusterId - The ID of the target BMR cluster.
    
    maxKeys - The maximum number of steps returned.
    
    返回:
    
    The response containing the list of steps owned by the cluster. And the size of list is limited below maxKeys.
  - listSteps
```
public ListStepsResponse listSteps(String clusterId,
                                   String marker,
                                   int maxKeys)
```
    List all the steps of the target BMR cluster.
    
    参数:
    
    clusterId - The ID of the target BMR cluster.
    
    marker - The start record of steps.
    
    maxKeys - The maximum number of steps returned.
    
    返回:
    
    The response containing a list of the BMR steps owned by the cluster. The steps' records start from the marker and the size of list is limited below maxKeys.
  - getStep
```
public GetStepResponse getStep(GetStepRequest request)
```
    Describe the detail information of the target step.
    
    The request is valid just if the step exists and the step is owned by the cluster
    
    参数:
    
    request - The request containing the ID of BMR cluster and the ID of step.
    
    返回:
    
    The response containing the detail information of target step.
  - getStep
```
public GetStepResponse getStep(String clusterId,
                               String stepId)
```
    Describe the detail information of the target step.
    
    参数:
    
    clusterId - The ID of the cluster which owns the step.
    
    stepId - The ID of the target step.
    
    返回:
    
    The response containing the detail information of the target step.
  - deleteEip
```
public void deleteEip(EipRequest request)
```
    Delete the master of a cluster 's EIP
    
    参数:
    
    request - the cluster's ID
  - renameCluster
```
public NormalResponse renameCluster(RenameCluseterRequest request)
```
    rename a cluster's name
    
    参数:
    
    request - contains cluster's ID and cluster's new name
    
    返回:
    
    the success info
  - addEip
```
public void addEip(EipRequest request)
```
    add an EIP of the master node of a cluster
    
    参数:
    
    request - contains instanceID and clusterID
  - getTemplateInfo
```
public TemplateInfoResponse getTemplateInfo(TemplateIdRequest request)
```
    get the TemplateInfo
    
    参数:
    
    request - contains the templateID and adminPassword
    
    返回:
    
    all of config message of the template
  - deleteTemplate
```
public NormalResponse deleteTemplate(TemplateIdRequest request)
```
    delete template by id
    
    参数:
    
    request - contains templateid and adminPassword
    
    返回:
    
    success message
  - listTemplate
```
public TemplateListResponse listTemplate(TemplateListRequest request)
```
    list all of template of an user
    
    参数:
    
    request - contains the username
    
    返回:
    
    template info list
  - createSchedulePlan
```
public ScheduleCreateResponse createSchedulePlan(CreateSchedulePlanRequest request)
```
    create a scheduleplan
    
    参数:
    
    request - contains templateId ,steps,period,timeUnit
    
    返回:
    
    a scheduleplanId
  - updateSchedulePlan
```
public ScheduleResultResponse updateSchedulePlan(UpdateSchedulePlanRequest request)
```
    update a schedulePlan
    
    参数:
    
    request - contains scheduleplanId ,steps config,schedule message
    
    返回:
    
    code, msg, success
  - deleteSchedulePlan
```
public ScheduleResultResponse deleteSchedulePlan(SchedulePlanRequest request)
```
    delete scheduleplan id
    
    参数:
    
    request - contains schedulePlanId
    
    返回:
    
    result
  - stopSchedulePlan
```
public ScheduleResultResponse stopSchedulePlan(SchedulePlanRequest request)
```
    stip scheduleplan
    
    参数:
    
    request - contains scheduleplan id
    
    返回:
    
    result
  - startSchedulePlan
```
public ScheduleResultResponse startSchedulePlan(SchedulePlanRequest request)
```
    start a scheduleplan
    
    参数:
    
    request - scheduleplan's id
    
    返回:
    
    result
  - getSchedulePlanDetail
```
public SchedulePlanDetailResponse getSchedulePlanDetail(SchedulePlanRequest request)
```
    get a schedulePlan's detail
    
    参数:
    
    request - contains schedulePlanId
    
    返回:
    
    the detail of a schedulePlan
  - listSchedulePlanDetail
```
public SchedulePlanDetailListResponse listSchedulePlanDetail(ListScheduleDetailRequest request)
```
    list the detail of a schedulePlan
    
    参数:
    
    request - contains nothing
    
    返回:
    
    the schedulePlan 's detail
  - listHistory
```
public ListHistorySchedulePlanResponse listHistory(SchedulePlanRequest request)
```
    list history steps of a shcduleplan
    
    参数:
    
    request - contains shcadulePlanId
    
    返回:
    
    history steps
  - bindEip
```
public void bindEip(EipBindRequest request)
```
    bind EIP for the bmr instance of a cluster
    
    参数:
    
    request - bind request
  - unBindEip
```
public void unBindEip(EipUnBindRequest request)
```
    unbind EIP for the bmr instance of a cluster
    
    参数:
    
    request - unbind request
  - listClusterHosts
```
public ListClusterHostsResponse listClusterHosts(String clusterId)
```
    List host info for a cluster
    
    参数:
    
    clusterId - cluster uuid

类 BmrClient

字段概要

从类继承的字段 com.baidubce.AbstractBceClient

构造器概要

方法概要

从类继承的方法 com.baidubce.AbstractBceClient

从类继承的方法 java.lang.Object

构造器详细资料

BmrClient

BmrClient

方法详细资料

listClusters

listClusters

listClusters

listClusters

getCluster

getClusterAmbariPassword

saveTemplateByCluster

getCluster

createCluster

createTemplate

getCluseterDetail

createclusterByTemplate

modifyInstanceGroups

terminateCluster

terminateCluster

listInstanceGroups

listInstanceGroups

listInstances

listInstances

addSteps

cancelSteps

listSteps

listSteps

listSteps

listSteps

getStep

getStep

deleteEip

renameCluster

addEip

getTemplateInfo

deleteTemplate

listTemplate

createSchedulePlan

updateSchedulePlan

deleteSchedulePlan

stopSchedulePlan

startSchedulePlan

getSchedulePlanDetail

listSchedulePlanDetail

listHistory

bindEip

unBindEip

listClusterHosts