Package software.amazon.awssdk.services.iot.model

Class DescribeJobTemplateResponse

    • Method Detail

      • jobTemplateArn

        public final String jobTemplateArn()

        The ARN of the job template.

        Returns:
        The ARN of the job template.

      • jobTemplateId

        public final String jobTemplateId()

        The unique identifier of the job template.

        Returns:
        The unique identifier of the job template.

      • description

        public final String description()

        A description of the job template.

        Returns:
        A description of the job template.

      • documentSource

        public final String documentSource()

        An S3 link to the job document.

        Returns:
        An S3 link to the job document.

      • document

        public final String document()

        The job document.

        Returns:
        The job document.

      • createdAt

        public final Instant createdAt()

        The time, in seconds since the epoch, when the job template was created.

        Returns:
        The time, in seconds since the epoch, when the job template was created.

      • presignedUrlConfig

        public final PresignedUrlConfig presignedUrlConfig()
        Returns the value of the PresignedUrlConfig property for this object.
        Returns:
        The value of the PresignedUrlConfig property for this object.

      • jobExecutionsRolloutConfig

        public final JobExecutionsRolloutConfig jobExecutionsRolloutConfig()
        Returns the value of the JobExecutionsRolloutConfig property for this object.
        Returns:
        The value of the JobExecutionsRolloutConfig property for this object.

      • abortConfig

        public final AbortConfig abortConfig()
        Returns the value of the AbortConfig property for this object.
        Returns:
        The value of the AbortConfig property for this object.

      • timeoutConfig

        public final TimeoutConfig timeoutConfig()
        Returns the value of the TimeoutConfig property for this object.
        Returns:
        The value of the TimeoutConfig property for this object.

      • jobExecutionsRetryConfig

        public final JobExecutionsRetryConfig jobExecutionsRetryConfig()

        The configuration that determines how many retries are allowed for each failure type for a job.

        Returns:
        The configuration that determines how many retries are allowed for each failure type for a job.

      • hasMaintenanceWindows

        public final boolean hasMaintenanceWindows()
        For responses, this returns true if the service returned a value for the MaintenanceWindows 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.

      • maintenanceWindows

        public final List<MaintenanceWindow> maintenanceWindows()

        Allows you to configure an optional maintenance window for the rollout of a job document to all devices in the target group for a job.

        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 hasMaintenanceWindows() method.

        Returns:
        Allows you to configure an optional maintenance window for the rollout of a job document to all devices in the target group for a job.

      • hasDestinationPackageVersions

        public final boolean hasDestinationPackageVersions()
        For responses, this returns true if the service returned a value for the DestinationPackageVersions 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.

      • destinationPackageVersions

        public final List<String> destinationPackageVersions()

        The package version Amazon Resource Names (ARNs) that are installed on the device when the job successfully completes. The package version must be in either the Published or Deprecated state when the job deploys. For more information, see Package version lifecycle.

        Note:The following Length Constraints relates to a single ARN. Up to 25 package version ARNs are allowed.

        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 hasDestinationPackageVersions() method.

        Returns:
        The package version Amazon Resource Names (ARNs) that are installed on the device when the job successfully completes. The package version must be in either the Published or Deprecated state when the job deploys. For more information, see Package version lifecycle.

        Note:The following Length Constraints relates to a single ARN. Up to 25 package version ARNs are allowed.

      • 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