Class MultiRegionAccessPointReport
- java.lang.Object
-
- software.amazon.awssdk.services.s3control.model.MultiRegionAccessPointReport
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<MultiRegionAccessPointReport.Builder,MultiRegionAccessPointReport>
@Generated("software.amazon.awssdk:codegen") public final class MultiRegionAccessPointReport extends Object implements SdkPojo, Serializable, ToCopyableBuilder<MultiRegionAccessPointReport.Builder,MultiRegionAccessPointReport>
A collection of statuses for a Multi-Region Access Point in the various Regions it supports.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceMultiRegionAccessPointReport.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Stringalias()The alias for the Multi-Region Access Point.static MultiRegionAccessPointReport.Builderbuilder()InstantcreatedAt()When the Multi-Region Access Point create request was received.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasRegions()For responses, this returns true if the service returned a value for the Regions property.Stringname()The name of the Multi-Region Access Point.PublicAccessBlockConfigurationpublicAccessBlock()Returns the value of the PublicAccessBlock property for this object.List<RegionReport>regions()A collection of the Regions and buckets associated with the Multi-Region Access Point.List<SdkField<?>>sdkFields()static Class<? extends MultiRegionAccessPointReport.Builder>serializableBuilderClass()MultiRegionAccessPointStatusstatus()The current status of the Multi-Region Access Point.StringstatusAsString()The current status of the Multi-Region Access Point.MultiRegionAccessPointReport.BuildertoBuilder()StringtoString()Returns a string representation of this object.-
Methods inherited from class java.lang.Object
clone, finalize, 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 the Multi-Region Access Point.
- Returns:
- The name of the Multi-Region Access Point.
-
alias
public final String alias()
The alias for the Multi-Region Access Point. For more information about the distinction between the name and the alias of an Multi-Region Access Point, see Managing Multi-Region Access Points.
- Returns:
- The alias for the Multi-Region Access Point. For more information about the distinction between the name and the alias of an Multi-Region Access Point, see Managing Multi-Region Access Points.
-
createdAt
public final Instant createdAt()
When the Multi-Region Access Point create request was received.
- Returns:
- When the Multi-Region Access Point create request was received.
-
publicAccessBlock
public final PublicAccessBlockConfiguration publicAccessBlock()
Returns the value of the PublicAccessBlock property for this object.- Returns:
- The value of the PublicAccessBlock property for this object.
-
status
public final MultiRegionAccessPointStatus status()
The current status of the Multi-Region Access Point.
CREATINGandDELETINGare temporary states that exist while the request is propagating and being completed. If a Multi-Region Access Point has a status ofPARTIALLY_CREATED, you can retry creation or send a request to delete the Multi-Region Access Point. If a Multi-Region Access Point has a status ofPARTIALLY_DELETED, you can retry a delete request to finish the deletion of the Multi-Region Access Point.If the service returns an enum value that is not available in the current SDK version,
statuswill returnMultiRegionAccessPointStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- The current status of the Multi-Region Access Point.
CREATINGandDELETINGare temporary states that exist while the request is propagating and being completed. If a Multi-Region Access Point has a status ofPARTIALLY_CREATED, you can retry creation or send a request to delete the Multi-Region Access Point. If a Multi-Region Access Point has a status ofPARTIALLY_DELETED, you can retry a delete request to finish the deletion of the Multi-Region Access Point. - See Also:
MultiRegionAccessPointStatus
-
statusAsString
public final String statusAsString()
The current status of the Multi-Region Access Point.
CREATINGandDELETINGare temporary states that exist while the request is propagating and being completed. If a Multi-Region Access Point has a status ofPARTIALLY_CREATED, you can retry creation or send a request to delete the Multi-Region Access Point. If a Multi-Region Access Point has a status ofPARTIALLY_DELETED, you can retry a delete request to finish the deletion of the Multi-Region Access Point.If the service returns an enum value that is not available in the current SDK version,
statuswill returnMultiRegionAccessPointStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- The current status of the Multi-Region Access Point.
CREATINGandDELETINGare temporary states that exist while the request is propagating and being completed. If a Multi-Region Access Point has a status ofPARTIALLY_CREATED, you can retry creation or send a request to delete the Multi-Region Access Point. If a Multi-Region Access Point has a status ofPARTIALLY_DELETED, you can retry a delete request to finish the deletion of the Multi-Region Access Point. - See Also:
MultiRegionAccessPointStatus
-
hasRegions
public final boolean hasRegions()
For responses, this returns true if the service returned a value for the Regions property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()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.
-
regions
public final List<RegionReport> regions()
A collection of the Regions and buckets associated with the Multi-Region 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
hasRegions()method.- Returns:
- A collection of the Regions and buckets associated with the Multi-Region Access Point.
-
toBuilder
public MultiRegionAccessPointReport.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<MultiRegionAccessPointReport.Builder,MultiRegionAccessPointReport>
-
builder
public static MultiRegionAccessPointReport.Builder builder()
-
serializableBuilderClass
public static Class<? extends MultiRegionAccessPointReport.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
-