Class ReportSetting
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<ReportSetting.Builder,
ReportSetting>
Contains detailed information about a report setting.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionaccounts()
These are the accounts to be included in the report.static ReportSetting.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.The Amazon Resource Names (ARNs) of the frameworks a report covers.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the Accounts property.final boolean
For responses, this returns true if the service returned a value for the FrameworkArns property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the OrganizationUnits property.final boolean
For responses, this returns true if the service returned a value for the Regions property.final Integer
The number of frameworks a report covers.These are the Organizational Units to be included in the report.regions()
These are the Regions to be included in the report.final String
Identifies the report template for the report.static Class
<? extends ReportSetting.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 interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
reportTemplate
Identifies the report template for the report. Reports are built using a report template. The report templates are:
RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT
- Returns:
- Identifies the report template for the report. Reports are built using a report template. The report
templates are:
RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT
-
hasFrameworkArns
public final boolean hasFrameworkArns()For responses, this returns true if the service returned a value for the FrameworkArns property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
frameworkArns
The Amazon Resource Names (ARNs) of the frameworks a report covers.
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
hasFrameworkArns()
method.- Returns:
- The Amazon Resource Names (ARNs) of the frameworks a report covers.
-
numberOfFrameworks
The number of frameworks a report covers.
- Returns:
- The number of frameworks a report covers.
-
hasAccounts
public final boolean hasAccounts()For responses, this returns true if the service returned a value for the Accounts property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
accounts
These are the accounts to be included in the report.
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
hasAccounts()
method.- Returns:
- These are the accounts to be included in the report.
-
hasOrganizationUnits
public final boolean hasOrganizationUnits()For responses, this returns true if the service returned a value for the OrganizationUnits property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
organizationUnits
These are the Organizational Units to be included in the report.
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
hasOrganizationUnits()
method.- Returns:
- These are the Organizational Units to be included in the report.
-
hasRegions
public final boolean hasRegions()For responses, this returns true if the service returned a value for the Regions property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
regions
These are the Regions to be included in the report.
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
hasRegions()
method.- Returns:
- These are the Regions to be included in the report.
-
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<ReportSetting.Builder,
ReportSetting> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
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
-
sdkFields
-