CreateOriginEndpointRequest (AWS Java SDK :: Services :: AWS Elemental MediaPackage 2.16.67 API)

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(value="software.amazon.awssdk:codegen")
public final class CreateOriginEndpointRequest
extends MediaPackageRequest
implements ToCopyableBuilder<CreateOriginEndpointRequest.Builder,CreateOriginEndpointRequest>

Configuration parameters used to create a new OriginEndpoint.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface CreateOriginEndpointRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`CreateOriginEndpointRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Authorization`	`authorization()` Returns the value of the Authorization property for this object.
`static CreateOriginEndpointRequest.Builder`	`builder()`
`String`	`channelId()` The ID of the Channel that the OriginEndpoint will be associated with.
`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`	`hasTags()` Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasWhitelist()` Returns true if the Whitelist property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`HlsPackage`	`hlsPackage()` Returns the value of the HlsPackage property for this object.
`String`	`id()` The ID of the OriginEndpoint.
`String`	`manifestName()` A short string that will be used as the filename of the OriginEndpoint URL (defaults to "index").
`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 CreateOriginEndpointRequest.Builder>`	`serializableBuilderClass()`
`Integer`	`startoverWindowSeconds()` Maximum duration (seconds) of content to retain for startover playback.
`Map<String,String>`	`tags()` Returns the value of the Tags property for this object.
`Integer`	`timeDelaySeconds()` Amount of delay (seconds) to enforce on the playback of live content.
`CreateOriginEndpointRequest.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.
  - 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:
    
    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 (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()
```
    Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - 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.
    
    You can use hasTags() to see if a value was sent in this field.
    
    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()
```
    Returns true if the Whitelist property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - 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.
    
    You can use hasWhitelist() to see if a value was sent in this field.
    
    Returns:
    
    A list of source IP CIDR blocks that will be allowed to access the OriginEndpoint.
  - toBuilder
```
public CreateOriginEndpointRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CreateOriginEndpointRequest.Builder,CreateOriginEndpointRequest>
    
    Specified by:
    
    toBuilder in class MediaPackageRequest
  - 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)
```
    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

Class CreateOriginEndpointRequest

Nested Class Summary

Method Summary

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

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

authorization

channelId

cmafPackage

dashPackage

description

hlsPackage

id

manifestName

mssPackage

origination

originationAsString

startoverWindowSeconds

hasTags

tags

timeDelaySeconds

hasWhitelist

whitelist

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields