WorkGroupConfiguration class
The configuration of the workgroup, which includes the location in Amazon S3 where query results are stored, the encryption option, if any, used for query results, whether the Amazon CloudWatch Metrics are enabled for the workgroup and whether workgroup settings override query settings, and the data usage limits for the amount of data scanned per query or per workgroup. The workgroup settings override is specified in EnforceWorkGroupConfiguration (true/false) in the WorkGroupConfiguration. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.
Constructors
- WorkGroupConfiguration({int? bytesScannedCutoffPerQuery, bool? enforceWorkGroupConfiguration, bool? publishCloudWatchMetricsEnabled, bool? requesterPaysEnabled, ResultConfiguration? resultConfiguration})
-
WorkGroupConfiguration.fromJson(Map<
String, dynamic> json) -
factory
Properties
- bytesScannedCutoffPerQuery → int?
-
The upper data usage limit (cutoff) for the amount of bytes a single query
in a workgroup is allowed to scan.
final
- enforceWorkGroupConfiguration → bool?
-
If set to "true", the settings for the workgroup override client-side
settings. If set to "false", client-side settings are used. For more
information, see Workgroup
Settings Override Client-Side Settings.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- publishCloudWatchMetricsEnabled → bool?
-
Indicates that the Amazon CloudWatch metrics are enabled for the workgroup.
final
- requesterPaysEnabled → bool?
-
If set to
true
, allows members assigned to a workgroup to reference Amazon S3 Requester Pays buckets in queries. If set tofalse
, workgroup members cannot query data from Requester Pays buckets, and queries that retrieve data from Requester Pays buckets cause an error. The default isfalse
. For more information about Requester Pays buckets, see Requester Pays Buckets in the Amazon Simple Storage Service Developer Guide.final - resultConfiguration → ResultConfiguration?
-
The configuration for the workgroup, which includes the location in Amazon
S3 where query results are stored and the encryption option, if any, used
for query results. To run the query, you must specify the query results
location using one of the ways: either in the workgroup using this setting,
or for individual queries (client-side), using
ResultConfiguration$OutputLocation. If none of them is set, Athena
issues an error that no output location is provided. For more information,
see Query
Results.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toJson(
) → Map< String, dynamic> -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited