Package software.amazon.awssdk.services.ivsrealtime.model

Class Composition

    • Method Detail

      • arn

        public final String arn()

        ARN of the Composition resource.

        Returns:
        ARN of the Composition resource.

      • hasDestinations

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

      • destinations

        public final List<Destination> destinations()

        Array of Destination objects. A Composition can contain either one destination (channel or s3) or two (one channel and one s3).

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

        Returns:
        Array of Destination objects. A Composition can contain either one destination (channel or s3) or two (one channel and one s3).

      • endTime

        public final Instant endTime()

        UTC time of the Composition end. This is an ISO 8601 timestamp; note that this is returned as a string.

        Returns:
        UTC time of the Composition end. This is an ISO 8601 timestamp; note that this is returned as a string.

      • layout

        public final LayoutConfiguration layout()

        Layout object to configure composition parameters.

        Returns:
        Layout object to configure composition parameters.

      • stageArn

        public final String stageArn()

        ARN of the stage used as input

        Returns:
        ARN of the stage used as input

      • startTime

        public final Instant startTime()

        UTC time of the Composition start. This is an ISO 8601 timestamp; note that this is returned as a string.

        Returns:
        UTC time of the Composition start. This is an ISO 8601 timestamp; note that this is returned as a string.

      • hasTags

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

      • tags

        public final Map<String,​String> tags()

        Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented there.

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

        Returns:
        Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented there.

      • 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)