Package com.amazonaws.services.devicefarm

Class AbstractAWSDeviceFarm

  • All Implemented Interfaces:
    AWSDeviceFarm
    Direct Known Subclasses:
    AbstractAWSDeviceFarmAsync
    public class AbstractAWSDeviceFarm
extends Object
implements AWSDeviceFarm
    Abstract implementation of AWSDeviceFarm. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

    • Constructor Detail

      • AbstractAWSDeviceFarm

        protected AbstractAWSDeviceFarm()

    • Method Detail

      • setEndpoint

        public void setEndpoint​(String endpoint)
        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 interface AWSDeviceFarm
        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.

      • deleteDevicePool

        public DeleteDevicePoolResult deleteDevicePool​(DeleteDevicePoolRequest request)
        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 interface AWSDeviceFarm
        Parameters:
        request - Represents a request to the delete device pool operation.
        Returns:
        Result of the DeleteDevicePool operation returned by the service.

      • deleteProject

        public DeleteProjectResult deleteProject​(DeleteProjectRequest request)
        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 interface AWSDeviceFarm
        Parameters:
        request - Represents a request to the delete project operation.
        Returns:
        Result of the DeleteProject operation returned by the service.

      • deleteRun

        public DeleteRunResult deleteRun​(DeleteRunRequest request)
        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 interface AWSDeviceFarm
        Parameters:
        request - Represents a request to the delete run operation.
        Returns:
        Result of the DeleteRun operation returned by the service.

      • deleteUpload

        public DeleteUploadResult deleteUpload​(DeleteUploadRequest request)
        Description copied from interface: AWSDeviceFarm

        Deletes an upload given the upload ARN.

        Specified by:
        deleteUpload in interface AWSDeviceFarm
        Parameters:
        request - Represents a request to the delete upload operation.
        Returns:
        Result of the DeleteUpload operation returned by the service.

      • getAccountSettings

        public GetAccountSettingsResult getAccountSettings​(GetAccountSettingsRequest request)
        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 interface AWSDeviceFarm
        Parameters:
        request - Represents the request sent to retrieve the account settings.
        Returns:
        Result of the GetAccountSettings operation returned by the service.

      • getDevice

        public GetDeviceResult getDevice​(GetDeviceRequest request)
        Description copied from interface: AWSDeviceFarm

        Gets information about a unique device type.

        Specified by:
        getDevice in interface AWSDeviceFarm
        Parameters:
        request - Represents a request to the get device request.
        Returns:
        Result of the GetDevice operation returned by the service.

      • getJob

        public GetJobResult getJob​(GetJobRequest request)
        Description copied from interface: AWSDeviceFarm

        Gets information about a job.

        Specified by:
        getJob in interface AWSDeviceFarm
        Parameters:
        request - Represents a request to the get job operation.
        Returns:
        Result of the GetJob operation returned by the service.

      • getOfferingStatus

        public GetOfferingStatusResult getOfferingStatus​(GetOfferingStatusRequest request)
        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 interface AWSDeviceFarm
        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

        public GetProjectResult getProject​(GetProjectRequest request)
        Description copied from interface: AWSDeviceFarm

        Gets information about a project.

        Specified by:
        getProject in interface AWSDeviceFarm
        Parameters:
        request - Represents a request to the get project operation.
        Returns:
        Result of the GetProject operation returned by the service.

      • getRun

        public GetRunResult getRun​(GetRunRequest request)
        Description copied from interface: AWSDeviceFarm

        Gets information about a run.

        Specified by:
        getRun in interface AWSDeviceFarm
        Parameters:
        request - Represents a request to the get run operation.
        Returns:
        Result of the GetRun operation returned by the service.

      • getSuite

        public GetSuiteResult getSuite​(GetSuiteRequest request)
        Description copied from interface: AWSDeviceFarm

        Gets information about a suite.

        Specified by:
        getSuite in interface AWSDeviceFarm
        Parameters:
        request - Represents a request to the get suite operation.
        Returns:
        Result of the GetSuite operation returned by the service.

      • getTest

        public GetTestResult getTest​(GetTestRequest request)
        Description copied from interface: AWSDeviceFarm

        Gets information about a test.

        Specified by:
        getTest in interface AWSDeviceFarm
        Parameters:
        request - Represents a request to the get test operation.
        Returns:
        Result of the GetTest operation returned by the service.

      • getUpload

        public GetUploadResult getUpload​(GetUploadRequest request)
        Description copied from interface: AWSDeviceFarm

        Gets information about an upload.

        Specified by:
        getUpload in interface AWSDeviceFarm
        Parameters:
        request - Represents a request to the get upload operation.
        Returns:
        Result of the GetUpload operation returned by the service.

      • listDevices

        public ListDevicesResult listDevices​(ListDevicesRequest request)
        Description copied from interface: AWSDeviceFarm

        Gets information about unique device types.

        Specified by:
        listDevices in interface AWSDeviceFarm
        Parameters:
        request - Represents the result of a list devices request.
        Returns:
        Result of the ListDevices operation returned by the service.

      • listJobs

        public ListJobsResult listJobs​(ListJobsRequest request)
        Description copied from interface: AWSDeviceFarm

        Gets information about jobs.

        Specified by:
        listJobs in interface AWSDeviceFarm
        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 interface AWSDeviceFarm
        Parameters:
        request - Represents the request to list the offering transaction history.
        Returns:
        Result of the ListOfferingTransactions operation returned by the service.

      • listOfferings

        public ListOfferingsResult listOfferings​(ListOfferingsRequest request)
        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 interface AWSDeviceFarm
        Parameters:
        request - Represents the request to list all offerings.
        Returns:
        Result of the ListOfferings operation returned by the service.

      • listRuns

        public ListRunsResult listRuns​(ListRunsRequest request)
        Description copied from interface: AWSDeviceFarm

        Gets information about runs.

        Specified by:
        listRuns in interface AWSDeviceFarm
        Parameters:
        request - Represents a request to the list runs operation.
        Returns:
        Result of the ListRuns operation returned by the service.

      • listSamples

        public ListSamplesResult listSamples​(ListSamplesRequest request)
        Description copied from interface: AWSDeviceFarm

        Gets information about samples.

        Specified by:
        listSamples in interface AWSDeviceFarm
        Parameters:
        request - Represents a request to the list samples operation.
        Returns:
        Result of the ListSamples operation returned by the service.

      • listSuites

        public ListSuitesResult listSuites​(ListSuitesRequest request)
        Description copied from interface: AWSDeviceFarm

        Gets information about suites.

        Specified by:
        listSuites in interface AWSDeviceFarm
        Parameters:
        request - Represents a request to the list suites operation.
        Returns:
        Result of the ListSuites operation returned by the service.

      • listTests

        public ListTestsResult listTests​(ListTestsRequest request)
        Description copied from interface: AWSDeviceFarm

        Gets information about tests.

        Specified by:
        listTests in interface AWSDeviceFarm
        Parameters:
        request - Represents a request to the list tests operation.
        Returns:
        Result of the ListTests operation returned by the service.

      • listUploads

        public ListUploadsResult listUploads​(ListUploadsRequest request)
        Description copied from interface: AWSDeviceFarm

        Gets information about uploads.

        Specified by:
        listUploads in interface AWSDeviceFarm
        Parameters:
        request - Represents a request to the list uploads operation.
        Returns:
        Result of the ListUploads operation returned by the service.

      • purchaseOffering

        public PurchaseOfferingResult purchaseOffering​(PurchaseOfferingRequest request)
        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 interface AWSDeviceFarm
        Parameters:
        request - Represents a request for a purchase offering.
        Returns:
        Result of the PurchaseOffering operation returned by the service.

      • renewOffering

        public RenewOfferingResult renewOffering​(RenewOfferingRequest request)
        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 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:
        renewOffering in interface AWSDeviceFarm
        Parameters:
        request - A request representing an offering renewal.
        Returns:
        Result of the RenewOffering operation returned by the service.

      • stopRun

        public StopRunResult stopRun​(StopRunRequest request)
        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 interface AWSDeviceFarm
        Parameters:
        request - Represents the request to stop a specific run.
        Returns:
        Result of the StopRun operation returned by the service.

      • updateDevicePool

        public UpdateDevicePoolResult updateDevicePool​(UpdateDevicePoolRequest request)
        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 interface AWSDeviceFarm
        Parameters:
        request - Represents a request to the update device pool operation.
        Returns:
        Result of the UpdateDevicePool operation returned by the service.

      • updateProject

        public UpdateProjectResult updateProject​(UpdateProjectRequest request)
        Description copied from interface: AWSDeviceFarm

        Modifies the specified project name, given the project ARN and a new name.

        Specified by:
        updateProject in interface AWSDeviceFarm
        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 interface AWSDeviceFarm

      • getCachedResponseMetadata

        public ResponseMetadata getCachedResponseMetadata​(AmazonWebServiceRequest request)
        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 interface AWSDeviceFarm
        Parameters:
        request - The originally executed request.
        Returns:
        The response metadata for the specified request, or null if none is available.