Class UpdateOriginEndpointRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.mediapackagev2.model.MediaPackageV2Request
software.amazon.awssdk.services.mediapackagev2.model.UpdateOriginEndpointRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<UpdateOriginEndpointRequest.Builder,UpdateOriginEndpointRequest>
@Generated("software.amazon.awssdk:codegen") public final class UpdateOriginEndpointRequest extends MediaPackageV2Request implements ToCopyableBuilder<UpdateOriginEndpointRequest.Builder,UpdateOriginEndpointRequest>

  • Method Details

    • channelGroupName

      public final String channelGroupName()

      The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.

      Returns:
      The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.

    • channelName

      public final String channelName()

      The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.

      Returns:
      The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.

    • originEndpointName

      public final String originEndpointName()

      The name that describes the origin endpoint. The name is the primary identifier for the origin endpoint, and and must be unique for your account in the AWS Region and channel.

      Returns:
      The name that describes the origin endpoint. The name is the primary identifier for the origin endpoint, and and must be unique for your account in the AWS Region and channel.

    • containerType

      public final ContainerType containerType()

      The type of container attached to this origin endpoint. A container type is a file format that encapsulates one or more media streams, such as audio and video, into a single file.

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

      Returns:
      The type of container attached to this origin endpoint. A container type is a file format that encapsulates one or more media streams, such as audio and video, into a single file.
      See Also:

    • containerTypeAsString

      public final String containerTypeAsString()

      The type of container attached to this origin endpoint. A container type is a file format that encapsulates one or more media streams, such as audio and video, into a single file.

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

      Returns:
      The type of container attached to this origin endpoint. A container type is a file format that encapsulates one or more media streams, such as audio and video, into a single file.
      See Also:

    • segment

      public final Segment segment()

      The segment configuration, including the segment name, duration, and other configuration values.

      Returns:
      The segment configuration, including the segment name, duration, and other configuration values.

    • description

      public final String description()

      Any descriptive information that you want to add to the origin endpoint for future identification purposes.

      Returns:
      Any descriptive information that you want to add to the origin endpoint for future identification purposes.

    • startoverWindowSeconds

      public final Integer startoverWindowSeconds()

      The size of the window (in seconds) to create a window of the live stream that's available for on-demand viewing. Viewers can start-over or catch-up on content that falls within the window. The maximum startover window is 1,209,600 seconds (14 days).

      Returns:
      The size of the window (in seconds) to create a window of the live stream that's available for on-demand viewing. Viewers can start-over or catch-up on content that falls within the window. The maximum startover window is 1,209,600 seconds (14 days).

    • hasHlsManifests

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

    • hlsManifests

      public final List<CreateHlsManifestConfiguration> hlsManifests()

      An HTTP live streaming (HLS) manifest configuration.

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

      Returns:
      An HTTP live streaming (HLS) manifest configuration.

    • hasLowLatencyHlsManifests

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

    • lowLatencyHlsManifests

      public final List<CreateLowLatencyHlsManifestConfiguration> lowLatencyHlsManifests()

      A low-latency HLS manifest configuration.

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

      Returns:
      A low-latency HLS manifest configuration.

    • hasDashManifests

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

    • dashManifests

      public final List<CreateDashManifestConfiguration> dashManifests()

      A DASH manifest configuration.

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

      Returns:
      A DASH manifest configuration.

    • hasMssManifests

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

    • mssManifests

      public final List<CreateMssManifestConfiguration> mssManifests()

      A list of Microsoft Smooth Streaming (MSS) manifest configurations to update for the origin endpoint. This replaces the existing MSS manifest configurations.

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

      Returns:
      A list of Microsoft Smooth Streaming (MSS) manifest configurations to update for the origin endpoint. This replaces the existing MSS manifest configurations.

    • forceEndpointErrorConfiguration

      public final ForceEndpointErrorConfiguration forceEndpointErrorConfiguration()

      The failover settings for the endpoint.

      Returns:
      The failover settings for the endpoint.

    • eTag

      public final String eTag()

      The expected current Entity Tag (ETag) for the resource. If the specified ETag does not match the resource's current entity tag, the update request will be rejected.

      Returns:
      The expected current Entity Tag (ETag) for the resource. If the specified ETag does not match the resource's current entity tag, the update request will be rejected.

    • toBuilder

      public UpdateOriginEndpointRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<UpdateOriginEndpointRequest.Builder,UpdateOriginEndpointRequest>
      Specified by:
      toBuilder in class MediaPackageV2Request
      Returns:
      a builder for type T

    • builder

      public static UpdateOriginEndpointRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends UpdateOriginEndpointRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.