Class UpdateSceneRequest

    • Method Detail

      • workspaceId

        public final String workspaceId()

        The ID of the workspace that contains the scene.

        Returns:
        The ID of the workspace that contains the scene.
      • sceneId

        public final String sceneId()

        The ID of the scene.

        Returns:
        The ID of the scene.
      • contentLocation

        public final String contentLocation()

        The relative path that specifies the location of the content definition file.

        Returns:
        The relative path that specifies the location of the content definition file.
      • description

        public final String description()

        The description of this scene.

        Returns:
        The description of this scene.
      • hasCapabilities

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

        public final List<String> capabilities()

        A list of capabilities that the scene uses to render.

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

        Returns:
        A list of capabilities that the scene uses to render.
      • hasSceneMetadata

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

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

        The scene metadata.

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

        Returns:
        The scene metadata.
      • 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