WorkGroupConfiguration (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.athena.model.WorkGroupConfiguration

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class WorkGroupConfiguration
extends Object
implements Serializable, Cloneable, StructuredPojo
```
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.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

WorkGroupConfiguration()

Constructors
Constructor and Description
`WorkGroupConfiguration()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`WorkGroupConfiguration`	`clone()`
`boolean`	`equals(Object obj)`
`Long`	`getBytesScannedCutoffPerQuery()` The upper data usage limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan.
`Boolean`	`getEnforceWorkGroupConfiguration()` If set to "true", the settings for the workgroup override client-side settings.
`Boolean`	`getPublishCloudWatchMetricsEnabled()` Indicates that the Amazon CloudWatch metrics are enabled for the workgroup.
`Boolean`	`getRequesterPaysEnabled()` If set to `true`, allows members assigned to a workgroup to reference Amazon S3 Requester Pays buckets in queries.
`ResultConfiguration`	`getResultConfiguration()` 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.
`int`	`hashCode()`
`Boolean`	`isEnforceWorkGroupConfiguration()` If set to "true", the settings for the workgroup override client-side settings.
`Boolean`	`isPublishCloudWatchMetricsEnabled()` Indicates that the Amazon CloudWatch metrics are enabled for the workgroup.
`Boolean`	`isRequesterPaysEnabled()` If set to `true`, allows members assigned to a workgroup to reference Amazon S3 Requester Pays buckets in queries.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setBytesScannedCutoffPerQuery(Long bytesScannedCutoffPerQuery)` The upper data usage limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan.
`void`	`setEnforceWorkGroupConfiguration(Boolean enforceWorkGroupConfiguration)` If set to "true", the settings for the workgroup override client-side settings.
`void`	`setPublishCloudWatchMetricsEnabled(Boolean publishCloudWatchMetricsEnabled)` Indicates that the Amazon CloudWatch metrics are enabled for the workgroup.
`void`	`setRequesterPaysEnabled(Boolean requesterPaysEnabled)` If set to `true`, allows members assigned to a workgroup to reference Amazon S3 Requester Pays buckets in queries.
`void`	`setResultConfiguration(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.
`String`	`toString()` Returns a string representation of this object.
`WorkGroupConfiguration`	`withBytesScannedCutoffPerQuery(Long bytesScannedCutoffPerQuery)` The upper data usage limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan.
`WorkGroupConfiguration`	`withEnforceWorkGroupConfiguration(Boolean enforceWorkGroupConfiguration)` If set to "true", the settings for the workgroup override client-side settings.
`WorkGroupConfiguration`	`withPublishCloudWatchMetricsEnabled(Boolean publishCloudWatchMetricsEnabled)` Indicates that the Amazon CloudWatch metrics are enabled for the workgroup.
`WorkGroupConfiguration`	`withRequesterPaysEnabled(Boolean requesterPaysEnabled)` If set to `true`, allows members assigned to a workgroup to reference Amazon S3 Requester Pays buckets in queries.
`WorkGroupConfiguration`	`withResultConfiguration(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.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - WorkGroupConfiguration
```
public WorkGroupConfiguration()
```
- Method Detail
  - setResultConfiguration
```
public void setResultConfiguration(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.
    
    Parameters:
    
    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.
  - getResultConfiguration
```
public ResultConfiguration getResultConfiguration()
```
    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.
    
    Returns:
    
    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.
  - withResultConfiguration
```
public WorkGroupConfiguration withResultConfiguration(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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEnforceWorkGroupConfiguration
```
public void setEnforceWorkGroupConfiguration(Boolean enforceWorkGroupConfiguration)
```
    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.
    
    Parameters:
    
    enforceWorkGroupConfiguration - 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.
  - getEnforceWorkGroupConfiguration
```
public Boolean getEnforceWorkGroupConfiguration()
```
    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.
    
    Returns:
    
    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.
  - withEnforceWorkGroupConfiguration
```
public WorkGroupConfiguration withEnforceWorkGroupConfiguration(Boolean enforceWorkGroupConfiguration)
```
    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.
    
    Parameters:
    
    enforceWorkGroupConfiguration - 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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isEnforceWorkGroupConfiguration
```
public Boolean isEnforceWorkGroupConfiguration()
```
    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.
    
    Returns:
    
    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.
  - setPublishCloudWatchMetricsEnabled
```
public void setPublishCloudWatchMetricsEnabled(Boolean publishCloudWatchMetricsEnabled)
```
    Indicates that the Amazon CloudWatch metrics are enabled for the workgroup.
    
    Parameters:
    
    publishCloudWatchMetricsEnabled - Indicates that the Amazon CloudWatch metrics are enabled for the workgroup.
  - getPublishCloudWatchMetricsEnabled
```
public Boolean getPublishCloudWatchMetricsEnabled()
```
    Indicates that the Amazon CloudWatch metrics are enabled for the workgroup.
    
    Returns:
    
    Indicates that the Amazon CloudWatch metrics are enabled for the workgroup.
  - withPublishCloudWatchMetricsEnabled
```
public WorkGroupConfiguration withPublishCloudWatchMetricsEnabled(Boolean publishCloudWatchMetricsEnabled)
```
    Indicates that the Amazon CloudWatch metrics are enabled for the workgroup.
    
    Parameters:
    
    publishCloudWatchMetricsEnabled - Indicates that the Amazon CloudWatch metrics are enabled for the workgroup.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isPublishCloudWatchMetricsEnabled
```
public Boolean isPublishCloudWatchMetricsEnabled()
```
    Indicates that the Amazon CloudWatch metrics are enabled for the workgroup.
    
    Returns:
    
    Indicates that the Amazon CloudWatch metrics are enabled for the workgroup.
  - setBytesScannedCutoffPerQuery
```
public void setBytesScannedCutoffPerQuery(Long bytesScannedCutoffPerQuery)
```
    The upper data usage limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan.
    
    Parameters:
    
    bytesScannedCutoffPerQuery - The upper data usage limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan.
  - getBytesScannedCutoffPerQuery
```
public Long getBytesScannedCutoffPerQuery()
```
    The upper data usage limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan.
    
    Returns:
    
    The upper data usage limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan.
  - withBytesScannedCutoffPerQuery
```
public WorkGroupConfiguration withBytesScannedCutoffPerQuery(Long bytesScannedCutoffPerQuery)
```
    The upper data usage limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan.
    
    Parameters:
    
    bytesScannedCutoffPerQuery - The upper data usage limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRequesterPaysEnabled
```
public void setRequesterPaysEnabled(Boolean requesterPaysEnabled)
```
    If set to true, allows members assigned to a workgroup to reference Amazon S3 Requester Pays buckets in queries. If set to false, workgroup members cannot query data from Requester Pays buckets, and queries that retrieve data from Requester Pays buckets cause an error. The default is false. For more information about Requester Pays buckets, see Requester Pays Buckets in the Amazon Simple Storage Service Developer Guide.
    
    Parameters:
    
    requesterPaysEnabled - If set to true, allows members assigned to a workgroup to reference Amazon S3 Requester Pays buckets in queries. If set to false, workgroup members cannot query data from Requester Pays buckets, and queries that retrieve data from Requester Pays buckets cause an error. The default is false. For more information about Requester Pays buckets, see Requester Pays Buckets in the Amazon Simple Storage Service Developer Guide.
  - getRequesterPaysEnabled
```
public Boolean getRequesterPaysEnabled()
```
    If set to true, allows members assigned to a workgroup to reference Amazon S3 Requester Pays buckets in queries. If set to false, workgroup members cannot query data from Requester Pays buckets, and queries that retrieve data from Requester Pays buckets cause an error. The default is false. For more information about Requester Pays buckets, see Requester Pays Buckets in the Amazon Simple Storage Service Developer Guide.
    
    Returns:
    
    If set to true, allows members assigned to a workgroup to reference Amazon S3 Requester Pays buckets in queries. If set to false, workgroup members cannot query data from Requester Pays buckets, and queries that retrieve data from Requester Pays buckets cause an error. The default is false. For more information about Requester Pays buckets, see Requester Pays Buckets in the Amazon Simple Storage Service Developer Guide.
  - withRequesterPaysEnabled
```
public WorkGroupConfiguration withRequesterPaysEnabled(Boolean requesterPaysEnabled)
```
    If set to true, allows members assigned to a workgroup to reference Amazon S3 Requester Pays buckets in queries. If set to false, workgroup members cannot query data from Requester Pays buckets, and queries that retrieve data from Requester Pays buckets cause an error. The default is false. For more information about Requester Pays buckets, see Requester Pays Buckets in the Amazon Simple Storage Service Developer Guide.
    
    Parameters:
    
    requesterPaysEnabled - If set to true, allows members assigned to a workgroup to reference Amazon S3 Requester Pays buckets in queries. If set to false, workgroup members cannot query data from Requester Pays buckets, and queries that retrieve data from Requester Pays buckets cause an error. The default is false. For more information about Requester Pays buckets, see Requester Pays Buckets in the Amazon Simple Storage Service Developer Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isRequesterPaysEnabled
```
public Boolean isRequesterPaysEnabled()
```
    If set to true, allows members assigned to a workgroup to reference Amazon S3 Requester Pays buckets in queries. If set to false, workgroup members cannot query data from Requester Pays buckets, and queries that retrieve data from Requester Pays buckets cause an error. The default is false. For more information about Requester Pays buckets, see Requester Pays Buckets in the Amazon Simple Storage Service Developer Guide.
    
    Returns:
    
    If set to true, allows members assigned to a workgroup to reference Amazon S3 Requester Pays buckets in queries. If set to false, workgroup members cannot query data from Requester Pays buckets, and queries that retrieve data from Requester Pays buckets cause an error. The default is false. For more information about Requester Pays buckets, see Requester Pays Buckets in the Amazon Simple Storage Service Developer Guide.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public WorkGroupConfiguration clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class WorkGroupConfiguration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

WorkGroupConfiguration

Method Detail

setResultConfiguration

getResultConfiguration

withResultConfiguration

setEnforceWorkGroupConfiguration

getEnforceWorkGroupConfiguration

withEnforceWorkGroupConfiguration

isEnforceWorkGroupConfiguration

setPublishCloudWatchMetricsEnabled

getPublishCloudWatchMetricsEnabled

withPublishCloudWatchMetricsEnabled

isPublishCloudWatchMetricsEnabled

setBytesScannedCutoffPerQuery

getBytesScannedCutoffPerQuery

withBytesScannedCutoffPerQuery

setRequesterPaysEnabled

getRequesterPaysEnabled

withRequesterPaysEnabled

isRequesterPaysEnabled

toString

equals

hashCode

clone

marshall