com.amazonaws.services.athena.model.CreateWorkGroupRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-athena Show documentation
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.athena.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class CreateWorkGroupRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The workgroup name.
*
*/
private String name;
/**
*
* Contains configuration information for creating an Athena SQL workgroup or Spark enabled Athena workgroup. Athena
* SQL workgroup configuration includes the location in Amazon S3 where query and calculation results are stored,
* the encryption configuration, if any, used for encrypting query results, whether the Amazon CloudWatch Metrics
* are enabled for the workgroup, the limit for the amount of bytes scanned (cutoff) per query, if it is specified,
* and whether workgroup's settings (specified with EnforceWorkGroupConfiguration) in the
* WorkGroupConfiguration override client-side settings. See
* WorkGroupConfiguration$EnforceWorkGroupConfiguration.
*
*/
private WorkGroupConfiguration configuration;
/**
*
* The workgroup description.
*
*/
private String description;
/**
*
* A list of comma separated tags to add to the workgroup that is created.
*
*/
private java.util.List tags;
/**
*
* The workgroup name.
*
*
* @param name
* The workgroup name.
*/
public void setName(String name) {
this.name = name;
}
/**
*
* The workgroup name.
*
*
* @return The workgroup name.
*/
public String getName() {
return this.name;
}
/**
*
* The workgroup name.
*
*
* @param name
* The workgroup name.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateWorkGroupRequest withName(String name) {
setName(name);
return this;
}
/**
*
* Contains configuration information for creating an Athena SQL workgroup or Spark enabled Athena workgroup. Athena
* SQL workgroup configuration includes the location in Amazon S3 where query and calculation results are stored,
* the encryption configuration, if any, used for encrypting query results, whether the Amazon CloudWatch Metrics
* are enabled for the workgroup, the limit for the amount of bytes scanned (cutoff) per query, if it is specified,
* and whether workgroup's settings (specified with EnforceWorkGroupConfiguration) in the
* WorkGroupConfiguration override client-side settings. See
* WorkGroupConfiguration$EnforceWorkGroupConfiguration.
*
*
* @param configuration
* Contains configuration information for creating an Athena SQL workgroup or Spark enabled Athena workgroup.
* Athena SQL workgroup configuration includes the location in Amazon S3 where query and calculation results
* are stored, the encryption configuration, if any, used for encrypting query results, whether the Amazon
* CloudWatch Metrics are enabled for the workgroup, the limit for the amount of bytes scanned (cutoff) per
* query, if it is specified, and whether workgroup's settings (specified with
* EnforceWorkGroupConfiguration) in the WorkGroupConfiguration override
* client-side settings. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.
*/
public void setConfiguration(WorkGroupConfiguration configuration) {
this.configuration = configuration;
}
/**
*
* Contains configuration information for creating an Athena SQL workgroup or Spark enabled Athena workgroup. Athena
* SQL workgroup configuration includes the location in Amazon S3 where query and calculation results are stored,
* the encryption configuration, if any, used for encrypting query results, whether the Amazon CloudWatch Metrics
* are enabled for the workgroup, the limit for the amount of bytes scanned (cutoff) per query, if it is specified,
* and whether workgroup's settings (specified with EnforceWorkGroupConfiguration) in the
* WorkGroupConfiguration override client-side settings. See
* WorkGroupConfiguration$EnforceWorkGroupConfiguration.
*
*
* @return Contains configuration information for creating an Athena SQL workgroup or Spark enabled Athena
* workgroup. Athena SQL workgroup configuration includes the location in Amazon S3 where query and
* calculation results are stored, the encryption configuration, if any, used for encrypting query results,
* whether the Amazon CloudWatch Metrics are enabled for the workgroup, the limit for the amount of bytes
* scanned (cutoff) per query, if it is specified, and whether workgroup's settings (specified with
* EnforceWorkGroupConfiguration) in the WorkGroupConfiguration override
* client-side settings. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.
*/
public WorkGroupConfiguration getConfiguration() {
return this.configuration;
}
/**
*
* Contains configuration information for creating an Athena SQL workgroup or Spark enabled Athena workgroup. Athena
* SQL workgroup configuration includes the location in Amazon S3 where query and calculation results are stored,
* the encryption configuration, if any, used for encrypting query results, whether the Amazon CloudWatch Metrics
* are enabled for the workgroup, the limit for the amount of bytes scanned (cutoff) per query, if it is specified,
* and whether workgroup's settings (specified with EnforceWorkGroupConfiguration) in the
* WorkGroupConfiguration override client-side settings. See
* WorkGroupConfiguration$EnforceWorkGroupConfiguration.
*
*
* @param configuration
* Contains configuration information for creating an Athena SQL workgroup or Spark enabled Athena workgroup.
* Athena SQL workgroup configuration includes the location in Amazon S3 where query and calculation results
* are stored, the encryption configuration, if any, used for encrypting query results, whether the Amazon
* CloudWatch Metrics are enabled for the workgroup, the limit for the amount of bytes scanned (cutoff) per
* query, if it is specified, and whether workgroup's settings (specified with
* EnforceWorkGroupConfiguration) in the WorkGroupConfiguration override
* client-side settings. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateWorkGroupRequest withConfiguration(WorkGroupConfiguration configuration) {
setConfiguration(configuration);
return this;
}
/**
*
* The workgroup description.
*
*
* @param description
* The workgroup description.
*/
public void setDescription(String description) {
this.description = description;
}
/**
*
* The workgroup description.
*
*
* @return The workgroup description.
*/
public String getDescription() {
return this.description;
}
/**
*
* The workgroup description.
*
*
* @param description
* The workgroup description.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateWorkGroupRequest withDescription(String description) {
setDescription(description);
return this;
}
/**
*
* A list of comma separated tags to add to the workgroup that is created.
*
*
* @return A list of comma separated tags to add to the workgroup that is created.
*/
public java.util.List getTags() {
return tags;
}
/**
*
* A list of comma separated tags to add to the workgroup that is created.
*
*
* @param tags
* A list of comma separated tags to add to the workgroup that is created.
*/
public void setTags(java.util.Collection tags) {
if (tags == null) {
this.tags = null;
return;
}
this.tags = new java.util.ArrayList(tags);
}
/**
*
* A list of comma separated tags to add to the workgroup that is created.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setTags(java.util.Collection)} or {@link #withTags(java.util.Collection)} if you want to override the
* existing values.
*
*
* @param tags
* A list of comma separated tags to add to the workgroup that is created.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateWorkGroupRequest withTags(Tag... tags) {
if (this.tags == null) {
setTags(new java.util.ArrayList(tags.length));
}
for (Tag ele : tags) {
this.tags.add(ele);
}
return this;
}
/**
*
* A list of comma separated tags to add to the workgroup that is created.
*
*
* @param tags
* A list of comma separated tags to add to the workgroup that is created.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateWorkGroupRequest withTags(java.util.Collection tags) {
setTags(tags);
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getName() != null)
sb.append("Name: ").append(getName()).append(",");
if (getConfiguration() != null)
sb.append("Configuration: ").append(getConfiguration()).append(",");
if (getDescription() != null)
sb.append("Description: ").append(getDescription()).append(",");
if (getTags() != null)
sb.append("Tags: ").append(getTags());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof CreateWorkGroupRequest == false)
return false;
CreateWorkGroupRequest other = (CreateWorkGroupRequest) obj;
if (other.getName() == null ^ this.getName() == null)
return false;
if (other.getName() != null && other.getName().equals(this.getName()) == false)
return false;
if (other.getConfiguration() == null ^ this.getConfiguration() == null)
return false;
if (other.getConfiguration() != null && other.getConfiguration().equals(this.getConfiguration()) == false)
return false;
if (other.getDescription() == null ^ this.getDescription() == null)
return false;
if (other.getDescription() != null && other.getDescription().equals(this.getDescription()) == false)
return false;
if (other.getTags() == null ^ this.getTags() == null)
return false;
if (other.getTags() != null && other.getTags().equals(this.getTags()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getName() == null) ? 0 : getName().hashCode());
hashCode = prime * hashCode + ((getConfiguration() == null) ? 0 : getConfiguration().hashCode());
hashCode = prime * hashCode + ((getDescription() == null) ? 0 : getDescription().hashCode());
hashCode = prime * hashCode + ((getTags() == null) ? 0 : getTags().hashCode());
return hashCode;
}
@Override
public CreateWorkGroupRequest clone() {
return (CreateWorkGroupRequest) super.clone();
}
}