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

Class UpdateOriginEndpointRequest

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.UpdateOriginEndpointRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UpdateOriginEndpointRequest.Builder,UpdateOriginEndpointRequest>

@Generated("software.amazon.awssdk:codegen")
public final class UpdateOriginEndpointRequest
extends MediaPackageRequest
implements ToCopyableBuilder<UpdateOriginEndpointRequest.Builder,UpdateOriginEndpointRequest>

Configuration parameters used to update an existing OriginEndpoint.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	UpdateOriginEndpointRequest.Builder

Method Summary

Modifier and Type	Method	Description
Authorization	authorization()	Returns the value of the Authorization property for this object.
static UpdateOriginEndpointRequest.Builder	builder()
CmafPackageCreateOrUpdateParameters	cmafPackage()	Returns the value of the CmafPackage property for this object.
DashPackage	dashPackage()	Returns the value of the DashPackage property for this object.
String	description()	A short text description of the OriginEndpoint.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasWhitelist()	For responses, this returns true if the service returned a value for the Whitelist property.
HlsPackage	hlsPackage()	Returns the value of the HlsPackage property for this object.
String	id()	The ID of the OriginEndpoint to update.
String	manifestName()	A short string that will be appended to the end of the Endpoint URL.
MssPackage	mssPackage()	Returns the value of the MssPackage property for this object.
Origination	origination()	Control whether origination of video is allowed for this OriginEndpoint.
String	originationAsString()	Control whether origination of video is allowed for this OriginEndpoint.
List<SdkField<?>>	sdkFields()
static Class<? extends UpdateOriginEndpointRequest.Builder>	serializableBuilderClass()
Integer	startoverWindowSeconds()	Maximum duration (in seconds) of content to retain for startover playback.
Integer	timeDelaySeconds()	Amount of delay (in seconds) to enforce on the playback of live content.
UpdateOriginEndpointRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
List<String>	whitelist()	A list of source IP CIDR blocks that will be allowed to access the OriginEndpoint.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

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.

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 to update.

Returns:

The ID of the OriginEndpoint to update.

manifestName

public final String manifestName()

A short string that will be appended to the end of the Endpoint URL.

Returns:

A short string that will be appended to the end of the Endpoint 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 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:

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 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:

Origination

startoverWindowSeconds

public final Integer startoverWindowSeconds()

Maximum duration (in seconds) of content to retain for startover playback. If not specified, startover playback will be disabled for the OriginEndpoint.

Returns:

Maximum duration (in seconds) of content to retain for startover playback. If not specified, startover playback will be disabled for the OriginEndpoint.

timeDelaySeconds

public final Integer timeDelaySeconds()

Amount of delay (in 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 (in 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 UpdateOriginEndpointRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UpdateOriginEndpointRequest.Builder,UpdateOriginEndpointRequest>

Specified by:

toBuilder in class MediaPackageRequest

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo