Package software.amazon.awssdk.services.opsworkscm.model

Class StartMaintenanceRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.opsworkscm.model.OpsWorksCmRequest

software.amazon.awssdk.services.opsworkscm.model.StartMaintenanceRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<StartMaintenanceRequest.Builder,StartMaintenanceRequest>

@Generated("software.amazon.awssdk:codegen")
public final class StartMaintenanceRequest
extends OpsWorksCmRequest
implements ToCopyableBuilder<StartMaintenanceRequest.Builder,StartMaintenanceRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	StartMaintenanceRequest.Builder

Method Summary

Modifier and Type	Method	Description
static StartMaintenanceRequest.Builder	builder()
List<EngineAttribute>	engineAttributes()	Engine attributes that are specific to the server on which you want to run maintenance.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasEngineAttributes()	For responses, this returns true if the service returned a value for the EngineAttributes property.
int	hashCode()
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends StartMaintenanceRequest.Builder>	serializableBuilderClass()
String	serverName()	The name of the server on which to run maintenance.
StartMaintenanceRequest.Builder	toBuilder()
String	toString()	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

serverName

public final String serverName()

The name of the server on which to run maintenance.

Returns:

The name of the server on which to run maintenance.

hasEngineAttributes

public final boolean hasEngineAttributes()

For responses, this returns true if the service returned a value for the EngineAttributes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.

engineAttributes

public final List<EngineAttribute> engineAttributes()

Engine attributes that are specific to the server on which you want to run maintenance.

Attributes accepted in a StartMaintenance request for Chef

• CHEF_MAJOR_UPGRADE: If a Chef Automate server is eligible for upgrade to Chef Automate 2, add this engine attribute to a StartMaintenance request and set the value to true to upgrade the server to Chef Automate 2. For more information, see Upgrade an AWS OpsWorks for Chef Automate Server to Chef Automate 2.

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 hasEngineAttributes() method.

Returns:

Engine attributes that are specific to the server on which you want to run maintenance.

Attributes accepted in a StartMaintenance request for Chef

• CHEF_MAJOR_UPGRADE: If a Chef Automate server is eligible for upgrade to Chef Automate 2, add this engine attribute to a StartMaintenance request and set the value to true to upgrade the server to Chef Automate 2. For more information, see Upgrade an AWS OpsWorks for Chef Automate Server to Chef Automate 2.

toBuilder

public StartMaintenanceRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<StartMaintenanceRequest.Builder,StartMaintenanceRequest>

Specified by:

toBuilder in class OpsWorksCmRequest

builder

public static StartMaintenanceRequest.Builder builder()

serializableBuilderClass

public static Class<? extends StartMaintenanceRequest.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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo