com.amazonaws.services.lakeformation.model.GetTemporaryGlueTableCredentialsRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-lakeformation 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.lakeformation.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 GetTemporaryGlueTableCredentialsRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The ARN identifying a table in the Data Catalog for the temporary credentials request.
*
*/
private String tableArn;
/**
*
* Filters the request based on the user having been granted a list of specified permissions on the requested
* resource(s).
*
*/
private java.util.List permissions;
/**
*
* The time period, between 900 and 21,600 seconds, for the timeout of the temporary credentials.
*
*/
private Integer durationSeconds;
/**
*
* A structure representing context to access a resource (column names, query ID, etc).
*
*/
private AuditContext auditContext;
/**
*
* A list of supported permission types for the table. Valid values are COLUMN_PERMISSION
and
* CELL_FILTER_PERMISSION
.
*
*/
private java.util.List supportedPermissionTypes;
/**
*
* The Amazon S3 path for the table.
*
*/
private String s3Path;
/**
*
* A structure used as a protocol between query engines and Lake Formation or Glue. Contains both a Lake Formation
* generated authorization identifier and information from the request's authorization context.
*
*/
private QuerySessionContext querySessionContext;
/**
*
* The ARN identifying a table in the Data Catalog for the temporary credentials request.
*
*
* @param tableArn
* The ARN identifying a table in the Data Catalog for the temporary credentials request.
*/
public void setTableArn(String tableArn) {
this.tableArn = tableArn;
}
/**
*
* The ARN identifying a table in the Data Catalog for the temporary credentials request.
*
*
* @return The ARN identifying a table in the Data Catalog for the temporary credentials request.
*/
public String getTableArn() {
return this.tableArn;
}
/**
*
* The ARN identifying a table in the Data Catalog for the temporary credentials request.
*
*
* @param tableArn
* The ARN identifying a table in the Data Catalog for the temporary credentials request.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetTemporaryGlueTableCredentialsRequest withTableArn(String tableArn) {
setTableArn(tableArn);
return this;
}
/**
*
* Filters the request based on the user having been granted a list of specified permissions on the requested
* resource(s).
*
*
* @return Filters the request based on the user having been granted a list of specified permissions on the
* requested resource(s).
* @see Permission
*/
public java.util.List getPermissions() {
return permissions;
}
/**
*
* Filters the request based on the user having been granted a list of specified permissions on the requested
* resource(s).
*
*
* @param permissions
* Filters the request based on the user having been granted a list of specified permissions on the requested
* resource(s).
* @see Permission
*/
public void setPermissions(java.util.Collection permissions) {
if (permissions == null) {
this.permissions = null;
return;
}
this.permissions = new java.util.ArrayList(permissions);
}
/**
*
* Filters the request based on the user having been granted a list of specified permissions on the requested
* resource(s).
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setPermissions(java.util.Collection)} or {@link #withPermissions(java.util.Collection)} if you want to
* override the existing values.
*
*
* @param permissions
* Filters the request based on the user having been granted a list of specified permissions on the requested
* resource(s).
* @return Returns a reference to this object so that method calls can be chained together.
* @see Permission
*/
public GetTemporaryGlueTableCredentialsRequest withPermissions(String... permissions) {
if (this.permissions == null) {
setPermissions(new java.util.ArrayList(permissions.length));
}
for (String ele : permissions) {
this.permissions.add(ele);
}
return this;
}
/**
*
* Filters the request based on the user having been granted a list of specified permissions on the requested
* resource(s).
*
*
* @param permissions
* Filters the request based on the user having been granted a list of specified permissions on the requested
* resource(s).
* @return Returns a reference to this object so that method calls can be chained together.
* @see Permission
*/
public GetTemporaryGlueTableCredentialsRequest withPermissions(java.util.Collection permissions) {
setPermissions(permissions);
return this;
}
/**
*
* Filters the request based on the user having been granted a list of specified permissions on the requested
* resource(s).
*
*
* @param permissions
* Filters the request based on the user having been granted a list of specified permissions on the requested
* resource(s).
* @return Returns a reference to this object so that method calls can be chained together.
* @see Permission
*/
public GetTemporaryGlueTableCredentialsRequest withPermissions(Permission... permissions) {
java.util.ArrayList permissionsCopy = new java.util.ArrayList(permissions.length);
for (Permission value : permissions) {
permissionsCopy.add(value.toString());
}
if (getPermissions() == null) {
setPermissions(permissionsCopy);
} else {
getPermissions().addAll(permissionsCopy);
}
return this;
}
/**
*
* The time period, between 900 and 21,600 seconds, for the timeout of the temporary credentials.
*
*
* @param durationSeconds
* The time period, between 900 and 21,600 seconds, for the timeout of the temporary credentials.
*/
public void setDurationSeconds(Integer durationSeconds) {
this.durationSeconds = durationSeconds;
}
/**
*
* The time period, between 900 and 21,600 seconds, for the timeout of the temporary credentials.
*
*
* @return The time period, between 900 and 21,600 seconds, for the timeout of the temporary credentials.
*/
public Integer getDurationSeconds() {
return this.durationSeconds;
}
/**
*
* The time period, between 900 and 21,600 seconds, for the timeout of the temporary credentials.
*
*
* @param durationSeconds
* The time period, between 900 and 21,600 seconds, for the timeout of the temporary credentials.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetTemporaryGlueTableCredentialsRequest withDurationSeconds(Integer durationSeconds) {
setDurationSeconds(durationSeconds);
return this;
}
/**
*
* A structure representing context to access a resource (column names, query ID, etc).
*
*
* @param auditContext
* A structure representing context to access a resource (column names, query ID, etc).
*/
public void setAuditContext(AuditContext auditContext) {
this.auditContext = auditContext;
}
/**
*
* A structure representing context to access a resource (column names, query ID, etc).
*
*
* @return A structure representing context to access a resource (column names, query ID, etc).
*/
public AuditContext getAuditContext() {
return this.auditContext;
}
/**
*
* A structure representing context to access a resource (column names, query ID, etc).
*
*
* @param auditContext
* A structure representing context to access a resource (column names, query ID, etc).
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetTemporaryGlueTableCredentialsRequest withAuditContext(AuditContext auditContext) {
setAuditContext(auditContext);
return this;
}
/**
*
* A list of supported permission types for the table. Valid values are COLUMN_PERMISSION
and
* CELL_FILTER_PERMISSION
.
*
*
* @return A list of supported permission types for the table. Valid values are COLUMN_PERMISSION
and
* CELL_FILTER_PERMISSION
.
* @see PermissionType
*/
public java.util.List getSupportedPermissionTypes() {
return supportedPermissionTypes;
}
/**
*
* A list of supported permission types for the table. Valid values are COLUMN_PERMISSION
and
* CELL_FILTER_PERMISSION
.
*
*
* @param supportedPermissionTypes
* A list of supported permission types for the table. Valid values are COLUMN_PERMISSION
and
* CELL_FILTER_PERMISSION
.
* @see PermissionType
*/
public void setSupportedPermissionTypes(java.util.Collection supportedPermissionTypes) {
if (supportedPermissionTypes == null) {
this.supportedPermissionTypes = null;
return;
}
this.supportedPermissionTypes = new java.util.ArrayList(supportedPermissionTypes);
}
/**
*
* A list of supported permission types for the table. Valid values are COLUMN_PERMISSION
and
* CELL_FILTER_PERMISSION
.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setSupportedPermissionTypes(java.util.Collection)} or
* {@link #withSupportedPermissionTypes(java.util.Collection)} if you want to override the existing values.
*
*
* @param supportedPermissionTypes
* A list of supported permission types for the table. Valid values are COLUMN_PERMISSION
and
* CELL_FILTER_PERMISSION
.
* @return Returns a reference to this object so that method calls can be chained together.
* @see PermissionType
*/
public GetTemporaryGlueTableCredentialsRequest withSupportedPermissionTypes(String... supportedPermissionTypes) {
if (this.supportedPermissionTypes == null) {
setSupportedPermissionTypes(new java.util.ArrayList(supportedPermissionTypes.length));
}
for (String ele : supportedPermissionTypes) {
this.supportedPermissionTypes.add(ele);
}
return this;
}
/**
*
* A list of supported permission types for the table. Valid values are COLUMN_PERMISSION
and
* CELL_FILTER_PERMISSION
.
*
*
* @param supportedPermissionTypes
* A list of supported permission types for the table. Valid values are COLUMN_PERMISSION
and
* CELL_FILTER_PERMISSION
.
* @return Returns a reference to this object so that method calls can be chained together.
* @see PermissionType
*/
public GetTemporaryGlueTableCredentialsRequest withSupportedPermissionTypes(java.util.Collection supportedPermissionTypes) {
setSupportedPermissionTypes(supportedPermissionTypes);
return this;
}
/**
*
* A list of supported permission types for the table. Valid values are COLUMN_PERMISSION
and
* CELL_FILTER_PERMISSION
.
*
*
* @param supportedPermissionTypes
* A list of supported permission types for the table. Valid values are COLUMN_PERMISSION
and
* CELL_FILTER_PERMISSION
.
* @return Returns a reference to this object so that method calls can be chained together.
* @see PermissionType
*/
public GetTemporaryGlueTableCredentialsRequest withSupportedPermissionTypes(PermissionType... supportedPermissionTypes) {
java.util.ArrayList supportedPermissionTypesCopy = new java.util.ArrayList(supportedPermissionTypes.length);
for (PermissionType value : supportedPermissionTypes) {
supportedPermissionTypesCopy.add(value.toString());
}
if (getSupportedPermissionTypes() == null) {
setSupportedPermissionTypes(supportedPermissionTypesCopy);
} else {
getSupportedPermissionTypes().addAll(supportedPermissionTypesCopy);
}
return this;
}
/**
*
* The Amazon S3 path for the table.
*
*
* @param s3Path
* The Amazon S3 path for the table.
*/
public void setS3Path(String s3Path) {
this.s3Path = s3Path;
}
/**
*
* The Amazon S3 path for the table.
*
*
* @return The Amazon S3 path for the table.
*/
public String getS3Path() {
return this.s3Path;
}
/**
*
* The Amazon S3 path for the table.
*
*
* @param s3Path
* The Amazon S3 path for the table.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetTemporaryGlueTableCredentialsRequest withS3Path(String s3Path) {
setS3Path(s3Path);
return this;
}
/**
*
* A structure used as a protocol between query engines and Lake Formation or Glue. Contains both a Lake Formation
* generated authorization identifier and information from the request's authorization context.
*
*
* @param querySessionContext
* A structure used as a protocol between query engines and Lake Formation or Glue. Contains both a Lake
* Formation generated authorization identifier and information from the request's authorization context.
*/
public void setQuerySessionContext(QuerySessionContext querySessionContext) {
this.querySessionContext = querySessionContext;
}
/**
*
* A structure used as a protocol between query engines and Lake Formation or Glue. Contains both a Lake Formation
* generated authorization identifier and information from the request's authorization context.
*
*
* @return A structure used as a protocol between query engines and Lake Formation or Glue. Contains both a Lake
* Formation generated authorization identifier and information from the request's authorization context.
*/
public QuerySessionContext getQuerySessionContext() {
return this.querySessionContext;
}
/**
*
* A structure used as a protocol between query engines and Lake Formation or Glue. Contains both a Lake Formation
* generated authorization identifier and information from the request's authorization context.
*
*
* @param querySessionContext
* A structure used as a protocol between query engines and Lake Formation or Glue. Contains both a Lake
* Formation generated authorization identifier and information from the request's authorization context.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetTemporaryGlueTableCredentialsRequest withQuerySessionContext(QuerySessionContext querySessionContext) {
setQuerySessionContext(querySessionContext);
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 (getTableArn() != null)
sb.append("TableArn: ").append(getTableArn()).append(",");
if (getPermissions() != null)
sb.append("Permissions: ").append(getPermissions()).append(",");
if (getDurationSeconds() != null)
sb.append("DurationSeconds: ").append(getDurationSeconds()).append(",");
if (getAuditContext() != null)
sb.append("AuditContext: ").append(getAuditContext()).append(",");
if (getSupportedPermissionTypes() != null)
sb.append("SupportedPermissionTypes: ").append(getSupportedPermissionTypes()).append(",");
if (getS3Path() != null)
sb.append("S3Path: ").append(getS3Path()).append(",");
if (getQuerySessionContext() != null)
sb.append("QuerySessionContext: ").append(getQuerySessionContext());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof GetTemporaryGlueTableCredentialsRequest == false)
return false;
GetTemporaryGlueTableCredentialsRequest other = (GetTemporaryGlueTableCredentialsRequest) obj;
if (other.getTableArn() == null ^ this.getTableArn() == null)
return false;
if (other.getTableArn() != null && other.getTableArn().equals(this.getTableArn()) == false)
return false;
if (other.getPermissions() == null ^ this.getPermissions() == null)
return false;
if (other.getPermissions() != null && other.getPermissions().equals(this.getPermissions()) == false)
return false;
if (other.getDurationSeconds() == null ^ this.getDurationSeconds() == null)
return false;
if (other.getDurationSeconds() != null && other.getDurationSeconds().equals(this.getDurationSeconds()) == false)
return false;
if (other.getAuditContext() == null ^ this.getAuditContext() == null)
return false;
if (other.getAuditContext() != null && other.getAuditContext().equals(this.getAuditContext()) == false)
return false;
if (other.getSupportedPermissionTypes() == null ^ this.getSupportedPermissionTypes() == null)
return false;
if (other.getSupportedPermissionTypes() != null && other.getSupportedPermissionTypes().equals(this.getSupportedPermissionTypes()) == false)
return false;
if (other.getS3Path() == null ^ this.getS3Path() == null)
return false;
if (other.getS3Path() != null && other.getS3Path().equals(this.getS3Path()) == false)
return false;
if (other.getQuerySessionContext() == null ^ this.getQuerySessionContext() == null)
return false;
if (other.getQuerySessionContext() != null && other.getQuerySessionContext().equals(this.getQuerySessionContext()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getTableArn() == null) ? 0 : getTableArn().hashCode());
hashCode = prime * hashCode + ((getPermissions() == null) ? 0 : getPermissions().hashCode());
hashCode = prime * hashCode + ((getDurationSeconds() == null) ? 0 : getDurationSeconds().hashCode());
hashCode = prime * hashCode + ((getAuditContext() == null) ? 0 : getAuditContext().hashCode());
hashCode = prime * hashCode + ((getSupportedPermissionTypes() == null) ? 0 : getSupportedPermissionTypes().hashCode());
hashCode = prime * hashCode + ((getS3Path() == null) ? 0 : getS3Path().hashCode());
hashCode = prime * hashCode + ((getQuerySessionContext() == null) ? 0 : getQuerySessionContext().hashCode());
return hashCode;
}
@Override
public GetTemporaryGlueTableCredentialsRequest clone() {
return (GetTemporaryGlueTableCredentialsRequest) super.clone();
}
}