Package software.amazon.awssdk.services.cloudtrail.model

Class UpdateDashboardRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.cloudtrail.model.CloudTrailRequest

software.amazon.awssdk.services.cloudtrail.model.UpdateDashboardRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UpdateDashboardRequest.Builder,UpdateDashboardRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	UpdateDashboardRequest.Builder

Method Summary

Modifier and Type	Method	Description
static UpdateDashboardRequest.Builder	builder()
String	dashboardId()	The name or ARN of the dashboard.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasWidgets()	For responses, this returns true if the service returned a value for the Widgets property.
RefreshSchedule	refreshSchedule()	The refresh schedule configuration for the dashboard.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends UpdateDashboardRequest.Builder>	serializableBuilderClass()
Boolean	terminationProtectionEnabled()	Specifies whether termination protection is enabled for the dashboard.
UpdateDashboardRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
List<RequestWidget>	widgets()	An array of widgets for the dashboard.

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

dashboardId

public final String dashboardId()

The name or ARN of the dashboard.

Returns:

The name or ARN of the dashboard.

hasWidgets

public final boolean hasWidgets()

For responses, this returns true if the service returned a value for the Widgets 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.

widgets

public final List<RequestWidget> widgets()

An array of widgets for the dashboard. A custom dashboard can have a maximum of 10 widgets.

To add new widgets, pass in an array that includes the existing widgets along with any new widgets. Run the GetDashboard operation to get the list of widgets for the dashboard.

To remove widgets, pass in an array that includes the existing widgets minus the widgets you want removed.

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

Returns:

An array of widgets for the dashboard. A custom dashboard can have a maximum of 10 widgets.

To add new widgets, pass in an array that includes the existing widgets along with any new widgets. Run the GetDashboard operation to get the list of widgets for the dashboard.

To remove widgets, pass in an array that includes the existing widgets minus the widgets you want removed.

refreshSchedule

public final RefreshSchedule refreshSchedule()

The refresh schedule configuration for the dashboard.

Returns:

The refresh schedule configuration for the dashboard.

terminationProtectionEnabled

public final Boolean terminationProtectionEnabled()

Specifies whether termination protection is enabled for the dashboard. If termination protection is enabled, you cannot delete the dashboard until termination protection is disabled.

Returns:

Specifies whether termination protection is enabled for the dashboard. If termination protection is enabled, you cannot delete the dashboard until termination protection is disabled.

toBuilder

public UpdateDashboardRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UpdateDashboardRequest.Builder,UpdateDashboardRequest>

Specified by:

toBuilder in class CloudTrailRequest

builder

public static UpdateDashboardRequest.Builder builder()

serializableBuilderClass

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