software.amazon.awssdk.services.s3control.model.GetAccessPointRequest Maven / Gradle / Ivy
Show all versions of s3control Show documentation
/*
* Copyright 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 software.amazon.awssdk.services.s3control.model;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.awscore.AwsRequestOverrideConfiguration;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class GetAccessPointRequest extends S3ControlRequest implements
ToCopyableBuilder {
private static final SdkField ACCOUNT_ID_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("AccountId")
.getter(getter(GetAccessPointRequest::accountId))
.setter(setter(Builder::accountId))
.traits(LocationTrait.builder().location(MarshallLocation.HEADER).locationName("x-amz-account-id")
.unmarshallLocationName("x-amz-account-id").build()).build();
private static final SdkField NAME_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("Name")
.getter(getter(GetAccessPointRequest::name))
.setter(setter(Builder::name))
.traits(LocationTrait.builder().location(MarshallLocation.PATH).locationName("name").unmarshallLocationName("name")
.build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(ACCOUNT_ID_FIELD, NAME_FIELD));
private final String accountId;
private final String name;
private GetAccessPointRequest(BuilderImpl builder) {
super(builder);
this.accountId = builder.accountId;
this.name = builder.name;
}
/**
*
* The account ID for the account that owns the specified access point.
*
*
* @return The account ID for the account that owns the specified access point.
*/
public final String accountId() {
return accountId;
}
/**
*
* The name of the access point whose configuration information you want to retrieve.
*
*
* For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the
* x-amz-outpost-id as well.
*
*
* For using this parameter with S3 on Outposts with the AWS SDK and CLI, you must specify the ARN of the access
* point accessed in the format
* arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/accesspoint/<my-accesspoint-name>
* . For example, to access the access point reports-ap through outpost my-outpost owned
* by account 123456789012 in Region us-west-2, use the URL encoding of
* arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/accesspoint/reports-ap. The value must
* be URL encoded.
*
*
* @return The name of the access point whose configuration information you want to retrieve.
*
* For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the
* x-amz-outpost-id as well.
*
*
* For using this parameter with S3 on Outposts with the AWS SDK and CLI, you must specify the ARN of the
* access point accessed in the format
* arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/accesspoint/<my-accesspoint-name>
* . For example, to access the access point reports-ap through outpost my-outpost
* owned by account 123456789012 in Region us-west-2, use the URL encoding of
* arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/accesspoint/reports-ap. The
* value must be URL encoded.
*/
public final String name() {
return name;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(accountId());
hashCode = 31 * hashCode + Objects.hashCode(name());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof GetAccessPointRequest)) {
return false;
}
GetAccessPointRequest other = (GetAccessPointRequest) obj;
return Objects.equals(accountId(), other.accountId()) && Objects.equals(name(), other.name());
}
/**
* 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.
*/
@Override
public final String toString() {
return ToString.builder("GetAccessPointRequest").add("AccountId", accountId()).add("Name", name()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "AccountId":
return Optional.ofNullable(clazz.cast(accountId()));
case "Name":
return Optional.ofNullable(clazz.cast(name()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((GetAccessPointRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends S3ControlRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The account ID for the account that owns the specified access point.
*
*
* @param accountId
* The account ID for the account that owns the specified access point.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder accountId(String accountId);
/**
*
* The name of the access point whose configuration information you want to retrieve.
*
*
* For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the
* x-amz-outpost-id as well.
*
*
* For using this parameter with S3 on Outposts with the AWS SDK and CLI, you must specify the ARN of the access
* point accessed in the format
* arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/accesspoint/<my-accesspoint-name>
* . For example, to access the access point reports-ap through outpost my-outpost
* owned by account 123456789012 in Region us-west-2, use the URL encoding of
* arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/accesspoint/reports-ap. The value
* must be URL encoded.
*
*
* @param name
* The name of the access point whose configuration information you want to retrieve.
*
* For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and
* the x-amz-outpost-id as well.
*
*
* For using this parameter with S3 on Outposts with the AWS SDK and CLI, you must specify the ARN of the
* access point accessed in the format
* arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/accesspoint/<my-accesspoint-name>
* . For example, to access the access point reports-ap through outpost
* my-outpost owned by account 123456789012 in Region us-west-2,
* use the URL encoding of
* arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/accesspoint/reports-ap. The
* value must be URL encoded.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder name(String name);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends S3ControlRequest.BuilderImpl implements Builder {
private String accountId;
private String name;
private BuilderImpl() {
}
private BuilderImpl(GetAccessPointRequest model) {
super(model);
accountId(model.accountId);
name(model.name);
}
public final String getAccountId() {
return accountId;
}
@Override
public final Builder accountId(String accountId) {
this.accountId = accountId;
return this;
}
public final void setAccountId(String accountId) {
this.accountId = accountId;
}
public final String getName() {
return name;
}
@Override
public final Builder name(String name) {
this.name = name;
return this;
}
public final void setName(String name) {
this.name = name;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public GetAccessPointRequest build() {
return new GetAccessPointRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}