Class CreatePrefetchScheduleResponse
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CreatePrefetchScheduleResponse.Builder,
CreatePrefetchScheduleResponse>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
arn()
The ARN to assign to the prefetch schedule.builder()
final PrefetchConsumption
The configuration settings for MediaTailor's consumption of the prefetched ads from the ad decision server.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 extendsSdkResponse
.final int
hashCode()
final String
name()
The name to assign to the prefetch schedule.final String
The name to assign to the playback configuration.final PrefetchRetrieval
The configuration settings for retrieval of prefetched ads from the ad decision server.static Class
<? extends CreatePrefetchScheduleResponse.Builder> final String
streamId()
An optional stream identifier that MediaTailor uses to prefetch ads for multiple streams that use the same playback configuration.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.services.mediatailor.model.MediaTailorResponse
responseMetadata
Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
arn
The ARN to assign to the prefetch schedule.
- Returns:
- The ARN to assign to the prefetch schedule.
-
consumption
The configuration settings for MediaTailor's consumption of the prefetched ads from the ad decision server. Each consumption configuration contains an end time and an optional start time that define the consumption window. Prefetch schedules automatically expire no earlier than seven days after the end time.
- Returns:
- The configuration settings for MediaTailor's consumption of the prefetched ads from the ad decision server. Each consumption configuration contains an end time and an optional start time that define the consumption window. Prefetch schedules automatically expire no earlier than seven days after the end time.
-
name
The name to assign to the prefetch schedule.
- Returns:
- The name to assign to the prefetch schedule.
-
playbackConfigurationName
The name to assign to the playback configuration.
- Returns:
- The name to assign to the playback configuration.
-
retrieval
The configuration settings for retrieval of prefetched ads from the ad decision server. Only one set of prefetched ads will be retrieved and subsequently consumed for each ad break.
- Returns:
- The configuration settings for retrieval of prefetched ads from the ad decision server. Only one set of prefetched ads will be retrieved and subsequently consumed for each ad break.
-
streamId
An optional stream identifier that MediaTailor uses to prefetch ads for multiple streams that use the same playback configuration. If
StreamId
is specified, MediaTailor returns all of the prefetch schedules with an exact match onStreamId
. If not specified, MediaTailor returns all of the prefetch schedules for the playback configuration, regardless ofStreamId
.- Returns:
- An optional stream identifier that MediaTailor uses to prefetch ads for multiple streams that use the
same playback configuration. If
StreamId
is specified, MediaTailor returns all of the prefetch schedules with an exact match onStreamId
. If not specified, MediaTailor returns all of the prefetch schedules for the playback configuration, regardless ofStreamId
.
-
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<CreatePrefetchScheduleResponse.Builder,
CreatePrefetchScheduleResponse> - Specified by:
toBuilder
in classAwsResponse
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsResponse
-
equals
- Overrides:
equals
in classAwsResponse
-
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:SdkResponse
Used to retrieve the value of a field from any class that extendsSdkResponse
. 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, theSdkResponse.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkResponse
- 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
-