Package software.amazon.awssdk.services.mediapackage.model

Class CreateOriginEndpointRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.mediapackage.model.MediaPackageRequest
software.amazon.awssdk.services.mediapackage.model.CreateOriginEndpointRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateOriginEndpointRequest.Builder,CreateOriginEndpointRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateOriginEndpointRequest extends MediaPackageRequest implements ToCopyableBuilder<CreateOriginEndpointRequest.Builder,CreateOriginEndpointRequest>
Configuration parameters used to create a new OriginEndpoint.

  • Method Details

    • authorization

      public final Authorization authorization()
      Returns the value of the Authorization property for this object.
      Returns:
      The value of the Authorization property for this object.

    • channelId

      public final String channelId()
      The ID of the Channel that the OriginEndpoint will be associated with. This cannot be changed after the OriginEndpoint is created.
      Returns:
      The ID of the Channel that the OriginEndpoint will be associated with. This cannot be changed after the OriginEndpoint is created.

    • cmafPackage

      public final CmafPackageCreateOrUpdateParameters cmafPackage()
      Returns the value of the CmafPackage property for this object.
      Returns:
      The value of the CmafPackage property for this object.

    • dashPackage

      public final DashPackage dashPackage()
      Returns the value of the DashPackage property for this object.
      Returns:
      The value of the DashPackage property for this object.

    • description

      public final String description()
      A short text description of the OriginEndpoint.
      Returns:
      A short text description of the OriginEndpoint.

    • hlsPackage

      public final HlsPackage hlsPackage()
      Returns the value of the HlsPackage property for this object.
      Returns:
      The value of the HlsPackage property for this object.

    • id

      public final String id()
      The ID of the OriginEndpoint. The ID must be unique within the region and it cannot be changed after the OriginEndpoint is created.
      Returns:
      The ID of the OriginEndpoint. The ID must be unique within the region and it cannot be changed after the OriginEndpoint is created.

    • manifestName

      public final String manifestName()
      A short string that will be used as the filename of the OriginEndpoint URL (defaults to "index").
      Returns:
      A short string that will be used as the filename of the OriginEndpoint URL (defaults to "index").

    • mssPackage

      public final MssPackage mssPackage()
      Returns the value of the MssPackage property for this object.
      Returns:
      The value of the MssPackage property for this object.

    • origination

      public final Origination origination()
      Control whether origination of video is allowed for this OriginEndpoint. If set to ALLOW, the OriginEndpoint may by requested, pursuant to any other form of access control. If set to DENY, the OriginEndpoint may not be requested. This can be helpful for Live to VOD harvesting, or for temporarily disabling origination

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

      Returns:
      Control whether origination of video is allowed for this OriginEndpoint. If set to ALLOW, the OriginEndpoint may by requested, pursuant to any other form of access control. If set to DENY, the OriginEndpoint may not be requested. This can be helpful for Live to VOD harvesting, or for temporarily disabling origination
      See Also:

    • originationAsString

      public final String originationAsString()
      Control whether origination of video is allowed for this OriginEndpoint. If set to ALLOW, the OriginEndpoint may by requested, pursuant to any other form of access control. If set to DENY, the OriginEndpoint may not be requested. This can be helpful for Live to VOD harvesting, or for temporarily disabling origination

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

      Returns:
      Control whether origination of video is allowed for this OriginEndpoint. If set to ALLOW, the OriginEndpoint may by requested, pursuant to any other form of access control. If set to DENY, the OriginEndpoint may not be requested. This can be helpful for Live to VOD harvesting, or for temporarily disabling origination
      See Also:

    • startoverWindowSeconds

      public final Integer startoverWindowSeconds()
      Maximum duration (seconds) of content to retain for startover playback. If not specified, startover playback will be disabled for the OriginEndpoint.
      Returns:
      Maximum duration (seconds) of content to retain for startover playback. If not specified, startover playback will be disabled for the OriginEndpoint.

    • 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()
      Returns the value of the Tags property for this object.

      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:
      The value of the Tags property for this object.

    • timeDelaySeconds

      public final Integer timeDelaySeconds()
      Amount of delay (seconds) to enforce on the playback of live content. If not specified, there will be no time delay in effect for the OriginEndpoint.
      Returns:
      Amount of delay (seconds) to enforce on the playback of live content. If not specified, there will be no time delay in effect for the OriginEndpoint.

    • hasWhitelist

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

    • whitelist

      public final List<String> whitelist()
      A list of source IP CIDR blocks that will be allowed to access the OriginEndpoint.

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

      Returns:
      A list of source IP CIDR blocks that will be allowed to access the OriginEndpoint.

    • toBuilder

      public CreateOriginEndpointRequest.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<CreateOriginEndpointRequest.Builder,CreateOriginEndpointRequest>
      Specified by:
      toBuilder in class MediaPackageRequest
      Returns:
      a builder for type T

    • builder

      public static CreateOriginEndpointRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateOriginEndpointRequest.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.