Class AbstractAWSDeviceFarm
- All Implemented Interfaces:
AWSDeviceFarm
- Direct Known Subclasses:
AbstractAWSDeviceFarmAsync
AWSDeviceFarm
. Convenient method forms
pass through to the corresponding overload that takes a request object, which
throws an UnsupportedOperationException
.-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptioncreateDevicePool
(CreateDevicePoolRequest request) Creates a device pool.createProject
(CreateProjectRequest request) Creates a new project.createUpload
(CreateUploadRequest request) Uploads an app or test scripts.deleteDevicePool
(DeleteDevicePoolRequest request) Deletes a device pool given the pool ARN.deleteProject
(DeleteProjectRequest request) Deletes an AWS Device Farm project, given the project ARN.deleteRun
(DeleteRunRequest request) Deletes the run, given the run ARN.deleteUpload
(DeleteUploadRequest request) Deletes an upload given the upload ARN.Returns the number of unmetered iOS and/or unmetered Android devices that have been purchased by the account.Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.getDevice
(GetDeviceRequest request) Gets information about a unique device type.getDevicePool
(GetDevicePoolRequest request) Gets information about a device pool.Gets information about compatibility with a device pool.getJob
(GetJobRequest request) Gets information about a job.Gets the current status and future status of all offerings purchased by an AWS account.getProject
(GetProjectRequest request) Gets information about a project.getRun
(GetRunRequest request) Gets information about a run.getSuite
(GetSuiteRequest request) Gets information about a suite.getTest
(GetTestRequest request) Gets information about a test.getUpload
(GetUploadRequest request) Gets information about an upload.listArtifacts
(ListArtifactsRequest request) Gets information about artifacts.listDevicePools
(ListDevicePoolsRequest request) Gets information about device pools.listDevices
(ListDevicesRequest request) Gets information about unique device types.listJobs
(ListJobsRequest request) Gets information about jobs.listOfferings
(ListOfferingsRequest request) Returns a list of products or offerings that the user can manage through the API.Returns a list of all historical purchases, renewals, and system renewal transactions for an AWS account.listProjects
(ListProjectsRequest request) Gets information about projects.listRuns
(ListRunsRequest request) Gets information about runs.listSamples
(ListSamplesRequest request) Gets information about samples.listSuites
(ListSuitesRequest request) Gets information about suites.listTests
(ListTestsRequest request) Gets information about tests.Gets information about unique problems.listUploads
(ListUploadsRequest request) Gets information about uploads.purchaseOffering
(PurchaseOfferingRequest request) Immediately purchases offerings for an AWS account.renewOffering
(RenewOfferingRequest request) Explicitly sets the quantity of devices to renew for an offering, starting from theeffectiveDate
of the next period.scheduleRun
(ScheduleRunRequest request) Schedules a run.void
setEndpoint
(String endpoint) Overrides the default endpoint for this client ("https://devicefarm.us-west-2.amazonaws.com").void
An alternative toAWSDeviceFarm.setEndpoint(String)
, sets the regional endpoint for this client's service calls.void
shutdown()
Shuts down this client object, releasing any resources that might be held open.stopRun
(StopRunRequest request) Initiates a stop request for the current test run.updateDevicePool
(UpdateDevicePoolRequest request) Modifies the name, description, and rules in a device pool given the attributes and the pool ARN.updateProject
(UpdateProjectRequest request) Modifies the specified project name, given the project ARN and a new name.
-
Constructor Details
-
AbstractAWSDeviceFarm
protected AbstractAWSDeviceFarm()
-
-
Method Details
-
setEndpoint
Description copied from interface:AWSDeviceFarm
Overrides the default endpoint for this client ("https://devicefarm.us-west-2.amazonaws.com"). Callers can use this method to control which AWS region they want to work with.Callers can pass in just the endpoint (ex: "devicefarm.us-west-2.amazonaws.com") or a full URL, including the protocol (ex: "https://devicefarm.us-west-2.amazonaws.com"). If the protocol is not specified here, the default protocol from this client's
ClientConfiguration
will be used, which by default is HTTPS.For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID= 3912
This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
- Specified by:
setEndpoint
in interfaceAWSDeviceFarm
- Parameters:
endpoint
- The endpoint (ex: "devicefarm.us-west-2.amazonaws.com") or a full URL, including the protocol (ex: "https://devicefarm.us-west-2.amazonaws.com") of the region specific AWS endpoint this client will communicate with.
-
setRegion
Description copied from interface:AWSDeviceFarm
An alternative toAWSDeviceFarm.setEndpoint(String)
, sets the regional endpoint for this client's service calls. Callers can use this method to control which AWS region they want to work with.By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the
ClientConfiguration
supplied at construction.This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
- Specified by:
setRegion
in interfaceAWSDeviceFarm
- Parameters:
region
- The region this client will communicate with. SeeRegion.getRegion(com.amazonaws.regions.Regions)
for accessing a given region. Must not be null and must be a region where the service is available.- See Also:
-
createDevicePool
Description copied from interface:AWSDeviceFarm
Creates a device pool.
- Specified by:
createDevicePool
in interfaceAWSDeviceFarm
- Parameters:
request
- Represents a request to the create device pool operation.- Returns:
- Result of the CreateDevicePool operation returned by the service.
-
createProject
Description copied from interface:AWSDeviceFarm
Creates a new project.
- Specified by:
createProject
in interfaceAWSDeviceFarm
- Parameters:
request
- Represents a request to the create project operation.- Returns:
- Result of the CreateProject operation returned by the service.
-
createUpload
Description copied from interface:AWSDeviceFarm
Uploads an app or test scripts.
- Specified by:
createUpload
in interfaceAWSDeviceFarm
- Parameters:
request
- Represents a request to the create upload operation.- Returns:
- Result of the CreateUpload operation returned by the service.
-
deleteDevicePool
Description copied from interface:AWSDeviceFarm
Deletes a device pool given the pool ARN. Does not allow deletion of curated pools owned by the system.
- Specified by:
deleteDevicePool
in interfaceAWSDeviceFarm
- Parameters:
request
- Represents a request to the delete device pool operation.- Returns:
- Result of the DeleteDevicePool operation returned by the service.
-
deleteProject
Description copied from interface:AWSDeviceFarm
Deletes an AWS Device Farm project, given the project ARN.
Note Deleting this resource does not stop an in-progress run.
- Specified by:
deleteProject
in interfaceAWSDeviceFarm
- Parameters:
request
- Represents a request to the delete project operation.- Returns:
- Result of the DeleteProject operation returned by the service.
-
deleteRun
Description copied from interface:AWSDeviceFarm
Deletes the run, given the run ARN.
Note Deleting this resource does not stop an in-progress run.
- Specified by:
deleteRun
in interfaceAWSDeviceFarm
- Parameters:
request
- Represents a request to the delete run operation.- Returns:
- Result of the DeleteRun operation returned by the service.
-
deleteUpload
Description copied from interface:AWSDeviceFarm
Deletes an upload given the upload ARN.
- Specified by:
deleteUpload
in interfaceAWSDeviceFarm
- Parameters:
request
- Represents a request to the delete upload operation.- Returns:
- Result of the DeleteUpload operation returned by the service.
-
getAccountSettings
Description copied from interface:AWSDeviceFarm
Returns the number of unmetered iOS and/or unmetered Android devices that have been purchased by the account.
- Specified by:
getAccountSettings
in interfaceAWSDeviceFarm
- Parameters:
request
- Represents the request sent to retrieve the account settings.- Returns:
- Result of the GetAccountSettings operation returned by the service.
-
getDevice
Description copied from interface:AWSDeviceFarm
Gets information about a unique device type.
- Specified by:
getDevice
in interfaceAWSDeviceFarm
- Parameters:
request
- Represents a request to the get device request.- Returns:
- Result of the GetDevice operation returned by the service.
-
getDevicePool
Description copied from interface:AWSDeviceFarm
Gets information about a device pool.
- Specified by:
getDevicePool
in interfaceAWSDeviceFarm
- Parameters:
request
- Represents a request to the get device pool operation.- Returns:
- Result of the GetDevicePool operation returned by the service.
-
getDevicePoolCompatibility
public GetDevicePoolCompatibilityResult getDevicePoolCompatibility(GetDevicePoolCompatibilityRequest request) Description copied from interface:AWSDeviceFarm
Gets information about compatibility with a device pool.
- Specified by:
getDevicePoolCompatibility
in interfaceAWSDeviceFarm
- Parameters:
request
- Represents a request to the get device pool compatibility operation.- Returns:
- Result of the GetDevicePoolCompatibility operation returned by the service.
-
getJob
Description copied from interface:AWSDeviceFarm
Gets information about a job.
- Specified by:
getJob
in interfaceAWSDeviceFarm
- Parameters:
request
- Represents a request to the get job operation.- Returns:
- Result of the GetJob operation returned by the service.
-
getOfferingStatus
Description copied from interface:AWSDeviceFarm
Gets the current status and future status of all offerings purchased by an AWS account. The response indicates how many offerings are currently available and the offerings that will be available in the next period. The API returns a
NotEligible
error if the user is not permitted to invoke the operation. Please contact aws-devicefarm-support@amazon.com if you believe that you should be able to invoke this operation.- Specified by:
getOfferingStatus
in interfaceAWSDeviceFarm
- Parameters:
request
- Represents the request to retrieve the offering status for the specified customer or account.- Returns:
- Result of the GetOfferingStatus operation returned by the service.
-
getProject
Description copied from interface:AWSDeviceFarm
Gets information about a project.
- Specified by:
getProject
in interfaceAWSDeviceFarm
- Parameters:
request
- Represents a request to the get project operation.- Returns:
- Result of the GetProject operation returned by the service.
-
getRun
Description copied from interface:AWSDeviceFarm
Gets information about a run.
- Specified by:
getRun
in interfaceAWSDeviceFarm
- Parameters:
request
- Represents a request to the get run operation.- Returns:
- Result of the GetRun operation returned by the service.
-
getSuite
Description copied from interface:AWSDeviceFarm
Gets information about a suite.
- Specified by:
getSuite
in interfaceAWSDeviceFarm
- Parameters:
request
- Represents a request to the get suite operation.- Returns:
- Result of the GetSuite operation returned by the service.
-
getTest
Description copied from interface:AWSDeviceFarm
Gets information about a test.
- Specified by:
getTest
in interfaceAWSDeviceFarm
- Parameters:
request
- Represents a request to the get test operation.- Returns:
- Result of the GetTest operation returned by the service.
-
getUpload
Description copied from interface:AWSDeviceFarm
Gets information about an upload.
- Specified by:
getUpload
in interfaceAWSDeviceFarm
- Parameters:
request
- Represents a request to the get upload operation.- Returns:
- Result of the GetUpload operation returned by the service.
-
listArtifacts
Description copied from interface:AWSDeviceFarm
Gets information about artifacts.
- Specified by:
listArtifacts
in interfaceAWSDeviceFarm
- Parameters:
request
- Represents a request to the list artifacts operation.- Returns:
- Result of the ListArtifacts operation returned by the service.
-
listDevicePools
Description copied from interface:AWSDeviceFarm
Gets information about device pools.
- Specified by:
listDevicePools
in interfaceAWSDeviceFarm
- Parameters:
request
- Represents the result of a list device pools request.- Returns:
- Result of the ListDevicePools operation returned by the service.
-
listDevices
Description copied from interface:AWSDeviceFarm
Gets information about unique device types.
- Specified by:
listDevices
in interfaceAWSDeviceFarm
- Parameters:
request
- Represents the result of a list devices request.- Returns:
- Result of the ListDevices operation returned by the service.
-
listJobs
Description copied from interface:AWSDeviceFarm
Gets information about jobs.
- Specified by:
listJobs
in interfaceAWSDeviceFarm
- Parameters:
request
- Represents a request to the list jobs operation.- Returns:
- Result of the ListJobs operation returned by the service.
-
listOfferingTransactions
public ListOfferingTransactionsResult listOfferingTransactions(ListOfferingTransactionsRequest request) Description copied from interface:AWSDeviceFarm
Returns a list of all historical purchases, renewals, and system renewal transactions for an AWS account. The list is paginated and ordered by a descending timestamp (most recent transactions are first). The API returns a
NotEligible
error if the user is not permitted to invoke the operation. Please contact aws-devicefarm-support@amazon.com if you believe that you should be able to invoke this operation.- Specified by:
listOfferingTransactions
in interfaceAWSDeviceFarm
- Parameters:
request
- Represents the request to list the offering transaction history.- Returns:
- Result of the ListOfferingTransactions operation returned by the service.
-
listOfferings
Description copied from interface:AWSDeviceFarm
Returns a list of products or offerings that the user can manage through the API. Each offering record indicates the recurring price per unit and the frequency for that offering. The API returns a
NotEligible
error if the user is not permitted to invoke the operation. Please contact aws-devicefarm-support@amazon.com if you believe that you should be able to invoke this operation.- Specified by:
listOfferings
in interfaceAWSDeviceFarm
- Parameters:
request
- Represents the request to list all offerings.- Returns:
- Result of the ListOfferings operation returned by the service.
-
listProjects
Description copied from interface:AWSDeviceFarm
Gets information about projects.
- Specified by:
listProjects
in interfaceAWSDeviceFarm
- Parameters:
request
- Represents a request to the list projects operation.- Returns:
- Result of the ListProjects operation returned by the service.
-
listRuns
Description copied from interface:AWSDeviceFarm
Gets information about runs.
- Specified by:
listRuns
in interfaceAWSDeviceFarm
- Parameters:
request
- Represents a request to the list runs operation.- Returns:
- Result of the ListRuns operation returned by the service.
-
listSamples
Description copied from interface:AWSDeviceFarm
Gets information about samples.
- Specified by:
listSamples
in interfaceAWSDeviceFarm
- Parameters:
request
- Represents a request to the list samples operation.- Returns:
- Result of the ListSamples operation returned by the service.
-
listSuites
Description copied from interface:AWSDeviceFarm
Gets information about suites.
- Specified by:
listSuites
in interfaceAWSDeviceFarm
- Parameters:
request
- Represents a request to the list suites operation.- Returns:
- Result of the ListSuites operation returned by the service.
-
listTests
Description copied from interface:AWSDeviceFarm
Gets information about tests.
- Specified by:
listTests
in interfaceAWSDeviceFarm
- Parameters:
request
- Represents a request to the list tests operation.- Returns:
- Result of the ListTests operation returned by the service.
-
listUniqueProblems
Description copied from interface:AWSDeviceFarm
Gets information about unique problems.
- Specified by:
listUniqueProblems
in interfaceAWSDeviceFarm
- Parameters:
request
- Represents a request to the list unique problems operation.- Returns:
- Result of the ListUniqueProblems operation returned by the service.
-
listUploads
Description copied from interface:AWSDeviceFarm
Gets information about uploads.
- Specified by:
listUploads
in interfaceAWSDeviceFarm
- Parameters:
request
- Represents a request to the list uploads operation.- Returns:
- Result of the ListUploads operation returned by the service.
-
purchaseOffering
Description copied from interface:AWSDeviceFarm
Immediately purchases offerings for an AWS account. Offerings renew with the latest total purchased quantity for an offering, unless the renewal was overridden. The API returns a
NotEligible
error if the user is not permitted to invoke the operation. Please contact aws-devicefarm-support@amazon.com if you believe that you should be able to invoke this operation.- Specified by:
purchaseOffering
in interfaceAWSDeviceFarm
- Parameters:
request
- Represents a request for a purchase offering.- Returns:
- Result of the PurchaseOffering operation returned by the service.
-
renewOffering
Description copied from interface:AWSDeviceFarm
Explicitly sets the quantity of devices to renew for an offering, starting from the
effectiveDate
of the next period. The API returns aNotEligible
error if the user is not permitted to invoke the operation. Please contact aws-devicefarm-support@amazon.com if you believe that you should be able to invoke this operation.- Specified by:
renewOffering
in interfaceAWSDeviceFarm
- Parameters:
request
- A request representing an offering renewal.- Returns:
- Result of the RenewOffering operation returned by the service.
-
scheduleRun
Description copied from interface:AWSDeviceFarm
Schedules a run.
- Specified by:
scheduleRun
in interfaceAWSDeviceFarm
- Parameters:
request
- Represents a request to the schedule run operation.- Returns:
- Result of the ScheduleRun operation returned by the service.
-
stopRun
Description copied from interface:AWSDeviceFarm
Initiates a stop request for the current test run. AWS Device Farm will immediately stop the run on devices where tests have not started executing, and you will not be billed for these devices. On devices where tests have started executing, Setup Suite and Teardown Suite tests will run to completion before stopping execution on those devices. You will be billed for Setup, Teardown, and any tests that were in progress or already completed.
- Specified by:
stopRun
in interfaceAWSDeviceFarm
- Parameters:
request
- Represents the request to stop a specific run.- Returns:
- Result of the StopRun operation returned by the service.
-
updateDevicePool
Description copied from interface:AWSDeviceFarm
Modifies the name, description, and rules in a device pool given the attributes and the pool ARN. Rule updates are all-or-nothing, meaning they can only be updated as a whole (or not at all).
- Specified by:
updateDevicePool
in interfaceAWSDeviceFarm
- Parameters:
request
- Represents a request to the update device pool operation.- Returns:
- Result of the UpdateDevicePool operation returned by the service.
-
updateProject
Description copied from interface:AWSDeviceFarm
Modifies the specified project name, given the project ARN and a new name.
- Specified by:
updateProject
in interfaceAWSDeviceFarm
- Parameters:
request
- Represents a request to the update project operation.- Returns:
- Result of the UpdateProject operation returned by the service.
-
shutdown
public void shutdown()Description copied from interface:AWSDeviceFarm
Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.- Specified by:
shutdown
in interfaceAWSDeviceFarm
-
getCachedResponseMetadata
Description copied from interface:AWSDeviceFarm
Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
- Specified by:
getCachedResponseMetadata
in interfaceAWSDeviceFarm
- Parameters:
request
- The originally executed request.- Returns:
- The response metadata for the specified request, or null if none is available.
-