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.CreateDashboardRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<CreateDashboardRequest.Builder,CreateDashboardRequest>

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

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface CreateDashboardRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static CreateDashboardRequest.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasTagsList()`	For responses, this returns true if the service returned a value for the TagsList property.
`boolean`	`hasWidgets()`	For responses, this returns true if the service returned a value for the Widgets property.
`String`	`name()`	The name of the dashboard.
`RefreshSchedule`	`refreshSchedule()`	The refresh schedule configuration for the dashboard.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends CreateDashboardRequest.Builder>`	`serializableBuilderClass()`
`List<Tag>`	`tagsList()`	Returns the value of the TagsList property for this object.
`Boolean`	`terminationProtectionEnabled()`	Specifies whether termination protection is enabled for the dashboard.
`CreateDashboardRequest.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`List<RequestWidget>`	`widgets()`	An array of widgets for a custom 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
  - name
```
public final String name()
```
    The name of the dashboard. The name must be unique to your account.
    
    To create the Highlights dashboard, the name must be AWSCloudTrail-Highlights.
    
    Returns:
    
    The name of the dashboard. The name must be unique to your account.
    
    To create the Highlights dashboard, the name must be AWSCloudTrail-Highlights.
  - refreshSchedule
```
public final RefreshSchedule refreshSchedule()
```
    The refresh schedule configuration for the dashboard.
    
    To create the Highlights dashboard, you must set a refresh schedule and set the Status to ENABLED. The Unit for the refresh schedule must be HOURS and the Value must be 6.
    
    Returns:
    
    The refresh schedule configuration for the dashboard.
    
    To create the Highlights dashboard, you must set a refresh schedule and set the Status to ENABLED. The Unit for the refresh schedule must be HOURS and the Value must be 6.
  - hasTagsList
```
public final boolean hasTagsList()
```
    For responses, this returns true if the service returned a value for the TagsList 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.
  - tagsList
```
public final List<Tag> tagsList()
```
    Returns the value of the TagsList property for this object.
    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 hasTagsList() method.
    
    Returns:
    
    The value of the TagsList property for this object.
  - 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.
  - 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 a custom dashboard. A custom dashboard can have a maximum of ten widgets.
    
    You do not need to specify widgets for the Highlights dashboard.
    
    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 a custom dashboard. A custom dashboard can have a maximum of ten widgets.
    
    You do not need to specify widgets for the Highlights dashboard.
  - toBuilder
```
public CreateDashboardRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CreateDashboardRequest.Builder,CreateDashboardRequest>
    
    Specified by:
    
    toBuilder in class CloudTrailRequest
  - builder
```
public static CreateDashboardRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreateDashboardRequest.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

Class CreateDashboardRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

name

refreshSchedule

hasTagsList

tagsList

terminationProtectionEnabled

hasWidgets

widgets

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField