Class CreateOriginEndpointRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CreateOriginEndpointRequest.Builder,
CreateOriginEndpointRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final String
The name that describes the channel group.final String
The name that describes the channel.final String
A unique, case-sensitive token that you provide to ensure the idempotency of the request.final ContainerType
The type of container to attach to this origin endpoint.final String
The type of container to attach to this origin endpoint.A DASH manifest configuration.final String
Enter any descriptive text that helps you to identify the origin endpoint.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final boolean
For responses, this returns true if the service returned a value for the DashManifests property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the HlsManifests property.final boolean
For responses, this returns true if the service returned a value for the LowLatencyHlsManifests property.final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.An HTTP live streaming (HLS) manifest configuration.A low-latency HLS manifest configuration.final String
The name that describes the origin endpoint.final Segment
segment()
The segment configuration, including the segment name, duration, and other configuration values.static Class
<? extends CreateOriginEndpointRequest.Builder> final Integer
The size of the window (in seconds) to create a window of the live stream that's available for on-demand viewing.tags()
A comma-separated list of tag key:value pairs that you define.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
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
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
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,
containerType
will 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:
-
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,
containerType
will 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:
-
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
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
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
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
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
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.
-
hasDashManifests
public final boolean hasDashManifests()For responses, this returns true if the service returned a value for the DashManifests 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. -
dashManifests
A DASH 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
hasDashManifests()
method.- Returns:
- A DASH 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
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
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 interfaceToCopyableBuilder<CreateOriginEndpointRequest.Builder,
CreateOriginEndpointRequest> - Specified by:
toBuilder
in classMediaPackageV2Request
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. 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, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- 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
-