Class CreateOriginEndpointRequest
- 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.CreateOriginEndpointRequest
-
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<CreateOriginEndpointRequest.Builder,CreateOriginEndpointRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateOriginEndpointRequest extends MediaPackageV2Request implements ToCopyableBuilder<CreateOriginEndpointRequest.Builder,CreateOriginEndpointRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceCreateOriginEndpointRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static CreateOriginEndpointRequest.Builderbuilder()StringchannelGroupName()The name that describes the channel group.StringchannelName()The name that describes the channel.StringclientToken()A unique, case-sensitive token that you provide to ensure the idempotency of the request.ContainerTypecontainerType()The type of container to attach to this origin endpoint.StringcontainerTypeAsString()The type of container to attach to this origin endpoint.Stringdescription()Enter any descriptive text that helps you to identify the origin endpoint.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasHlsManifests()For responses, this returns true if the service returned a value for the HlsManifests property.booleanhasLowLatencyHlsManifests()For responses, this returns true if the service returned a value for the LowLatencyHlsManifests property.booleanhasTags()For responses, this returns true if the service returned a value for the Tags property.List<CreateHlsManifestConfiguration>hlsManifests()An HTTP live streaming (HLS) manifest configuration.List<CreateLowLatencyHlsManifestConfiguration>lowLatencyHlsManifests()A low-latency HLS manifest configuration.StringoriginEndpointName()The name that describes the origin endpoint.List<SdkField<?>>sdkFields()Segmentsegment()The segment configuration, including the segment name, duration, and other configuration values.static Class<? extends CreateOriginEndpointRequest.Builder>serializableBuilderClass()IntegerstartoverWindowSeconds()The size of the window (in seconds) to create a window of the live stream that's available for on-demand viewing.Map<String,String>tags()A comma-separated list of tag key:value pairs that you define.CreateOriginEndpointRequest.BuildertoBuilder()StringtoString()Returns a string representation of this object.-
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
-
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 must be unique for your account in the AWS Region and channel. You can't use spaces in the name. You can't change the name after you create the endpoint.
- Returns:
- The name that describes the origin endpoint. The name is the primary identifier for the origin endpoint, and must be unique for your account in the AWS Region and channel. You can't use spaces in the name. You can't change the name after you create the endpoint.
-
containerType
public final ContainerType containerType()
The type of container to attach 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. You can't change the container type after you create the endpoint.
If the service returns an enum value that is not available in the current SDK version,
containerTypewill returnContainerType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromcontainerTypeAsString().- Returns:
- The type of container to attach 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. You can't change the container type after you create the endpoint.
- See Also:
ContainerType
-
containerTypeAsString
public final String containerTypeAsString()
The type of container to attach 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. You can't change the container type after you create the endpoint.
If the service returns an enum value that is not available in the current SDK version,
containerTypewill returnContainerType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromcontainerTypeAsString().- Returns:
- The type of container to attach 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. You can't change the container type after you create the endpoint.
- See Also:
ContainerType
-
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.
-
clientToken
public final String clientToken()
A unique, case-sensitive token that you provide to ensure the idempotency of the request.
- Returns:
- A unique, case-sensitive token that you provide to ensure the idempotency of the request.
-
description
public final String description()
Enter any descriptive text that helps you to identify the origin endpoint.
- Returns:
- Enter any descriptive text that helps you to identify the origin endpoint.
-
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 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.
-
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 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.
-
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.
-
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()
A comma-separated list of tag key:value pairs that you define. For example:
"Key1": "Value1","Key2": "Value2"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:
- A comma-separated list of tag key:value pairs that you define. For example:
"Key1": "Value1","Key2": "Value2"
-
toBuilder
public CreateOriginEndpointRequest.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<CreateOriginEndpointRequest.Builder,CreateOriginEndpointRequest>- Specified by:
toBuilderin classMediaPackageV2Request
-
builder
public static CreateOriginEndpointRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends CreateOriginEndpointRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsRequest
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkRequest
-
-