Class OriginEndpoint
- java.lang.Object
-
- software.amazon.awssdk.services.mediapackage.model.OriginEndpoint
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<OriginEndpoint.Builder,OriginEndpoint>
@Generated("software.amazon.awssdk:codegen") public final class OriginEndpoint extends Object implements SdkPojo, Serializable, ToCopyableBuilder<OriginEndpoint.Builder,OriginEndpoint>
An OriginEndpoint resource configuration.- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceOriginEndpoint.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Stringarn()The Amazon Resource Name (ARN) assigned to the OriginEndpoint.Authorizationauthorization()Returns the value of the Authorization property for this object.static OriginEndpoint.Builderbuilder()StringchannelId()The ID of the Channel the OriginEndpoint is associated with.CmafPackagecmafPackage()Returns the value of the CmafPackage property for this object.StringcreatedAt()The date and time the OriginEndpoint was created.DashPackagedashPackage()Returns the value of the DashPackage property for this object.Stringdescription()A short text description of the OriginEndpoint.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasTags()For responses, this returns true if the service returned a value for the Tags property.booleanhasWhitelist()For responses, this returns true if the service returned a value for the Whitelist property.HlsPackagehlsPackage()Returns the value of the HlsPackage property for this object.Stringid()The ID of the OriginEndpoint.StringmanifestName()A short string appended to the end of the OriginEndpoint URL.MssPackagemssPackage()Returns the value of the MssPackage property for this object.Originationorigination()Control whether origination of video is allowed for this OriginEndpoint.StringoriginationAsString()Control whether origination of video is allowed for this OriginEndpoint.List<SdkField<?>>sdkFields()static Class<? extends OriginEndpoint.Builder>serializableBuilderClass()IntegerstartoverWindowSeconds()Maximum duration (seconds) of content to retain for startover playback.Map<String,String>tags()Returns the value of the Tags property for this object.IntegertimeDelaySeconds()Amount of delay (seconds) to enforce on the playback of live content.OriginEndpoint.BuildertoBuilder()StringtoString()Returns a string representation of this object.Stringurl()The URL of the packaged OriginEndpoint for consumption.List<String>whitelist()A list of source IP CIDR blocks that will be allowed to access the OriginEndpoint.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
arn
public final String arn()
The Amazon Resource Name (ARN) assigned to the OriginEndpoint.- Returns:
- The Amazon Resource Name (ARN) assigned to the OriginEndpoint.
-
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 the OriginEndpoint is associated with.- Returns:
- The ID of the Channel the OriginEndpoint is associated with.
-
cmafPackage
public final CmafPackage cmafPackage()
Returns the value of the CmafPackage property for this object.- Returns:
- The value of the CmafPackage property for this object.
-
createdAt
public final String createdAt()
The date and time the OriginEndpoint was created.- Returns:
- The date and time the OriginEndpoint was created.
-
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.- Returns:
- The ID of the OriginEndpoint.
-
manifestName
public final String manifestName()
A short string appended to the end of the OriginEndpoint URL.- Returns:
- A short string appended to the end of the OriginEndpoint URL.
-
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 originationIf the service returns an enum value that is not available in the current SDK version,
originationwill returnOrigination.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromoriginationAsString().- 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:
Origination
-
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 originationIf the service returns an enum value that is not available in the current SDK version,
originationwill returnOrigination.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromoriginationAsString().- 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:
Origination
-
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 theisEmpty()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.
-
url
public final String url()
The URL of the packaged OriginEndpoint for consumption.- Returns:
- The URL of the packaged OriginEndpoint for consumption.
-
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 theisEmpty()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 OriginEndpoint.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<OriginEndpoint.Builder,OriginEndpoint>
-
builder
public static OriginEndpoint.Builder builder()
-
serializableBuilderClass
public static Class<? extends OriginEndpoint.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
-