software.amazon.awssdk.services.s3control.model

Class AccessPoint

java.lang.Object

software.amazon.awssdk.services.s3control.model.AccessPoint

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<AccessPoint.Builder,AccessPoint>

@Generated(value="software.amazon.awssdk:codegen")
public final class AccessPoint
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<AccessPoint.Builder,AccessPoint>

An access point used to access a bucket.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AccessPoint.Builder

Method Summary

Modifier and Type	Method and Description
String	accessPointArn() The ARN for the access point.
String	alias() The name or alias of the access point.
String	bucket() The name of the bucket associated with this access point.
static AccessPoint.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	name() The name of this access point.
NetworkOrigin	networkOrigin() Indicates whether this access point allows access from the public internet.
String	networkOriginAsString() Indicates whether this access point allows access from the public internet.
List<SdkField<?>>	sdkFields()
static Class<? extends AccessPoint.Builder>	serializableBuilderClass()
AccessPoint.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString() Returns a string representation of this object.
VpcConfiguration	vpcConfiguration() The virtual private cloud (VPC) configuration for this access point, if one exists.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

name

public final String name()

The name of this access point.

Returns:

The name of this access point.

networkOrigin

public final NetworkOrigin networkOrigin()

Indicates whether this access point allows access from the public internet. If VpcConfiguration is specified for this access point, then NetworkOrigin is VPC, and the access point doesn't allow access from the public internet. Otherwise, NetworkOrigin is Internet, and the access point allows access from the public internet, subject to the access point and bucket access policies.

If the service returns an enum value that is not available in the current SDK version, networkOrigin will return NetworkOrigin.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from networkOriginAsString().

Returns:

Indicates whether this access point allows access from the public internet. If VpcConfiguration is specified for this access point, then NetworkOrigin is VPC, and the access point doesn't allow access from the public internet. Otherwise, NetworkOrigin is Internet, and the access point allows access from the public internet, subject to the access point and bucket access policies.

See Also:

NetworkOrigin

networkOriginAsString

public final String networkOriginAsString()

Indicates whether this access point allows access from the public internet. If VpcConfiguration is specified for this access point, then NetworkOrigin is VPC, and the access point doesn't allow access from the public internet. Otherwise, NetworkOrigin is Internet, and the access point allows access from the public internet, subject to the access point and bucket access policies.

If the service returns an enum value that is not available in the current SDK version, networkOrigin will return NetworkOrigin.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from networkOriginAsString().

Returns:

Indicates whether this access point allows access from the public internet. If VpcConfiguration is specified for this access point, then NetworkOrigin is VPC, and the access point doesn't allow access from the public internet. Otherwise, NetworkOrigin is Internet, and the access point allows access from the public internet, subject to the access point and bucket access policies.

See Also:

NetworkOrigin

vpcConfiguration

public final VpcConfiguration vpcConfiguration()

The virtual private cloud (VPC) configuration for this access point, if one exists.

This element is empty if this access point is an Amazon S3 on Outposts access point that is used by other Amazon Web Services.

Returns:

The virtual private cloud (VPC) configuration for this access point, if one exists.

This element is empty if this access point is an Amazon S3 on Outposts access point that is used by other Amazon Web Services.

bucket

public final String bucket()

The name of the bucket associated with this access point.

Returns:

The name of the bucket associated with this access point.

accessPointArn

public final String accessPointArn()

The ARN for the access point.

Returns:

The ARN for the access point.

alias

public final String alias()

The name or alias of the access point.

Returns:

The name or alias of the access point.

toBuilder

public AccessPoint.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<AccessPoint.Builder,AccessPoint>

Returns:

a builder for type T

builder

public static AccessPoint.Builder builder()

serializableBuilderClass

public static Class<? extends AccessPoint.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.