com.amazonaws.services.s3control.model.CreateAccessGrantsLocationRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-s3control 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.s3control.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 CreateAccessGrantsLocationRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The ID of the Amazon Web Services account that is making this request.
*
*/
private String accountId;
/**
*
* The S3 path to the location that you are registering. The location scope can be the default S3 location
* s3://, the S3 path to a bucket s3://<bucket>, or the S3 path to a bucket and
* prefix s3://<bucket>/<prefix>. A prefix in S3 is a string of characters at the beginning
* of an object key name used to organize the objects that you store in your S3 buckets. For example, object key
* names that start with the engineering/ prefix or object key names that start with the
* marketing/campaigns/ prefix.
*
*/
private String locationScope;
/**
*
* The Amazon Resource Name (ARN) of the IAM role for the registered location. S3 Access Grants assumes this role to
* manage access to the registered location.
*
*/
private String iAMRoleArn;
/**
*
* The Amazon Web Services resource tags that you are adding to the S3 Access Grants location. Each tag is a label
* consisting of a user-defined key and value. Tags can help you manage, identify, organize, search for, and filter
* resources.
*
*/
private java.util.List tags;
/**
*
* The ID of the Amazon Web Services account that is making this request.
*
*
* @param accountId
* The ID of the Amazon Web Services account that is making this request.
*/
public void setAccountId(String accountId) {
this.accountId = accountId;
}
/**
*
* The ID of the Amazon Web Services account that is making this request.
*
*
* @return The ID of the Amazon Web Services account that is making this request.
*/
public String getAccountId() {
return this.accountId;
}
/**
*
* The ID of the Amazon Web Services account that is making this request.
*
*
* @param accountId
* The ID of the Amazon Web Services account that is making this request.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateAccessGrantsLocationRequest withAccountId(String accountId) {
setAccountId(accountId);
return this;
}
/**
*
* The S3 path to the location that you are registering. The location scope can be the default S3 location
* s3://, the S3 path to a bucket s3://<bucket>, or the S3 path to a bucket and
* prefix s3://<bucket>/<prefix>. A prefix in S3 is a string of characters at the beginning
* of an object key name used to organize the objects that you store in your S3 buckets. For example, object key
* names that start with the engineering/ prefix or object key names that start with the
* marketing/campaigns/ prefix.
*
*
* @param locationScope
* The S3 path to the location that you are registering. The location scope can be the default S3 location
* s3://, the S3 path to a bucket s3://<bucket>, or the S3 path to a bucket
* and prefix s3://<bucket>/<prefix>. A prefix in S3 is a string of characters at
* the beginning of an object key name used to organize the objects that you store in your S3 buckets. For
* example, object key names that start with the engineering/ prefix or object key names that
* start with the marketing/campaigns/ prefix.
*/
public void setLocationScope(String locationScope) {
this.locationScope = locationScope;
}
/**
*
* The S3 path to the location that you are registering. The location scope can be the default S3 location
* s3://, the S3 path to a bucket s3://<bucket>, or the S3 path to a bucket and
* prefix s3://<bucket>/<prefix>. A prefix in S3 is a string of characters at the beginning
* of an object key name used to organize the objects that you store in your S3 buckets. For example, object key
* names that start with the engineering/ prefix or object key names that start with the
* marketing/campaigns/ prefix.
*
*
* @return The S3 path to the location that you are registering. The location scope can be the default S3 location
* s3://, the S3 path to a bucket s3://<bucket>, or the S3 path to a bucket
* and prefix s3://<bucket>/<prefix>. A prefix in S3 is a string of characters at
* the beginning of an object key name used to organize the objects that you store in your S3 buckets. For
* example, object key names that start with the engineering/ prefix or object key names that
* start with the marketing/campaigns/ prefix.
*/
public String getLocationScope() {
return this.locationScope;
}
/**
*
* The S3 path to the location that you are registering. The location scope can be the default S3 location
* s3://, the S3 path to a bucket s3://<bucket>, or the S3 path to a bucket and
* prefix s3://<bucket>/<prefix>. A prefix in S3 is a string of characters at the beginning
* of an object key name used to organize the objects that you store in your S3 buckets. For example, object key
* names that start with the engineering/ prefix or object key names that start with the
* marketing/campaigns/ prefix.
*
*
* @param locationScope
* The S3 path to the location that you are registering. The location scope can be the default S3 location
* s3://, the S3 path to a bucket s3://<bucket>, or the S3 path to a bucket
* and prefix s3://<bucket>/<prefix>. A prefix in S3 is a string of characters at
* the beginning of an object key name used to organize the objects that you store in your S3 buckets. For
* example, object key names that start with the engineering/ prefix or object key names that
* start with the marketing/campaigns/ prefix.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateAccessGrantsLocationRequest withLocationScope(String locationScope) {
setLocationScope(locationScope);
return this;
}
/**
*
* The Amazon Resource Name (ARN) of the IAM role for the registered location. S3 Access Grants assumes this role to
* manage access to the registered location.
*
*
* @param iAMRoleArn
* The Amazon Resource Name (ARN) of the IAM role for the registered location. S3 Access Grants assumes this
* role to manage access to the registered location.
*/
public void setIAMRoleArn(String iAMRoleArn) {
this.iAMRoleArn = iAMRoleArn;
}
/**
*
* The Amazon Resource Name (ARN) of the IAM role for the registered location. S3 Access Grants assumes this role to
* manage access to the registered location.
*
*
* @return The Amazon Resource Name (ARN) of the IAM role for the registered location. S3 Access Grants assumes this
* role to manage access to the registered location.
*/
public String getIAMRoleArn() {
return this.iAMRoleArn;
}
/**
*
* The Amazon Resource Name (ARN) of the IAM role for the registered location. S3 Access Grants assumes this role to
* manage access to the registered location.
*
*
* @param iAMRoleArn
* The Amazon Resource Name (ARN) of the IAM role for the registered location. S3 Access Grants assumes this
* role to manage access to the registered location.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateAccessGrantsLocationRequest withIAMRoleArn(String iAMRoleArn) {
setIAMRoleArn(iAMRoleArn);
return this;
}
/**
*
* The Amazon Web Services resource tags that you are adding to the S3 Access Grants location. Each tag is a label
* consisting of a user-defined key and value. Tags can help you manage, identify, organize, search for, and filter
* resources.
*
*
* @return The Amazon Web Services resource tags that you are adding to the S3 Access Grants location. Each tag is a
* label consisting of a user-defined key and value. Tags can help you manage, identify, organize, search
* for, and filter resources.
*/
public java.util.List getTags() {
return tags;
}
/**
*
* The Amazon Web Services resource tags that you are adding to the S3 Access Grants location. Each tag is a label
* consisting of a user-defined key and value. Tags can help you manage, identify, organize, search for, and filter
* resources.
*
*
* @param tags
* The Amazon Web Services resource tags that you are adding to the S3 Access Grants location. Each tag is a
* label consisting of a user-defined key and value. Tags can help you manage, identify, organize, search
* for, and filter resources.
*/
public void setTags(java.util.Collection tags) {
if (tags == null) {
this.tags = null;
return;
}
this.tags = new java.util.ArrayList(tags);
}
/**
*
* The Amazon Web Services resource tags that you are adding to the S3 Access Grants location. Each tag is a label
* consisting of a user-defined key and value. Tags can help you manage, identify, organize, search for, and filter
* resources.
*
*
* 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
* The Amazon Web Services resource tags that you are adding to the S3 Access Grants location. Each tag is a
* label consisting of a user-defined key and value. Tags can help you manage, identify, organize, search
* for, and filter resources.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateAccessGrantsLocationRequest withTags(Tag... tags) {
if (this.tags == null) {
setTags(new java.util.ArrayList(tags.length));
}
for (Tag ele : tags) {
this.tags.add(ele);
}
return this;
}
/**
*
* The Amazon Web Services resource tags that you are adding to the S3 Access Grants location. Each tag is a label
* consisting of a user-defined key and value. Tags can help you manage, identify, organize, search for, and filter
* resources.
*
*
* @param tags
* The Amazon Web Services resource tags that you are adding to the S3 Access Grants location. Each tag is a
* label consisting of a user-defined key and value. Tags can help you manage, identify, organize, search
* for, and filter resources.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateAccessGrantsLocationRequest 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 (getAccountId() != null)
sb.append("AccountId: ").append(getAccountId()).append(",");
if (getLocationScope() != null)
sb.append("LocationScope: ").append(getLocationScope()).append(",");
if (getIAMRoleArn() != null)
sb.append("IAMRoleArn: ").append(getIAMRoleArn()).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 CreateAccessGrantsLocationRequest == false)
return false;
CreateAccessGrantsLocationRequest other = (CreateAccessGrantsLocationRequest) obj;
if (other.getAccountId() == null ^ this.getAccountId() == null)
return false;
if (other.getAccountId() != null && other.getAccountId().equals(this.getAccountId()) == false)
return false;
if (other.getLocationScope() == null ^ this.getLocationScope() == null)
return false;
if (other.getLocationScope() != null && other.getLocationScope().equals(this.getLocationScope()) == false)
return false;
if (other.getIAMRoleArn() == null ^ this.getIAMRoleArn() == null)
return false;
if (other.getIAMRoleArn() != null && other.getIAMRoleArn().equals(this.getIAMRoleArn()) == 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 + ((getAccountId() == null) ? 0 : getAccountId().hashCode());
hashCode = prime * hashCode + ((getLocationScope() == null) ? 0 : getLocationScope().hashCode());
hashCode = prime * hashCode + ((getIAMRoleArn() == null) ? 0 : getIAMRoleArn().hashCode());
hashCode = prime * hashCode + ((getTags() == null) ? 0 : getTags().hashCode());
return hashCode;
}
@Override
public CreateAccessGrantsLocationRequest clone() {
return (CreateAccessGrantsLocationRequest) super.clone();
}
}