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 limit for the amount of data scanned per query, if it is specified. 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.
`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.
`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`	`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`	`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.
    
    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.
  - 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.
    
    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.
  - 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.
    
    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.
    
    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.
  - 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

toString

equals

hashCode

clone

marshall