Class StartServiceSoftwareUpdateRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<StartServiceSoftwareUpdateRequest.Builder,
StartServiceSoftwareUpdateRequest>
Container for the request parameters to the StartServiceSoftwareUpdate
operation.
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final Long
The Epoch timestamp when you want the service software update to start.final String
The name of the domain that you want to update to the latest service software.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 int
hashCode()
final ScheduleAt
When to start the service software update.final String
When to start the service software update.static Class
<? extends StartServiceSoftwareUpdateRequest.Builder> 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
-
domainName
The name of the domain that you want to update to the latest service software.
- Returns:
- The name of the domain that you want to update to the latest service software.
-
scheduleAt
When to start the service software update.
-
NOW
- Immediately schedules the update to happen in the current hour if there's capacity available. -
TIMESTAMP
- Lets you specify a custom date and time to apply the update. If you specify this value, you must also provide a value forDesiredStartTime
. -
OFF_PEAK_WINDOW
- Marks the update to be picked up during an upcoming off-peak window. There's no guarantee that the update will happen during the next immediate window. Depending on capacity, it might happen in subsequent days.
Default:
NOW
if you don't specify a value forDesiredStartTime
, andTIMESTAMP
if you do.If the service returns an enum value that is not available in the current SDK version,
scheduleAt
will returnScheduleAt.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromscheduleAtAsString()
.- Returns:
- When to start the service software update.
-
NOW
- Immediately schedules the update to happen in the current hour if there's capacity available. -
TIMESTAMP
- Lets you specify a custom date and time to apply the update. If you specify this value, you must also provide a value forDesiredStartTime
. -
OFF_PEAK_WINDOW
- Marks the update to be picked up during an upcoming off-peak window. There's no guarantee that the update will happen during the next immediate window. Depending on capacity, it might happen in subsequent days.
Default:
NOW
if you don't specify a value forDesiredStartTime
, andTIMESTAMP
if you do. -
- See Also:
-
-
scheduleAtAsString
When to start the service software update.
-
NOW
- Immediately schedules the update to happen in the current hour if there's capacity available. -
TIMESTAMP
- Lets you specify a custom date and time to apply the update. If you specify this value, you must also provide a value forDesiredStartTime
. -
OFF_PEAK_WINDOW
- Marks the update to be picked up during an upcoming off-peak window. There's no guarantee that the update will happen during the next immediate window. Depending on capacity, it might happen in subsequent days.
Default:
NOW
if you don't specify a value forDesiredStartTime
, andTIMESTAMP
if you do.If the service returns an enum value that is not available in the current SDK version,
scheduleAt
will returnScheduleAt.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromscheduleAtAsString()
.- Returns:
- When to start the service software update.
-
NOW
- Immediately schedules the update to happen in the current hour if there's capacity available. -
TIMESTAMP
- Lets you specify a custom date and time to apply the update. If you specify this value, you must also provide a value forDesiredStartTime
. -
OFF_PEAK_WINDOW
- Marks the update to be picked up during an upcoming off-peak window. There's no guarantee that the update will happen during the next immediate window. Depending on capacity, it might happen in subsequent days.
Default:
NOW
if you don't specify a value forDesiredStartTime
, andTIMESTAMP
if you do. -
- See Also:
-
-
desiredStartTime
The Epoch timestamp when you want the service software update to start. You only need to specify this parameter if you set
ScheduleAt
toTIMESTAMP
.- Returns:
- The Epoch timestamp when you want the service software update to start. You only need to specify this
parameter if you set
ScheduleAt
toTIMESTAMP
.
-
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<StartServiceSoftwareUpdateRequest.Builder,
StartServiceSoftwareUpdateRequest> - Specified by:
toBuilder
in classOpenSearchRequest
- 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
-