public final class DeploymentsClient extends Object
Modifier and Type | Method and Description |
---|---|
Deployment |
cancelDeployment(String deploymentId)
Cancels a deployment.
|
Response<Deployment> |
cancelDeploymentWithResponse(String deploymentId,
Context context)
Cancels a deployment.
|
Deployment |
createOrUpdateDeployment(String deploymentId,
Deployment deployment)
Creates or updates a deployment.
|
Response<Deployment> |
createOrUpdateDeploymentWithResponse(String deploymentId,
Deployment deployment,
Context context)
Creates or updates a deployment.
|
void |
deleteDeployment(String deploymentId)
Deletes a deployment.
|
Response<Void> |
deleteDeploymentWithResponse(String deploymentId,
Context context)
Deletes a deployment.
|
PagedIterable<Deployment> |
getAllDeployments(String filter)
Gets a list of deployments.
|
PagedIterable<Deployment> |
getAllDeployments(String filter,
Context context)
Gets a list of deployments.
|
Deployment |
getDeployment(String deploymentId)
Gets the properties of a deployment.
|
PagedIterable<DeploymentDeviceState> |
getDeploymentDevices(String deploymentId,
String filter)
Gets a list of devices in a deployment along with their state.
|
PagedIterable<DeploymentDeviceState> |
getDeploymentDevices(String deploymentId,
String filter,
Context context)
Gets a list of devices in a deployment along with their state.
|
DeploymentStatus |
getDeploymentStatus(String deploymentId)
Gets the status of a deployment including a breakdown of how many devices in the deployment are in progress,
completed, or failed.
|
Response<DeploymentStatus> |
getDeploymentStatusWithResponse(String deploymentId,
Context context)
Gets the status of a deployment including a breakdown of how many devices in the deployment are in progress,
completed, or failed.
|
Response<Deployment> |
getDeploymentWithResponse(String deploymentId,
Context context)
Gets the properties of a deployment.
|
Deployment |
retryDeployment(String deploymentId)
Retries a deployment with failed devices.
|
Response<Deployment> |
retryDeploymentWithResponse(String deploymentId,
Context context)
Retries a deployment with failed devices.
|
public PagedIterable<Deployment> getAllDeployments(String filter)
filter
- Restricts the set of deployments returned. You can filter on update Provider, Name and Version
property.IllegalArgumentException
- thrown if parameters fail the validation.HttpResponseException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.public PagedIterable<Deployment> getAllDeployments(String filter, Context context)
filter
- Restricts the set of deployments returned. You can filter on update Provider, Name and Version
property.context
- The context to associate with this operation.IllegalArgumentException
- thrown if parameters fail the validation.HttpResponseException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.public Deployment getDeployment(String deploymentId)
deploymentId
- Deployment identifier.IllegalArgumentException
- thrown if parameters fail the validation.HttpResponseException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.public Response<Deployment> getDeploymentWithResponse(String deploymentId, Context context)
deploymentId
- Deployment identifier.context
- The context to associate with this operation.IllegalArgumentException
- thrown if parameters fail the validation.HttpResponseException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.public Deployment createOrUpdateDeployment(String deploymentId, Deployment deployment)
deploymentId
- Deployment identifier.deployment
- The deployment properties.IllegalArgumentException
- thrown if parameters fail the validation.HttpResponseException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.public Response<Deployment> createOrUpdateDeploymentWithResponse(String deploymentId, Deployment deployment, Context context)
deploymentId
- Deployment identifier.deployment
- The deployment properties.context
- The context to associate with this operation.IllegalArgumentException
- thrown if parameters fail the validation.HttpResponseException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.public void deleteDeployment(String deploymentId)
deploymentId
- Deployment identifier.IllegalArgumentException
- thrown if parameters fail the validation.HttpResponseException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.public Response<Void> deleteDeploymentWithResponse(String deploymentId, Context context)
deploymentId
- Deployment identifier.context
- The context to associate with this operation.IllegalArgumentException
- thrown if parameters fail the validation.HttpResponseException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.public DeploymentStatus getDeploymentStatus(String deploymentId)
deploymentId
- Deployment identifier.IllegalArgumentException
- thrown if parameters fail the validation.HttpResponseException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.public Response<DeploymentStatus> getDeploymentStatusWithResponse(String deploymentId, Context context)
deploymentId
- Deployment identifier.context
- The context to associate with this operation.IllegalArgumentException
- thrown if parameters fail the validation.HttpResponseException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.public PagedIterable<DeploymentDeviceState> getDeploymentDevices(String deploymentId, String filter)
deploymentId
- Deployment identifier.filter
- Restricts the set of deployment device states returned. You can filter on deviceId and/or
deviceState.IllegalArgumentException
- thrown if parameters fail the validation.HttpResponseException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.public PagedIterable<DeploymentDeviceState> getDeploymentDevices(String deploymentId, String filter, Context context)
deploymentId
- Deployment identifier.filter
- Restricts the set of deployment device states returned. You can filter on deviceId and/or
deviceState.context
- The context to associate with this operation.IllegalArgumentException
- thrown if parameters fail the validation.HttpResponseException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.public Deployment cancelDeployment(String deploymentId)
deploymentId
- Deployment identifier.IllegalArgumentException
- thrown if parameters fail the validation.HttpResponseException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.public Response<Deployment> cancelDeploymentWithResponse(String deploymentId, Context context)
deploymentId
- Deployment identifier.context
- The context to associate with this operation.IllegalArgumentException
- thrown if parameters fail the validation.HttpResponseException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.public Deployment retryDeployment(String deploymentId)
deploymentId
- Deployment identifier.IllegalArgumentException
- thrown if parameters fail the validation.HttpResponseException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.public Response<Deployment> retryDeploymentWithResponse(String deploymentId, Context context)
deploymentId
- Deployment identifier.context
- The context to associate with this operation.IllegalArgumentException
- thrown if parameters fail the validation.HttpResponseException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.Copyright © 2021. All rights reserved.