Class ColumnStatisticsTaskRun
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<ColumnStatisticsTaskRun.Builder,
ColumnStatisticsTaskRun>
The object that shows the details of the column stats run.
- See Also:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final String
The ID of the Data Catalog where the table resides.A list of the column names.final String
The identifier for the particular column statistics task run.final Instant
The time that this task was created.final String
The Amazon Web Services account ID.final String
The database where the table resides.final Double
The calculated DPU usage in seconds for all autoscaled workers.final Instant
endTime()
The end time of the task.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
The error message for the job.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 ColumnNameList property.final int
hashCode()
final Instant
The last point in time when this task was modified.final Integer
The number of workers used to generate column statistics.final String
role()
The IAM role that the service assumes to generate statistics.final Double
The percentage of rows used to generate statistics.final String
Name of the security configuration that is used to encrypt CloudWatch logs for the column stats task run.static Class
<? extends ColumnStatisticsTaskRun.Builder> final Instant
The start time of the task.final ColumnStatisticsState
status()
The status of the task run.final String
The status of the task run.final String
The name of the table for which column statistics is generated.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.final String
The type of workers being used for generating stats.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
customerId
The Amazon Web Services account ID.
- Returns:
- The Amazon Web Services account ID.
-
columnStatisticsTaskRunId
The identifier for the particular column statistics task run.
- Returns:
- The identifier for the particular column statistics task run.
-
databaseName
The database where the table resides.
- Returns:
- The database where the table resides.
-
tableName
The name of the table for which column statistics is generated.
- Returns:
- The name of the table for which column statistics is generated.
-
hasColumnNameList
public final boolean hasColumnNameList()For responses, this returns true if the service returned a value for the ColumnNameList 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. -
columnNameList
A list of the column names. If none is supplied, all column names for the table will be used by default.
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
hasColumnNameList()
method.- Returns:
- A list of the column names. If none is supplied, all column names for the table will be used by default.
-
catalogID
The ID of the Data Catalog where the table resides. If none is supplied, the Amazon Web Services account ID is used by default.
- Returns:
- The ID of the Data Catalog where the table resides. If none is supplied, the Amazon Web Services account ID is used by default.
-
role
The IAM role that the service assumes to generate statistics.
- Returns:
- The IAM role that the service assumes to generate statistics.
-
sampleSize
The percentage of rows used to generate statistics. If none is supplied, the entire table will be used to generate stats.
- Returns:
- The percentage of rows used to generate statistics. If none is supplied, the entire table will be used to generate stats.
-
securityConfiguration
Name of the security configuration that is used to encrypt CloudWatch logs for the column stats task run.
- Returns:
- Name of the security configuration that is used to encrypt CloudWatch logs for the column stats task run.
-
numberOfWorkers
The number of workers used to generate column statistics. The job is preconfigured to autoscale up to 25 instances.
- Returns:
- The number of workers used to generate column statistics. The job is preconfigured to autoscale up to 25 instances.
-
workerType
The type of workers being used for generating stats. The default is
g.1x
.- Returns:
- The type of workers being used for generating stats. The default is
g.1x
.
-
status
The status of the task run.
If the service returns an enum value that is not available in the current SDK version,
status
will returnColumnStatisticsState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The status of the task run.
- See Also:
-
statusAsString
The status of the task run.
If the service returns an enum value that is not available in the current SDK version,
status
will returnColumnStatisticsState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The status of the task run.
- See Also:
-
creationTime
The time that this task was created.
- Returns:
- The time that this task was created.
-
lastUpdated
The last point in time when this task was modified.
- Returns:
- The last point in time when this task was modified.
-
startTime
The start time of the task.
- Returns:
- The start time of the task.
-
endTime
The end time of the task.
- Returns:
- The end time of the task.
-
errorMessage
The error message for the job.
- Returns:
- The error message for the job.
-
dpuSeconds
The calculated DPU usage in seconds for all autoscaled workers.
- Returns:
- The calculated DPU usage in seconds for all autoscaled workers.
-
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<ColumnStatisticsTaskRun.Builder,
ColumnStatisticsTaskRun> - 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
-