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

Class CreateIngestConfigurationRequest

    • Method Detail

      • name

        public final String name()

        Optional name that can be specified for the IngestConfiguration being created.

        Returns:
        Optional name that can be specified for the IngestConfiguration being created.

      • stageArn

        public final String stageArn()

        ARN of the stage with which the IngestConfiguration is associated.

        Returns:
        ARN of the stage with which the IngestConfiguration is associated.

      • userId

        public final String userId()

        Customer-assigned name to help identify the participant using the IngestConfiguration; this can be used to link a participant to a user in the customer’s own systems. This can be any UTF-8 encoded text. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.

        Returns:
        Customer-assigned name to help identify the participant using the IngestConfiguration; this can be used to link a participant to a user in the customer’s own systems. This can be any UTF-8 encoded text. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.

      • hasAttributes

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

      • attributes

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

        Application-provided attributes to store in the IngestConfiguration and attach to a stage. Map keys and values can contain UTF-8 encoded text. The maximum length of this field is 1 KB total. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.

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

        Returns:
        Application-provided attributes to store in the IngestConfiguration and attach to a stage. Map keys and values can contain UTF-8 encoded text. The maximum length of this field is 1 KB total. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.

      • ingestProtocol

        public final IngestProtocol ingestProtocol()

        Type of ingest protocol that the user employs to broadcast. If this is set to RTMP, insecureIngest must be set to true.

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

        Returns:
        Type of ingest protocol that the user employs to broadcast. If this is set to RTMP, insecureIngest must be set to true.
        See Also:
        IngestProtocol

      • ingestProtocolAsString

        public final String ingestProtocolAsString()

        Type of ingest protocol that the user employs to broadcast. If this is set to RTMP, insecureIngest must be set to true.

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

        Returns:
        Type of ingest protocol that the user employs to broadcast. If this is set to RTMP, insecureIngest must be set to true.
        See Also:
        IngestProtocol

      • insecureIngest

        public final Boolean insecureIngest()

        Whether the stage allows insecure RTMP ingest. This must be set to true, if ingestProtocol is set to RTMP. Default: false.

        Returns:
        Whether the stage allows insecure RTMP ingest. This must be set to true, if ingestProtocol is set to RTMP. Default: false.

      • 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 Best practices and strategies in Tagging AWS Resources and Tag Editor 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 Best practices and strategies in Tagging AWS Resources and Tag Editor 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.

      • 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