Class StopChannelResponse

    • Method Detail

      • arn

        public final String arn()
        The unique arn of the channel.
        Returns:
        The unique arn of the channel.
      • cdiInputSpecification

        public final CdiInputSpecification cdiInputSpecification()
        Specification of CDI inputs for this channel
        Returns:
        Specification of CDI inputs for this channel
      • channelClass

        public final ChannelClass channelClass()
        The class for this channel. STANDARD for a channel with two pipelines or SINGLE_PIPELINE for a channel with one pipeline.

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

        Returns:
        The class for this channel. STANDARD for a channel with two pipelines or SINGLE_PIPELINE for a channel with one pipeline.
        See Also:
        ChannelClass
      • channelClassAsString

        public final String channelClassAsString()
        The class for this channel. STANDARD for a channel with two pipelines or SINGLE_PIPELINE for a channel with one pipeline.

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

        Returns:
        The class for this channel. STANDARD for a channel with two pipelines or SINGLE_PIPELINE for a channel with one pipeline.
        See Also:
        ChannelClass
      • 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<OutputDestination> destinations()
        A list of destinations of the channel. For UDP outputs, there is one destination per output. For other types (HLS, for example), there is one destination per packager.

        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:
        A list of destinations of the channel. For UDP outputs, there is one destination per output. For other types (HLS, for example), there is one destination per packager.
      • hasEgressEndpoints

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

        public final List<ChannelEgressEndpoint> egressEndpoints()
        The endpoints where outgoing connections initiate from

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

        Returns:
        The endpoints where outgoing connections initiate from
      • encoderSettings

        public final EncoderSettings encoderSettings()
        Returns the value of the EncoderSettings property for this object.
        Returns:
        The value of the EncoderSettings property for this object.
      • id

        public final String id()
        The unique id of the channel.
        Returns:
        The unique id of the channel.
      • hasInputAttachments

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

        public final List<InputAttachment> inputAttachments()
        List of input attachments for channel.

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

        Returns:
        List of input attachments for channel.
      • inputSpecification

        public final InputSpecification inputSpecification()
        Specification of network and file inputs for this channel
        Returns:
        Specification of network and file inputs for this channel
      • logLevel

        public final LogLevel logLevel()
        The log level being written to CloudWatch Logs.

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

        Returns:
        The log level being written to CloudWatch Logs.
        See Also:
        LogLevel
      • logLevelAsString

        public final String logLevelAsString()
        The log level being written to CloudWatch Logs.

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

        Returns:
        The log level being written to CloudWatch Logs.
        See Also:
        LogLevel
      • maintenance

        public final MaintenanceStatus maintenance()
        Maintenance settings for this channel.
        Returns:
        Maintenance settings for this channel.
      • name

        public final String name()
        The name of the channel. (user-mutable)
        Returns:
        The name of the channel. (user-mutable)
      • hasPipelineDetails

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

        public final List<PipelineDetail> pipelineDetails()
        Runtime details for the pipelines of a running channel.

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

        Returns:
        Runtime details for the pipelines of a running channel.
      • pipelinesRunningCount

        public final Integer pipelinesRunningCount()
        The number of currently healthy pipelines.
        Returns:
        The number of currently healthy pipelines.
      • roleArn

        public final String roleArn()
        The Amazon Resource Name (ARN) of the role assumed when running the Channel.
        Returns:
        The Amazon Resource Name (ARN) of the role assumed when running the Channel.
      • state

        public final ChannelState state()
        Returns the value of the State property for this object.

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

        Returns:
        The value of the State property for this object.
        See Also:
        ChannelState
      • stateAsString

        public final String stateAsString()
        Returns the value of the State property for this object.

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

        Returns:
        The value of the State property for this object.
        See Also:
        ChannelState
      • 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()
        A collection of key-value pairs.

        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:
        A collection of key-value pairs.
      • 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