Class ScheduleRunConfiguration

    • Method Detail

      • extraDataPackageArn

        public final String extraDataPackageArn()

        The ARN of the extra data for the run. The extra data is a .zip file that AWS Device Farm extracts to external data for Android or the app's sandbox for iOS.

        Returns:
        The ARN of the extra data for the run. The extra data is a .zip file that AWS Device Farm extracts to external data for Android or the app's sandbox for iOS.
      • networkProfileArn

        public final String networkProfileArn()

        Reserved for internal use.

        Returns:
        Reserved for internal use.
      • locale

        public final String locale()

        Information about the locale that is used for the run.

        Returns:
        Information about the locale that is used for the run.
      • location

        public final Location location()

        Information about the location that is used for the run.

        Returns:
        Information about the location that is used for the run.
      • hasVpceConfigurationArns

        public final boolean hasVpceConfigurationArns()
        For responses, this returns true if the service returned a value for the VpceConfigurationArns property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • vpceConfigurationArns

        public final List<String> vpceConfigurationArns()

        An array of ARNs for your VPC endpoint configurations.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasVpceConfigurationArns() method.

        Returns:
        An array of ARNs for your VPC endpoint configurations.
      • customerArtifactPaths

        public final CustomerArtifactPaths customerArtifactPaths()

        Input CustomerArtifactPaths object for the scheduled run configuration.

        Returns:
        Input CustomerArtifactPaths object for the scheduled run configuration.
      • radios

        public final Radios radios()

        Information about the radio states for the run.

        Returns:
        Information about the radio states for the run.
      • hasAuxiliaryApps

        public final boolean hasAuxiliaryApps()
        For responses, this returns true if the service returned a value for the AuxiliaryApps property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • auxiliaryApps

        public final List<String> auxiliaryApps()

        A list of upload ARNs for app packages to be installed with your app.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAuxiliaryApps() method.

        Returns:
        A list of upload ARNs for app packages to be installed with your app.
      • billingMethod

        public final BillingMethod billingMethod()

        Specifies the billing method for a test run: metered or unmetered. If the parameter is not specified, the default value is metered.

        If you have purchased unmetered device slots, you must set this parameter to unmetered to make use of them. Otherwise, your run counts against your metered time.

        If the service returns an enum value that is not available in the current SDK version, billingMethod will return BillingMethod.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from billingMethodAsString().

        Returns:
        Specifies the billing method for a test run: metered or unmetered. If the parameter is not specified, the default value is metered.

        If you have purchased unmetered device slots, you must set this parameter to unmetered to make use of them. Otherwise, your run counts against your metered time.

        See Also:
        BillingMethod
      • billingMethodAsString

        public final String billingMethodAsString()

        Specifies the billing method for a test run: metered or unmetered. If the parameter is not specified, the default value is metered.

        If you have purchased unmetered device slots, you must set this parameter to unmetered to make use of them. Otherwise, your run counts against your metered time.

        If the service returns an enum value that is not available in the current SDK version, billingMethod will return BillingMethod.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from billingMethodAsString().

        Returns:
        Specifies the billing method for a test run: metered or unmetered. If the parameter is not specified, the default value is metered.

        If you have purchased unmetered device slots, you must set this parameter to unmetered to make use of them. Otherwise, your run counts against your metered time.

        See Also:
        BillingMethod
      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object
      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object
      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object
      • getValueForField

        public final <T> Optional<T> getValueForField​(String fieldName,
                                                      Class<T> clazz)