Class GetAccessPointResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.s3control.model.S3ControlResponse
software.amazon.awssdk.services.s3control.model.GetAccessPointResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetAccessPointResponse.Builder,GetAccessPointResponse>
@Generated("software.amazon.awssdk:codegen") public final class GetAccessPointResponse extends S3ControlResponse implements ToCopyableBuilder<GetAccessPointResponse.Builder,GetAccessPointResponse>

  • Method Details

    • name

      public final String name()

      The name of the specified access point.

      Returns:
      The name of the specified access point.

    • bucket

      public final String bucket()

      The name of the bucket associated with the specified access point.

      Returns:
      The name of the bucket associated with the specified 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.

      This will always be true for an Amazon S3 on Outposts access point

      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.

      This will always be true for an Amazon S3 on Outposts access point

      See Also:

    • 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.

      This will always be true for an Amazon S3 on Outposts access point

      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.

      This will always be true for an Amazon S3 on Outposts access point

      See Also:

    • vpcConfiguration

      public final VpcConfiguration vpcConfiguration()

      Contains the virtual private cloud (VPC) configuration for the specified access point.

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

      Returns:
      Contains the virtual private cloud (VPC) configuration for the specified access point.

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

    • publicAccessBlockConfiguration

      public final PublicAccessBlockConfiguration publicAccessBlockConfiguration()
      Returns the value of the PublicAccessBlockConfiguration property for this object.
      Returns:
      The value of the PublicAccessBlockConfiguration property for this object.

    • creationDate

      public final Instant creationDate()

      The date and time when the specified access point was created.

      Returns:
      The date and time when the specified access point was created.

    • alias

      public final String alias()

      The name or alias of the access point.

      Returns:
      The name or alias of the access point.

    • accessPointArn

      public final String accessPointArn()

      The ARN of the access point.

      Returns:
      The ARN of the access point.

    • hasEndpoints

      public final boolean hasEndpoints()
      For responses, this returns true if the service returned a value for the Endpoints property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • endpoints

      public final Map<String,String> endpoints()

      The VPC endpoint for the access point.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasEndpoints() method.

      Returns:
      The VPC endpoint for the access point.

    • bucketAccountId

      public final String bucketAccountId()

      The Amazon Web Services account ID associated with the S3 bucket associated with this access point.

      Returns:
      The Amazon Web Services account ID associated with the S3 bucket associated with this access point.

    • dataSourceId

      public final String dataSourceId()

      The unique identifier for the data source of the access point.

      Returns:
      The unique identifier for the data source of the access point.

    • dataSourceType

      public final String dataSourceType()

      The type of the data source that the access point is attached to.

      Returns:
      The type of the data source that the access point is attached to.

    • toBuilder

      public GetAccessPointResponse.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<GetAccessPointResponse.Builder,GetAccessPointResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static GetAccessPointResponse.Builder builder()

    • serializableBuilderClass

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

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • 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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.