WorkGroupConfigurationUpdates (AWS SDK for Java

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

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class WorkGroupConfigurationUpdates
extends Object
implements Serializable, Cloneable, StructuredPojo
```
The configuration information that will be updated for this 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, whether the workgroup settings override the client-side settings, and the data usage limit for the amount of bytes scanned per query, if it is specified.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

WorkGroupConfigurationUpdates()

Constructors
Constructor and Description
`WorkGroupConfigurationUpdates()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`WorkGroupConfigurationUpdates`	`clone()`
`boolean`	`equals(Object obj)`
`Long`	`getBytesScannedCutoffPerQuery()` The upper 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.
`EngineVersion`	`getEngineVersion()` The engine version requested when a workgroup is updated.
`Boolean`	`getPublishCloudWatchMetricsEnabled()` Indicates whether this workgroup enables publishing metrics to Amazon CloudWatch.
`Boolean`	`getRemoveBytesScannedCutoffPerQuery()` Indicates that the data usage control limit per query is removed.
`Boolean`	`getRequesterPaysEnabled()` If set to `true`, allows members assigned to a workgroup to specify Amazon S3 Requester Pays buckets in queries.
`ResultConfigurationUpdates`	`getResultConfigurationUpdates()` The result configuration information about the queries in this workgroup that will be updated.
`int`	`hashCode()`
`Boolean`	`isEnforceWorkGroupConfiguration()` If set to "true", the settings for the workgroup override client-side settings.
`Boolean`	`isPublishCloudWatchMetricsEnabled()` Indicates whether this workgroup enables publishing metrics to Amazon CloudWatch.
`Boolean`	`isRemoveBytesScannedCutoffPerQuery()` Indicates that the data usage control limit per query is removed.
`Boolean`	`isRequesterPaysEnabled()` If set to `true`, allows members assigned to a workgroup to specify 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 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`	`setEngineVersion(EngineVersion engineVersion)` The engine version requested when a workgroup is updated.
`void`	`setPublishCloudWatchMetricsEnabled(Boolean publishCloudWatchMetricsEnabled)` Indicates whether this workgroup enables publishing metrics to Amazon CloudWatch.
`void`	`setRemoveBytesScannedCutoffPerQuery(Boolean removeBytesScannedCutoffPerQuery)` Indicates that the data usage control limit per query is removed.
`void`	`setRequesterPaysEnabled(Boolean requesterPaysEnabled)` If set to `true`, allows members assigned to a workgroup to specify Amazon S3 Requester Pays buckets in queries.
`void`	`setResultConfigurationUpdates(ResultConfigurationUpdates resultConfigurationUpdates)` The result configuration information about the queries in this workgroup that will be updated.
`String`	`toString()` Returns a string representation of this object.
`WorkGroupConfigurationUpdates`	`withBytesScannedCutoffPerQuery(Long bytesScannedCutoffPerQuery)` The upper limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan.
`WorkGroupConfigurationUpdates`	`withEnforceWorkGroupConfiguration(Boolean enforceWorkGroupConfiguration)` If set to "true", the settings for the workgroup override client-side settings.
`WorkGroupConfigurationUpdates`	`withEngineVersion(EngineVersion engineVersion)` The engine version requested when a workgroup is updated.
`WorkGroupConfigurationUpdates`	`withPublishCloudWatchMetricsEnabled(Boolean publishCloudWatchMetricsEnabled)` Indicates whether this workgroup enables publishing metrics to Amazon CloudWatch.
`WorkGroupConfigurationUpdates`	`withRemoveBytesScannedCutoffPerQuery(Boolean removeBytesScannedCutoffPerQuery)` Indicates that the data usage control limit per query is removed.
`WorkGroupConfigurationUpdates`	`withRequesterPaysEnabled(Boolean requesterPaysEnabled)` If set to `true`, allows members assigned to a workgroup to specify Amazon S3 Requester Pays buckets in queries.
`WorkGroupConfigurationUpdates`	`withResultConfigurationUpdates(ResultConfigurationUpdates resultConfigurationUpdates)` The result configuration information about the queries in this workgroup that will be updated.

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

- Constructor Detail
  - WorkGroupConfigurationUpdates
```
public WorkGroupConfigurationUpdates()
```
- Method Detail
  - 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 WorkGroupConfigurationUpdates 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.
  - setResultConfigurationUpdates
```
public void setResultConfigurationUpdates(ResultConfigurationUpdates resultConfigurationUpdates)
```
    The result configuration information about the queries in this workgroup that will be updated. Includes the updated results location and an updated option for encrypting query results.
    
    Parameters:
    
    resultConfigurationUpdates - The result configuration information about the queries in this workgroup that will be updated. Includes the updated results location and an updated option for encrypting query results.
  - getResultConfigurationUpdates
```
public ResultConfigurationUpdates getResultConfigurationUpdates()
```
    The result configuration information about the queries in this workgroup that will be updated. Includes the updated results location and an updated option for encrypting query results.
    
    Returns:
    
    The result configuration information about the queries in this workgroup that will be updated. Includes the updated results location and an updated option for encrypting query results.
  - withResultConfigurationUpdates
```
public WorkGroupConfigurationUpdates withResultConfigurationUpdates(ResultConfigurationUpdates resultConfigurationUpdates)
```
    The result configuration information about the queries in this workgroup that will be updated. Includes the updated results location and an updated option for encrypting query results.
    
    Parameters:
    
    resultConfigurationUpdates - The result configuration information about the queries in this workgroup that will be updated. Includes the updated results location and an updated option for encrypting query results.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPublishCloudWatchMetricsEnabled
```
public void setPublishCloudWatchMetricsEnabled(Boolean publishCloudWatchMetricsEnabled)
```
    Indicates whether this workgroup enables publishing metrics to Amazon CloudWatch.
    
    Parameters:
    
    publishCloudWatchMetricsEnabled - Indicates whether this workgroup enables publishing metrics to Amazon CloudWatch.
  - getPublishCloudWatchMetricsEnabled
```
public Boolean getPublishCloudWatchMetricsEnabled()
```
    Indicates whether this workgroup enables publishing metrics to Amazon CloudWatch.
    
    Returns:
    
    Indicates whether this workgroup enables publishing metrics to Amazon CloudWatch.
  - withPublishCloudWatchMetricsEnabled
```
public WorkGroupConfigurationUpdates withPublishCloudWatchMetricsEnabled(Boolean publishCloudWatchMetricsEnabled)
```
    Indicates whether this workgroup enables publishing metrics to Amazon CloudWatch.
    
    Parameters:
    
    publishCloudWatchMetricsEnabled - Indicates whether this workgroup enables publishing metrics to Amazon CloudWatch.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isPublishCloudWatchMetricsEnabled
```
public Boolean isPublishCloudWatchMetricsEnabled()
```
    Indicates whether this workgroup enables publishing metrics to Amazon CloudWatch.
    
    Returns:
    
    Indicates whether this workgroup enables publishing metrics to Amazon CloudWatch.
  - setBytesScannedCutoffPerQuery
```
public void setBytesScannedCutoffPerQuery(Long bytesScannedCutoffPerQuery)
```
    The upper limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan.
    
    Parameters:
    
    bytesScannedCutoffPerQuery - The upper limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan.
  - getBytesScannedCutoffPerQuery
```
public Long getBytesScannedCutoffPerQuery()
```
    The upper limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan.
    
    Returns:
    
    The upper limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan.
  - withBytesScannedCutoffPerQuery
```
public WorkGroupConfigurationUpdates withBytesScannedCutoffPerQuery(Long bytesScannedCutoffPerQuery)
```
    The upper limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan.
    
    Parameters:
    
    bytesScannedCutoffPerQuery - The upper 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.
  - setRemoveBytesScannedCutoffPerQuery
```
public void setRemoveBytesScannedCutoffPerQuery(Boolean removeBytesScannedCutoffPerQuery)
```
    Indicates that the data usage control limit per query is removed. WorkGroupConfiguration$BytesScannedCutoffPerQuery
    
    Parameters:
    
    removeBytesScannedCutoffPerQuery - Indicates that the data usage control limit per query is removed. WorkGroupConfiguration$BytesScannedCutoffPerQuery
  - getRemoveBytesScannedCutoffPerQuery
```
public Boolean getRemoveBytesScannedCutoffPerQuery()
```
    Indicates that the data usage control limit per query is removed. WorkGroupConfiguration$BytesScannedCutoffPerQuery
    
    Returns:
    
    Indicates that the data usage control limit per query is removed. WorkGroupConfiguration$BytesScannedCutoffPerQuery
  - withRemoveBytesScannedCutoffPerQuery
```
public WorkGroupConfigurationUpdates withRemoveBytesScannedCutoffPerQuery(Boolean removeBytesScannedCutoffPerQuery)
```
    Indicates that the data usage control limit per query is removed. WorkGroupConfiguration$BytesScannedCutoffPerQuery
    
    Parameters:
    
    removeBytesScannedCutoffPerQuery - Indicates that the data usage control limit per query is removed. WorkGroupConfiguration$BytesScannedCutoffPerQuery
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isRemoveBytesScannedCutoffPerQuery
```
public Boolean isRemoveBytesScannedCutoffPerQuery()
```
    Indicates that the data usage control limit per query is removed. WorkGroupConfiguration$BytesScannedCutoffPerQuery
    
    Returns:
    
    Indicates that the data usage control limit per query is removed. WorkGroupConfiguration$BytesScannedCutoffPerQuery
  - setRequesterPaysEnabled
```
public void setRequesterPaysEnabled(Boolean requesterPaysEnabled)
```
    If set to true, allows members assigned to a workgroup to specify 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 specify 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 specify 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 specify 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 WorkGroupConfigurationUpdates withRequesterPaysEnabled(Boolean requesterPaysEnabled)
```
    If set to true, allows members assigned to a workgroup to specify 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 specify 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 specify 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 specify 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.
  - setEngineVersion
```
public void setEngineVersion(EngineVersion engineVersion)
```
    The engine version requested when a workgroup is updated. After the update, all queries on the workgroup run on the requested engine version. If no value was previously set, the default is Auto. Queries on the AmazonAthenaPreviewFunctionality workgroup run on the preview engine regardless of this setting.
    
    Parameters:
    
    engineVersion - The engine version requested when a workgroup is updated. After the update, all queries on the workgroup run on the requested engine version. If no value was previously set, the default is Auto. Queries on the AmazonAthenaPreviewFunctionality workgroup run on the preview engine regardless of this setting.
  - getEngineVersion
```
public EngineVersion getEngineVersion()
```
    The engine version requested when a workgroup is updated. After the update, all queries on the workgroup run on the requested engine version. If no value was previously set, the default is Auto. Queries on the AmazonAthenaPreviewFunctionality workgroup run on the preview engine regardless of this setting.
    
    Returns:
    
    The engine version requested when a workgroup is updated. After the update, all queries on the workgroup run on the requested engine version. If no value was previously set, the default is Auto. Queries on the AmazonAthenaPreviewFunctionality workgroup run on the preview engine regardless of this setting.
  - withEngineVersion
```
public WorkGroupConfigurationUpdates withEngineVersion(EngineVersion engineVersion)
```
    The engine version requested when a workgroup is updated. After the update, all queries on the workgroup run on the requested engine version. If no value was previously set, the default is Auto. Queries on the AmazonAthenaPreviewFunctionality workgroup run on the preview engine regardless of this setting.
    
    Parameters:
    
    engineVersion - The engine version requested when a workgroup is updated. After the update, all queries on the workgroup run on the requested engine version. If no value was previously set, the default is Auto. Queries on the AmazonAthenaPreviewFunctionality workgroup run on the preview engine regardless of this setting.
    
    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 WorkGroupConfigurationUpdates 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 WorkGroupConfigurationUpdates

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

WorkGroupConfigurationUpdates

Method Detail

setEnforceWorkGroupConfiguration

getEnforceWorkGroupConfiguration

withEnforceWorkGroupConfiguration

isEnforceWorkGroupConfiguration

setResultConfigurationUpdates

getResultConfigurationUpdates

withResultConfigurationUpdates

setPublishCloudWatchMetricsEnabled

getPublishCloudWatchMetricsEnabled

withPublishCloudWatchMetricsEnabled

isPublishCloudWatchMetricsEnabled

setBytesScannedCutoffPerQuery

getBytesScannedCutoffPerQuery

withBytesScannedCutoffPerQuery

setRemoveBytesScannedCutoffPerQuery

getRemoveBytesScannedCutoffPerQuery

withRemoveBytesScannedCutoffPerQuery

isRemoveBytesScannedCutoffPerQuery

setRequesterPaysEnabled

getRequesterPaysEnabled

withRequesterPaysEnabled

isRequesterPaysEnabled

setEngineVersion

getEngineVersion

withEngineVersion

toString

equals

hashCode

clone

marshall